Artifact / Client / create_compliance_inquiry

create_compliance_inquiry

Artifact.Client.create_compliance_inquiry(**kwargs)

Create a new compliance inquiry.

See also: AWS API Documentation

Request Syntax

response = 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'
    }
)
Parameters:

  • name (string) –

    [REQUIRED]

    Title of the inquiry.

  • inquiryContent (dict) –

    [REQUIRED]

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

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: query, fileContent.

    • 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.

  • clientToken (string) –

    Idempotency token for the request.

    This field is autopopulated if not provided.

  • supportMode (string) – Support mode for inquiry processing. Only supported for file upload mode. Defaults to AI_ONLY if not specified.

  • tags (dict) –

    Tags to associate with the compliance inquiry resource.

    • (string) –

      A tag key.

      • (string) –

        A tag value.

Return type:

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.

Exceptions