Artifact / Paginator / ListComplianceInquiryQueries

ListComplianceInquiryQueries

class Artifact.Paginator.ListComplianceInquiryQueries

paginator = client.get_paginator('list_compliance_inquiry_queries')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Artifact.Client.list_compliance_inquiry_queries().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    complianceInquiryId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• complianceInquiryId (string) –

  [REQUIRED]

  Unique resource ID for the compliance inquiry.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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) –

    A token to resume pagination.