Artifact / Client / list_compliance_inquiries

list_compliance_inquiries¶

Artifact.Client.list_compliance_inquiries(**kwargs)¶

List available compliance inquiries.

Request Syntax

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

Parameters:

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

{
    '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.

Exceptions

Artifact.Client.exceptions.ResourceNotFoundException
Artifact.Client.exceptions.ThrottlingException
Artifact.Client.exceptions.AccessDeniedException
Artifact.Client.exceptions.InternalServerException
Artifact.Client.exceptions.ValidationException