AWS Artifact

2026/07/01 - AWS Artifact - 8 new api methods

Changes  Add support for Assurance Assistant APIs for managing compliance inquiries along with tagging features.

ListTagsForResource (new) Link ¶

List tags for a resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    resourceArn='string'
)
type resourceArn:

string

param resourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

rtype:

dict

returns:

Response Syntax

{
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • tags (dict) --

      Tags associated with the resource.

      • (string) --

        A tag key.

        • (string) --

          A tag value.

CreateComplianceInquiry (new) Link ¶

Create a new compliance inquiry.

See also: AWS API Documentation

Request Syntax

client.create_compliance_inquiry(
    name='string',
    inquiryContent={
        'query': 'string',
        'fileContent': {
            'fileSections': [
                'string',
            ],
            'content': b'bytes'
        }
    },
    clientToken='string',
    supportMode='AI_ONLY'|'FULL_SUPPORT',
    tags={
        'string': 'string'
    }
)
type name:

string

param name:

[REQUIRED]

Title of the inquiry.

type inquiryContent:

dict

param inquiryContent:

[REQUIRED]

Content for creating a compliance inquiry - either a single query or file content.

  • query (string) --

    Single text query for AI-generated answer.

  • fileContent (dict) --

    File content with multiple questions.

    • fileSections (list) --

      List of file sections/sheets to process.

      • (string) --

    • content (bytes) -- [REQUIRED]

      Binary content of the uploaded file.

type clientToken:

string

param clientToken:

Idempotency token for the request.

This field is autopopulated if not provided.

type supportMode:

string

param supportMode:

Support mode for inquiry processing. Only supported for file upload mode. Defaults to AI_ONLY if not specified.

type tags:

dict

param tags:

Tags to associate with the compliance inquiry resource.

  • (string) --

    A tag key.

    • (string) --

      A tag value.

rtype:

dict

returns:

Response Syntax

{
    'complianceInquirySummary': {
        'arn': 'string',
        'name': 'string',
        'id': 'string',
        'status': 'PROCESSING'|'HUMAN_REVIEW'|'COMPLETED'|'FAILED',
        'statusMessage': 'Compliance inquiry processing is complete.'|'Malware was detected on the file. Provide a new file and try again.'|'Compliance inquiry processing is in-progress.'|'An internal error occurred while processing the inquiry. Try again at a later time.'|'Human review is in progress.'|'Compliance inquiry processing is complete. One or more queries encountered errors during processing.',
        'inputSource': 'TEXT'|'FILE',
        'createdAt': datetime(2015, 1, 1)
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • complianceInquirySummary (dict) --

      Summary information about the created compliance inquiry.

      • arn (string) --

        ARN of the compliance inquiry resource.

      • name (string) --

        Title of the inquiry.

      • id (string) --

        Unique resource ID for the compliance inquiry.

      • status (string) --

        Current processing status of the inquiry.

      • statusMessage (string) --

        Status message providing additional context.

      • inputSource (string) --

        Type of inquiry content (text or file).

      • createdAt (datetime) --

        Timestamp indicating when the resource was created.

    • tags (dict) --

      Tags associated with the compliance inquiry resource.

      • (string) --

        A tag key.

        • (string) --

          A tag value.

ExportComplianceInquiry (new) Link ¶

Export a compliance inquiry report.

See also: AWS API Documentation

Request Syntax

client.export_compliance_inquiry(
    complianceInquiryId='string',
    queryIdentifiers=[
        123,
    ],
    includeCitations=True|False
)
type complianceInquiryId:

string

param complianceInquiryId:

[REQUIRED]

Unique resource ID for the compliance inquiry.

type queryIdentifiers:

list

param queryIdentifiers:

List of query identifiers to include in the export.

  • (integer) --

type includeCitations:

boolean

param includeCitations:

When true, include citations in the exported document.

rtype:

dict

returns:

Response Syntax

{
    'documentPresignedUrl': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • documentPresignedUrl (string) --

      Presigned S3 URL to access the exported compliance inquiry report.

    • tags (dict) --

      Tags associated with the compliance inquiry resource.

      • (string) --

        A tag key.

        • (string) --

          A tag value.

TagResource (new) Link ¶

Add tags to a resource.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)
type resourceArn:

string

param resourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

type tags:

dict

param tags:

[REQUIRED]

Tags to add to the resource.

  • (string) --

    A tag key.

    • (string) --

      A tag value.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

ListComplianceInquiryQueries (new) Link ¶

List queries within a compliance inquiry.

See also: AWS API Documentation

Request Syntax

client.list_compliance_inquiry_queries(
    complianceInquiryId='string',
    maxResults=123,
    nextToken='string'
)
type complianceInquiryId:

string

param complianceInquiryId:

[REQUIRED]

Unique resource ID for the compliance inquiry.

type maxResults:

integer

param maxResults:

Maximum number of resources to return in the paginated response.

type nextToken:

string

param nextToken:

Pagination token to request the next page of resources.

rtype:

dict

returns:

Response Syntax

{
    'queries': [
        {
            'queryIdentifier': 123,
            'query': 'string',
            'response': 'string',
            'reviewType': 'HUMAN'|'AI',
            'citations': [
                {
                    'sourceLabel': 'string',
                    'sourceContent': 'string',
                    'sourceLink': 'string'
                },
            ],
            'status': 'PROCESSING'|'COMPLETED'|'FAILED',
            'statusMessage': 'Query processing is complete.'|'Query processing is in-progress.'|'An internal error occurred while processing the query. Try again at a later time.'|'Query is pending human review.'|'Query contains restricted or unsupported content.',
            'createdAt': datetime(2015, 1, 1),
            'updatedResponseVersions': [
                {
                    'responseText': 'string',
                    'timestamp': datetime(2015, 1, 1)
                },
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • queries (list) --

      List of compliance query summaries.

      • (dict) --

        Summary information about a single query within a compliance inquiry.

        • queryIdentifier (integer) --

          Sequential identifier of the query within the inquiry.

        • query (string) --

          The actual query text.

        • response (string) --

          Generated response to the query.

        • reviewType (string) --

          Type of review for the response.

        • citations (list) --

          Supporting citations for the response.

          • (dict) --

            Citation information for AI-generated responses.

            • sourceLabel (string) --

              Label identifying the compliance source.

            • sourceContent (string) --

              Content text from the compliance source.

            • sourceLink (string) --

              Link to the compliance source.

        • status (string) --

          Current processing status of the query.

        • statusMessage (string) --

          Descriptive status message.

        • createdAt (datetime) --

          Timestamp when the query was created.

        • updatedResponseVersions (list) --

          Ordered list of response version history entries, oldest first.

          • (dict) --

            A versioned snapshot of a response edit.

            • responseText (string) --

              The response text for this version.

            • timestamp (datetime) --

              ISO 8601 timestamp of when this edit was made.

    • nextToken (string) --

      Pagination token to request the next page of resources.

UntagResource (new) Link ¶

Remove tags from a resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
type resourceArn:

string

param resourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

type tagKeys:

list

param tagKeys:

[REQUIRED]

Tag keys to remove from the resource.

  • (string) --

    A tag key.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

GetComplianceInquiryMetadata (new) Link ¶

Get the metadata for a single compliance inquiry.

See also: AWS API Documentation

Request Syntax

client.get_compliance_inquiry_metadata(
    complianceInquiryId='string'
)
type complianceInquiryId:

string

param complianceInquiryId:

[REQUIRED]

Unique resource ID for the compliance inquiry.

rtype:

dict

returns:

Response Syntax

{
    'complianceInquiryDetail': {
        'arn': 'string',
        'name': 'string',
        'id': 'string',
        'status': 'PROCESSING'|'HUMAN_REVIEW'|'COMPLETED'|'FAILED',
        'statusMessage': 'Compliance inquiry processing is complete.'|'Malware was detected on the file. Provide a new file and try again.'|'Compliance inquiry processing is in-progress.'|'An internal error occurred while processing the inquiry. Try again at a later time.'|'Human review is in progress.'|'Compliance inquiry processing is complete. One or more queries encountered errors during processing.',
        'inputSource': 'TEXT'|'FILE',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'supportMode': 'AI_ONLY'|'FULL_SUPPORT'
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • complianceInquiryDetail (dict) --

      Detailed information about the compliance inquiry.

      • arn (string) --

        ARN of the compliance inquiry resource.

      • name (string) --

        Title of the inquiry.

      • id (string) --

        Unique resource ID for the compliance inquiry.

      • status (string) --

        Current processing status of the inquiry.

      • statusMessage (string) --

        Status message providing additional context.

      • inputSource (string) --

        Type of inquiry content (text or file).

      • createdAt (datetime) --

        Timestamp indicating when the resource was created.

      • updatedAt (datetime) --

        Timestamp indicating when the resource was last modified.

      • supportMode (string) --

        Support mode for this inquiry. AI_ONLY provides AI-generated responses. FULL_SUPPORT includes human expert review.

    • tags (dict) --

      Tags associated with the compliance inquiry resource.

      • (string) --

        A tag key.

        • (string) --

          A tag value.

ListComplianceInquiries (new) Link ¶

List available compliance inquiries.

See also: AWS API Documentation

Request Syntax

client.list_compliance_inquiries(
    maxResults=123,
    nextToken='string'
)
type maxResults:

integer

param maxResults:

Maximum number of resources to return in the paginated response.

type nextToken:

string

param nextToken:

Pagination token to request the next page of resources.

rtype:

dict

returns:

Response Syntax

{
    'complianceInquiries': [
        {
            'arn': 'string',
            'name': 'string',
            'id': 'string',
            'status': 'PROCESSING'|'HUMAN_REVIEW'|'COMPLETED'|'FAILED',
            'statusMessage': 'Compliance inquiry processing is complete.'|'Malware was detected on the file. Provide a new file and try again.'|'Compliance inquiry processing is in-progress.'|'An internal error occurred while processing the inquiry. Try again at a later time.'|'Human review is in progress.'|'Compliance inquiry processing is complete. One or more queries encountered errors during processing.',
            'inputSource': 'TEXT'|'FILE',
            'createdAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • complianceInquiries (list) --

      List of compliance inquiry resources.

      • (dict) --

        Summary information about a compliance inquiry.

        • arn (string) --

          ARN of the compliance inquiry resource.

        • name (string) --

          Title of the inquiry.

        • id (string) --

          Unique resource ID for the compliance inquiry.

        • status (string) --

          Current processing status of the inquiry.

        • statusMessage (string) --

          Status message providing additional context.

        • inputSource (string) --

          Type of inquiry content (text or file).

        • createdAt (datetime) --

          Timestamp indicating when the resource was created.

    • nextToken (string) --

      Pagination token to request the next page of resources.