compliance_inquiries

Creates, updates, deletes, gets or lists a compliance_inquiries resource.

Overview

Name	compliance_inquiries
Type	Resource
Id	aws.artifact.compliance_inquiries

Fields

The following fields are returned by SELECT queries:

list_compliance_inquiries

Name	Datatype	Description
id	string	Unique resource ID for the compliance inquiry. (pattern: <code>compliance-inquiry-[a-zA-Z0-9]{16}</code>)
name	string	Title of the inquiry.
arn	string	ARN of the compliance inquiry resource.
created_at	string (date-time)	Timestamp indicating when the resource was created.
input_source	string	Type of inquiry content (text or file). (TEXT, FILE)
status	string	Current processing status of the inquiry. (PROCESSING, HUMAN_REVIEW, COMPLETED, FAILED)
status_message	string	Status message providing additional context. (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.)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_compliance_inquiries	select	region	maxResults, nextToken	List available compliance inquiries.
create_compliance_inquiry	insert	region, name, inquiryContent		Create a new compliance inquiry.
put_compliance_inquiry_feedback	replace	region, complianceInquiryId, rating		Submits feedback on a compliance inquiry response.
export_compliance_inquiry	exec	region, complianceInquiryId		Export a compliance inquiry report.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
maxResults	integer	Maximum number of resources to return in the paginated response.
nextToken	string	Pagination token to request the next page of resources.

SELECT examples

list_compliance_inquiries

List available compliance inquiries.

SELECT
id,
name,
arn,
created_at,
input_source,
status,
status_message
FROM aws.artifact.compliance_inquiries
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_compliance_inquiry

Create a new compliance inquiry.

INSERT INTO aws.artifact.compliance_inquiries (
name,
inquiryContent,
clientToken,
supportMode,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ inquiryContent }}' /* required */,
'{{ clientToken }}',
'{{ supportMode }}',
'{{ tags }}',
'{{ region }}'
RETURNING
compliance_inquiry_summary,
tags
;

Manifest

# Description fields are for documentation purposes
- name: compliance_inquiries
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the compliance_inquiries resource.
  - name: name
    value: "{{ name }}"
  - name: inquiryContent
    description: |
      Content for creating a compliance inquiry - either a single query or file content.
    value:
      query: "{{ query }}"
      fileContent:
        fileSections:
          - "{{ fileSections }}"
        content: "{{ content }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: supportMode
    value: "{{ supportMode }}"
    valid_values: ['AI_ONLY', 'FULL_SUPPORT']
  - name: tags
    value: "{{ tags }}"
    description: |
      A map of tag keys to tag values.

REPLACE examples

put_compliance_inquiry_feedback

Submits feedback on a compliance inquiry response.

REPLACE aws.artifact.compliance_inquiries
SET 
complianceInquiryId = '{{ complianceInquiryId }}',
queryIdentifier = {{ queryIdentifier }},
rating = '{{ rating }}',
responseRevisionId = {{ responseRevisionId }},
reasonCodes = '{{ reasonCodes }}',
comment = '{{ comment }}',
clientToken = '{{ clientToken }}'
WHERE 
region = '{{ region }}' --required
AND complianceInquiryId = '{{ complianceInquiryId }}' --required
AND rating = '{{ rating }}' --required
RETURNING
submitted_at;

Lifecycle Methods

export_compliance_inquiry

Export a compliance inquiry report.

EXEC aws.artifact.compliance_inquiries.export_compliance_inquiry 
@region='{{ region }}' --required 
@@json=
'{
"complianceInquiryId": "{{ complianceInquiryId }}", 
"queryIdentifiers": "{{ queryIdentifiers }}", 
"includeCitations": {{ includeCitations }}
}'
;