Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ExportComplianceInquiry

Export a compliance inquiry report.

Request Syntax


POST /v1/compliance-inquiry/export HTTP/1.1
Content-type: application/json

{
   "complianceInquiryId": "string",
   "includeCitations": boolean,
   "queryIdentifiers": [ number ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

complianceInquiryId

Unique resource ID for the compliance inquiry.

Type: String

Pattern: compliance-inquiry-[a-zA-Z0-9]{16}

Required: Yes

includeCitations

When true, include citations in the exported document.

Type: Boolean

Required: No

queryIdentifiers

List of query identifiers to include in the export.

Type: Array of integers

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "documentPresignedUrl": "string",
   "tags": { 
      "string" : "string" 
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

documentPresignedUrl

Presigned S3 URL to access the exported compliance inquiry report.

Type: String

tags

Tags associated with the compliance inquiry resource.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: [a-zA-Z0-9\s_.:/=+\-@]*

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: [a-zA-Z0-9\s_.:/=+\-@]*

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

User does not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unknown server exception has occurred.

retryAfterSeconds: Number of seconds in which the caller can retry the request.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

resourceId: Identifier of the affected resource.
resourceType: Type of the affected resource.

HTTP Status Code: 404

ThrottlingException

Request was denied due to request throttling.

quotaCode: Code for the affected quota.
retryAfterSeconds: Number of seconds in which the caller can retry the request.
serviceCode: Code for the affected service.

HTTP Status Code: 429

ValidationException

Request fails to satisfy the constraints specified by an AWS service.

fieldList: The field that caused the error, if applicable.
reason: Reason the request failed validation.

HTTP Status Code: 400