Artifact / Client / list_compliance_inquiry_queries

list_compliance_inquiry_queries

Artifact.Client.list_compliance_inquiry_queries(**kwargs)

List queries within a compliance inquiry.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• complianceInquiryId (string) –

  [REQUIRED]

  Unique resource ID for the compliance inquiry.

• maxResults (integer) – Maximum number of resources to return in the paginated response.

• nextToken (string) – Pagination token to request the next page of resources.

Return type:

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.

Exceptions

• Artifact.Client.exceptions.ResourceNotFoundException

• Artifact.Client.exceptions.ThrottlingException

• Artifact.Client.exceptions.AccessDeniedException

• Artifact.Client.exceptions.InternalServerException

• Artifact.Client.exceptions.ValidationException