Artifact / Paginator / ListComplianceInquiries

ListComplianceInquiries

class Artifact.Paginator.ListComplianceInquiries
paginator = client.get_paginator('list_compliance_inquiries')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

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

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

      A token to resume pagination.