{ "version":"2.0", "metadata":{ "apiVersion":"2018-05-10", "auth":["aws.auth#sigv4"], "endpointPrefix":"artifact", "protocol":"rest-json", "protocols":["rest-json"], "serviceFullName":"AWS Artifact", "serviceId":"Artifact", "signatureVersion":"v4", "signingName":"artifact", "uid":"artifact-2018-05-10" }, "operations":{ "CreateComplianceInquiry":{ "name":"CreateComplianceInquiry", "http":{ "method":"POST", "requestUri":"/v1/compliance-inquiry/create", "responseCode":202 }, "input":{"shape":"CreateComplianceInquiryRequest"}, "output":{"shape":"CreateComplianceInquiryResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Create a new compliance inquiry.

" }, "ExportComplianceInquiry":{ "name":"ExportComplianceInquiry", "http":{ "method":"POST", "requestUri":"/v1/compliance-inquiry/export", "responseCode":200 }, "input":{"shape":"ExportComplianceInquiryRequest"}, "output":{"shape":"ExportComplianceInquiryResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Export a compliance inquiry report.

" }, "GetAccountSettings":{ "name":"GetAccountSettings", "http":{ "method":"GET", "requestUri":"/v1/account-settings/get", "responseCode":200 }, "input":{"shape":"GetAccountSettingsRequest"}, "output":{"shape":"GetAccountSettingsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Get the account settings for Artifact.

", "readonly":true }, "GetComplianceInquiryMetadata":{ "name":"GetComplianceInquiryMetadata", "http":{ "method":"GET", "requestUri":"/v1/compliance-inquiry/getMetadata", "responseCode":200 }, "input":{"shape":"GetComplianceInquiryMetadataRequest"}, "output":{"shape":"GetComplianceInquiryMetadataResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Get the metadata for a single compliance inquiry.

", "readonly":true }, "GetReport":{ "name":"GetReport", "http":{ "method":"GET", "requestUri":"/v1/report/get", "responseCode":200 }, "input":{"shape":"GetReportRequest"}, "output":{"shape":"GetReportResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Get the content for a single report.

", "readonly":true }, "GetReportMetadata":{ "name":"GetReportMetadata", "http":{ "method":"GET", "requestUri":"/v1/report/getMetadata", "responseCode":200 }, "input":{"shape":"GetReportMetadataRequest"}, "output":{"shape":"GetReportMetadataResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Get the metadata for a single report.

", "readonly":true }, "GetTermForReport":{ "name":"GetTermForReport", "http":{ "method":"GET", "requestUri":"/v1/report/getTermForReport", "responseCode":200 }, "input":{"shape":"GetTermForReportRequest"}, "output":{"shape":"GetTermForReportResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Get the Term content associated with a single report.

", "readonly":true }, "ListComplianceInquiries":{ "name":"ListComplianceInquiries", "http":{ "method":"GET", "requestUri":"/v1/compliance-inquiry/list", "responseCode":200 }, "input":{"shape":"ListComplianceInquiriesRequest"}, "output":{"shape":"ListComplianceInquiriesResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

List available compliance inquiries.

", "readonly":true }, "ListComplianceInquiryQueries":{ "name":"ListComplianceInquiryQueries", "http":{ "method":"GET", "requestUri":"/v1/compliance-inquiry/listQueries", "responseCode":200 }, "input":{"shape":"ListComplianceInquiryQueriesRequest"}, "output":{"shape":"ListComplianceInquiryQueriesResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

List queries within a compliance inquiry.

", "readonly":true }, "ListCustomerAgreements":{ "name":"ListCustomerAgreements", "http":{ "method":"GET", "requestUri":"/v1/customer-agreement/list", "responseCode":200 }, "input":{"shape":"ListCustomerAgreementsRequest"}, "output":{"shape":"ListCustomerAgreementsResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

List active customer-agreements applicable to calling identity.

", "readonly":true }, "ListReportVersions":{ "name":"ListReportVersions", "http":{ "method":"GET", "requestUri":"/v1/report/listVersions", "responseCode":200 }, "input":{"shape":"ListReportVersionsRequest"}, "output":{"shape":"ListReportVersionsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

List available report versions for a given report.

", "readonly":true }, "ListReports":{ "name":"ListReports", "http":{ "method":"GET", "requestUri":"/v1/report/list", "responseCode":200 }, "input":{"shape":"ListReportsRequest"}, "output":{"shape":"ListReportsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

List available reports.

", "readonly":true }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

List tags for a resource.

", "readonly":true }, "PutAccountSettings":{ "name":"PutAccountSettings", "http":{ "method":"PUT", "requestUri":"/v1/account-settings/put", "responseCode":200 }, "input":{"shape":"PutAccountSettingsRequest"}, "output":{"shape":"PutAccountSettingsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Put the account settings for Artifact.

", "idempotent":true }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags/{resourceArn}", "responseCode":204 }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Add tags to a resource.

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{resourceArn}", "responseCode":204 }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], "documentation":"

Remove tags from a resource.

", "idempotent":true } }, "shapes":{ "AcceptanceType":{ "type":"string", "enum":[ "PASSTHROUGH", "EXPLICIT" ] }, "AccessDeniedException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

User does not have sufficient access to perform this action.

", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "AccountSettings":{ "type":"structure", "members":{ "notificationSubscriptionStatus":{ "shape":"NotificationSubscriptionStatus", "documentation":"

Notification subscription status of the customer.

" } }, "documentation":"

Account settings for the customer.

" }, "AgreementTerms":{ "type":"list", "member":{"shape":"LongStringAttribute"}, "max":10, "min":0 }, "AgreementType":{ "type":"string", "enum":[ "CUSTOM", "DEFAULT", "MODIFIED" ] }, "Blob":{"type":"blob"}, "Boolean":{ "type":"boolean", "box":true }, "Citation":{ "type":"structure", "members":{ "sourceLabel":{ "shape":"ShortStringAttribute", "documentation":"

Label identifying the compliance source.

" }, "sourceContent":{ "shape":"LongStringAttribute", "documentation":"

Content text from the compliance source.

" }, "sourceLink":{ "shape":"LongStringAttribute", "documentation":"

Link to the compliance source.

" } }, "documentation":"

Citation information for AI-generated responses.

" }, "CitationList":{ "type":"list", "member":{"shape":"Citation"} }, "ConflictException":{ "type":"structure", "required":[ "message", "resourceId", "resourceType" ], "members":{ "message":{"shape":"String"}, "resourceId":{ "shape":"String", "documentation":"

Identifier of the affected resource.

" }, "resourceType":{ "shape":"String", "documentation":"

Type of the affected resource.

" } }, "documentation":"

Request to create/modify content would result in a conflict.

", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "CreateComplianceInquiryRequest":{ "type":"structure", "required":[ "name", "inquiryContent" ], "members":{ "name":{ "shape":"String", "documentation":"

Title of the inquiry.

" }, "inquiryContent":{ "shape":"InquiryContent", "documentation":"

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

" }, "clientToken":{ "shape":"IdempotentClientToken", "documentation":"

Idempotency token for the request.

", "idempotencyToken":true }, "supportMode":{ "shape":"InquirySupportMode", "documentation":"

Support mode for inquiry processing. Only supported for file upload mode. Defaults to AI_ONLY if not specified.

" }, "tags":{ "shape":"TagsMap", "documentation":"

Tags to associate with the compliance inquiry resource.

" } } }, "CreateComplianceInquiryResponse":{ "type":"structure", "members":{ "complianceInquirySummary":{ "shape":"InquirySummary", "documentation":"

Summary information about the created compliance inquiry.

" }, "tags":{ "shape":"TagsMap", "documentation":"

Tags associated with the compliance inquiry resource.

" } } }, "CustomerAgreementIdAttribute":{ "type":"string", "pattern":"customer-agreement-[a-zA-Z0-9]{16}" }, "CustomerAgreementList":{ "type":"list", "member":{"shape":"CustomerAgreementSummary"} }, "CustomerAgreementState":{ "type":"string", "enum":[ "ACTIVE", "CUSTOMER_TERMINATED", "AWS_TERMINATED" ] }, "CustomerAgreementSummary":{ "type":"structure", "members":{ "name":{ "shape":"LongStringAttribute", "documentation":"

Name of the customer-agreement resource.

" }, "arn":{ "shape":"LongStringAttribute", "documentation":"

ARN of the customer-agreement resource.

" }, "id":{ "shape":"CustomerAgreementIdAttribute", "documentation":"

Identifier of the customer-agreement resource.

" }, "agreementArn":{ "shape":"LongStringAttribute", "documentation":"

ARN of the agreement resource the customer-agreement resource represents.

" }, "awsAccountId":{ "shape":"ShortStringAttribute", "documentation":"

AWS account Id that owns the resource.

" }, "organizationArn":{ "shape":"LongStringAttribute", "documentation":"

ARN of the organization that owns the resource.

" }, "effectiveStart":{ "shape":"TimestampAttribute", "documentation":"

Timestamp indicating when the agreement became effective.

" }, "effectiveEnd":{ "shape":"TimestampAttribute", "documentation":"

Timestamp indicating when the agreement was terminated.

" }, "state":{ "shape":"CustomerAgreementState", "documentation":"

State of the resource.

" }, "description":{ "shape":"LongStringAttribute", "documentation":"

Description of the resource.

" }, "acceptanceTerms":{ "shape":"AgreementTerms", "documentation":"

Terms required to accept the agreement resource.

" }, "terminateTerms":{ "shape":"AgreementTerms", "documentation":"

Terms required to terminate the customer-agreement resource.

" }, "type":{ "shape":"AgreementType", "documentation":"

Type of the customer-agreement resource.

" } }, "documentation":"

Summary for customer-agreement resource.

" }, "ExportComplianceInquiryRequest":{ "type":"structure", "required":["complianceInquiryId"], "members":{ "complianceInquiryId":{ "shape":"InquiryId", "documentation":"

Unique resource ID for the compliance inquiry.

" }, "queryIdentifiers":{ "shape":"QueryIdentifiersList", "documentation":"

List of query identifiers to include in the export.

" }, "includeCitations":{ "shape":"Boolean", "documentation":"

When true, include citations in the exported document.

" } } }, "ExportComplianceInquiryResponse":{ "type":"structure", "members":{ "documentPresignedUrl":{ "shape":"PresignedUrl", "documentation":"

Presigned S3 URL to access the exported compliance inquiry report.

" }, "tags":{ "shape":"TagsMap", "documentation":"

Tags associated with the compliance inquiry resource.

" } } }, "GetAccountSettingsRequest":{ "type":"structure", "members":{} }, "GetAccountSettingsResponse":{ "type":"structure", "members":{ "accountSettings":{"shape":"AccountSettings"} } }, "GetComplianceInquiryMetadataRequest":{ "type":"structure", "required":["complianceInquiryId"], "members":{ "complianceInquiryId":{ "shape":"InquiryId", "documentation":"

Unique resource ID for the compliance inquiry.

", "location":"querystring", "locationName":"complianceInquiryId" } } }, "GetComplianceInquiryMetadataResponse":{ "type":"structure", "members":{ "complianceInquiryDetail":{ "shape":"InquiryDetail", "documentation":"

Detailed information about the compliance inquiry.

" }, "tags":{ "shape":"TagsMap", "documentation":"

Tags associated with the compliance inquiry resource.

" } } }, "GetReportMetadataRequest":{ "type":"structure", "required":["reportId"], "members":{ "reportId":{ "shape":"ReportId", "documentation":"

Unique resource ID for the report resource.

", "location":"querystring", "locationName":"reportId" }, "reportVersion":{ "shape":"VersionAttribute", "documentation":"

Version for the report resource.

", "location":"querystring", "locationName":"reportVersion" } } }, "GetReportMetadataResponse":{ "type":"structure", "members":{ "reportDetails":{ "shape":"ReportDetail", "documentation":"

Report resource detail.

" } } }, "GetReportRequest":{ "type":"structure", "required":[ "reportId", "termToken" ], "members":{ "reportId":{ "shape":"ReportId", "documentation":"

Unique resource ID for the report resource.

", "location":"querystring", "locationName":"reportId" }, "reportVersion":{ "shape":"VersionAttribute", "documentation":"

Version for the report resource.

", "location":"querystring", "locationName":"reportVersion" }, "termToken":{ "shape":"ShortStringAttribute", "documentation":"

Unique download token provided by GetTermForReport API.

", "location":"querystring", "locationName":"termToken" } } }, "GetReportResponse":{ "type":"structure", "members":{ "documentPresignedUrl":{ "shape":"GetReportResponseDocumentPresignedUrlString", "documentation":"

Presigned S3 url to access the report content.

" } } }, "GetReportResponseDocumentPresignedUrlString":{ "type":"string", "max":10240, "min":1 }, "GetTermForReportRequest":{ "type":"structure", "required":["reportId"], "members":{ "reportId":{ "shape":"ReportId", "documentation":"

Unique resource ID for the report resource.

", "location":"querystring", "locationName":"reportId" }, "reportVersion":{ "shape":"VersionAttribute", "documentation":"

Version for the report resource.

", "location":"querystring", "locationName":"reportVersion" } } }, "GetTermForReportResponse":{ "type":"structure", "members":{ "documentPresignedUrl":{ "shape":"GetTermForReportResponseDocumentPresignedUrlString", "documentation":"

Presigned S3 url to access the term content.

" }, "termToken":{ "shape":"String", "documentation":"

Unique token representing this request event.

" } } }, "GetTermForReportResponseDocumentPresignedUrlString":{ "type":"string", "max":10240, "min":1 }, "IdempotentClientToken":{ "type":"string", "max":128, "min":1, "pattern":"[\\w\\-]+" }, "InputSource":{ "type":"string", "enum":[ "TEXT", "FILE" ] }, "InquiriesList":{ "type":"list", "member":{"shape":"InquirySummary"} }, "InquiryContent":{ "type":"structure", "members":{ "query":{ "shape":"LongStringAttribute", "documentation":"

Single text query for AI-generated answer.

" }, "fileContent":{ "shape":"InquiryFileContent", "documentation":"

File content with multiple questions.

" } }, "documentation":"

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

", "sensitive":true, "union":true }, "InquiryDetail":{ "type":"structure", "required":[ "arn", "name", "id", "status", "statusMessage", "inputSource", "createdAt" ], "members":{ "arn":{ "shape":"String", "documentation":"

ARN of the compliance inquiry resource.

" }, "name":{ "shape":"String", "documentation":"

Title of the inquiry.

" }, "id":{ "shape":"InquiryId", "documentation":"

Unique resource ID for the compliance inquiry.

" }, "status":{ "shape":"InquiryStatus", "documentation":"

Current processing status of the inquiry.

" }, "statusMessage":{ "shape":"InquiryStatusMessage", "documentation":"

Status message providing additional context.

" }, "inputSource":{ "shape":"InputSource", "documentation":"

Type of inquiry content (text or file).

" }, "createdAt":{ "shape":"TimestampAttribute", "documentation":"

Timestamp indicating when the resource was created.

" }, "updatedAt":{ "shape":"TimestampAttribute", "documentation":"

Timestamp indicating when the resource was last modified.

" }, "supportMode":{ "shape":"InquirySupportMode", "documentation":"

Support mode for this inquiry. AI_ONLY provides AI-generated responses. FULL_SUPPORT includes human expert review.

" } }, "documentation":"

Detailed information about a compliance inquiry.

" }, "InquiryFileContent":{ "type":"structure", "required":["content"], "members":{ "fileSections":{ "shape":"InquiryFileContentFileSectionsList", "documentation":"

List of file sections/sheets to process.

" }, "content":{ "shape":"Blob", "documentation":"

Binary content of the uploaded file.

" } }, "documentation":"

File content structure for compliance inquiry uploads.

" }, "InquiryFileContentFileSectionsList":{ "type":"list", "member":{"shape":"ShortStringAttribute"}, "max":30, "min":0 }, "InquiryId":{ "type":"string", "pattern":"compliance-inquiry-[a-zA-Z0-9]{16}" }, "InquiryStatus":{ "type":"string", "enum":[ "PROCESSING", "HUMAN_REVIEW", "COMPLETED", "FAILED" ] }, "InquiryStatusMessage":{ "type":"string", "enum":[ "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." ] }, "InquirySummary":{ "type":"structure", "required":[ "arn", "name", "id", "status", "statusMessage", "inputSource", "createdAt" ], "members":{ "arn":{ "shape":"String", "documentation":"

ARN of the compliance inquiry resource.

" }, "name":{ "shape":"String", "documentation":"

Title of the inquiry.

" }, "id":{ "shape":"InquiryId", "documentation":"

Unique resource ID for the compliance inquiry.

" }, "status":{ "shape":"InquiryStatus", "documentation":"

Current processing status of the inquiry.

" }, "statusMessage":{ "shape":"InquiryStatusMessage", "documentation":"

Status message providing additional context.

" }, "inputSource":{ "shape":"InputSource", "documentation":"

Type of inquiry content (text or file).

" }, "createdAt":{ "shape":"TimestampAttribute", "documentation":"

Timestamp indicating when the resource was created.

" } }, "documentation":"

Summary information about a compliance inquiry.

" }, "InquirySupportMode":{ "type":"string", "enum":[ "AI_ONLY", "FULL_SUPPORT" ] }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"}, "retryAfterSeconds":{ "shape":"Integer", "documentation":"

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

", "location":"header", "locationName":"Retry-After" } }, "documentation":"

An unknown server exception has occurred.

", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "retryable":{"throttling":false} }, "ListComplianceInquiriesRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"MaxResultsAttribute", "documentation":"

Maximum number of resources to return in the paginated response.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextTokenAttribute", "documentation":"

Pagination token to request the next page of resources.

", "location":"querystring", "locationName":"nextToken" } } }, "ListComplianceInquiriesResponse":{ "type":"structure", "members":{ "complianceInquiries":{ "shape":"InquiriesList", "documentation":"

List of compliance inquiry resources.

" }, "nextToken":{ "shape":"NextTokenAttribute", "documentation":"

Pagination token to request the next page of resources.

" } } }, "ListComplianceInquiryQueriesRequest":{ "type":"structure", "required":["complianceInquiryId"], "members":{ "complianceInquiryId":{ "shape":"InquiryId", "documentation":"

Unique resource ID for the compliance inquiry.

", "location":"querystring", "locationName":"complianceInquiryId" }, "maxResults":{ "shape":"MaxResultsAttribute", "documentation":"

Maximum number of resources to return in the paginated response.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextTokenAttribute", "documentation":"

Pagination token to request the next page of resources.

", "location":"querystring", "locationName":"nextToken" } } }, "ListComplianceInquiryQueriesResponse":{ "type":"structure", "members":{ "queries":{ "shape":"QueriesList", "documentation":"

List of compliance query summaries.

" }, "nextToken":{ "shape":"NextTokenAttribute", "documentation":"

Pagination token to request the next page of resources.

" } } }, "ListCustomerAgreementsRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"MaxResultsAttribute", "documentation":"

Maximum number of resources to return in the paginated response.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextTokenAttribute", "documentation":"

Pagination token to request the next page of resources.

", "location":"querystring", "locationName":"nextToken" } } }, "ListCustomerAgreementsResponse":{ "type":"structure", "required":["customerAgreements"], "members":{ "customerAgreements":{ "shape":"CustomerAgreementList", "documentation":"

List of customer-agreement resources.

" }, "nextToken":{ "shape":"NextTokenAttribute", "documentation":"

Pagination token to request the next page of resources.

" } } }, "ListReportVersionsRequest":{ "type":"structure", "required":["reportId"], "members":{ "reportId":{ "shape":"ReportId", "documentation":"

Unique resource ID for the report resource.

", "location":"querystring", "locationName":"reportId" }, "maxResults":{ "shape":"MaxResultsAttribute", "documentation":"

Maximum number of resources to return in the paginated response.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextTokenAttribute", "documentation":"

Pagination token to request the next page of resources.

", "location":"querystring", "locationName":"nextToken" } } }, "ListReportVersionsResponse":{ "type":"structure", "required":["reports"], "members":{ "reports":{ "shape":"ReportsList", "documentation":"

List of report resources.

" }, "nextToken":{ "shape":"NextTokenAttribute", "documentation":"

Pagination token to request the next page of resources.

" } } }, "ListReportsRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"MaxResultsAttribute", "documentation":"

Maximum number of resources to return in the paginated response.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextTokenAttribute", "documentation":"

Pagination token to request the next page of resources.

", "location":"querystring", "locationName":"nextToken" } } }, "ListReportsResponse":{ "type":"structure", "members":{ "reports":{ "shape":"ReportsList", "documentation":"

List of report resources.

" }, "nextToken":{ "shape":"NextTokenAttribute", "documentation":"

Pagination token to request the next page of resources.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"LongStringAttribute", "documentation":"

The Amazon Resource Name (ARN) of the resource.

", "location":"uri", "locationName":"resourceArn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{ "shape":"TagsMap", "documentation":"

Tags associated with the resource.

" } } }, "LongStringAttribute":{ "type":"string", "max":2048, "min":1, "pattern":"[^<>]*" }, "MaxResultsAttribute":{ "type":"integer", "box":true, "max":300, "min":1 }, "NextTokenAttribute":{ "type":"string", "max":2048, "min":1 }, "NotificationSubscriptionStatus":{ "type":"string", "enum":[ "SUBSCRIBED", "NOT_SUBSCRIBED" ] }, "PresignedUrl":{ "type":"string", "documentation":"

A pre-signed URL for accessing content.

", "sensitive":true }, "PublishedState":{ "type":"string", "enum":[ "PUBLISHED", "UNPUBLISHED" ] }, "PutAccountSettingsRequest":{ "type":"structure", "members":{ "notificationSubscriptionStatus":{ "shape":"NotificationSubscriptionStatus", "documentation":"

Desired notification subscription status.

" } } }, "PutAccountSettingsResponse":{ "type":"structure", "members":{ "accountSettings":{"shape":"AccountSettings"} } }, "QueriesList":{ "type":"list", "member":{"shape":"QuerySummary"} }, "QueryIdentifiersList":{ "type":"list", "member":{"shape":"Integer"} }, "QueryStatus":{ "type":"string", "enum":[ "PROCESSING", "COMPLETED", "FAILED" ] }, "QueryStatusMessage":{ "type":"string", "enum":[ "Query processing is complete.", "Query processing is in-progress.", "An internal error occurred while processing the query. Try again at a later time.", "Query is pending human review.", "Query contains restricted or unsupported content." ] }, "QuerySummary":{ "type":"structure", "required":[ "queryIdentifier", "query", "status", "statusMessage", "createdAt" ], "members":{ "queryIdentifier":{ "shape":"Integer", "documentation":"

Sequential identifier of the query within the inquiry.

" }, "query":{ "shape":"LongStringAttribute", "documentation":"

The actual query text.

" }, "response":{ "shape":"LongStringAttribute", "documentation":"

Generated response to the query.

" }, "reviewType":{ "shape":"ReviewType", "documentation":"

Type of review for the response.

" }, "citations":{ "shape":"CitationList", "documentation":"

Supporting citations for the response.

" }, "status":{ "shape":"QueryStatus", "documentation":"

Current processing status of the query.

" }, "statusMessage":{ "shape":"QueryStatusMessage", "documentation":"

Descriptive status message.

" }, "createdAt":{ "shape":"TimestampAttribute", "documentation":"

Timestamp when the query was created.

" }, "updatedResponseVersions":{ "shape":"ResponseVersionList", "documentation":"

Ordered list of response version history entries, oldest first.

" } }, "documentation":"

Summary information about a single query within a compliance inquiry.

" }, "ReportDetail":{ "type":"structure", "members":{ "id":{ "shape":"ReportId", "documentation":"

Unique resource ID for the report resource.

" }, "name":{ "shape":"ShortStringAttribute", "documentation":"

Name for the report resource.

" }, "description":{ "shape":"LongStringAttribute", "documentation":"

Description for the report resource.

" }, "periodStart":{ "shape":"TimestampAttribute", "documentation":"

Timestamp indicating the report resource effective start.

" }, "periodEnd":{ "shape":"TimestampAttribute", "documentation":"

Timestamp indicating the report resource effective end.

" }, "createdAt":{ "shape":"TimestampAttribute", "documentation":"

Timestamp indicating when the report resource was created.

" }, "lastModifiedAt":{ "shape":"TimestampAttribute", "documentation":"

Timestamp indicating when the report resource was last modified.

" }, "deletedAt":{ "shape":"TimestampAttribute", "documentation":"

Timestamp indicating when the report resource was deleted.

" }, "state":{ "shape":"PublishedState", "documentation":"

Current state of the report resource

" }, "arn":{ "shape":"LongStringAttribute", "documentation":"

ARN for the report resource.

" }, "series":{ "shape":"ShortStringAttribute", "documentation":"

Series for the report resource.

" }, "category":{ "shape":"ShortStringAttribute", "documentation":"

Category for the report resource.

" }, "companyName":{ "shape":"ShortStringAttribute", "documentation":"

Associated company name for the report resource.

" }, "productName":{ "shape":"ShortStringAttribute", "documentation":"

Associated product name for the report resource.

" }, "termArn":{ "shape":"LongStringAttribute", "documentation":"

Unique resource ARN for term resource.

" }, "version":{ "shape":"VersionAttribute", "documentation":"

Version for the report resource.

" }, "acceptanceType":{ "shape":"AcceptanceType", "documentation":"

Acceptance type for report.

" }, "sequenceNumber":{ "shape":"SequenceNumberAttribute", "documentation":"

Sequence number to enforce optimistic locking.

" }, "uploadState":{ "shape":"UploadState", "documentation":"

The current state of the document upload.

" }, "statusMessage":{ "shape":"StatusMessage", "documentation":"

The message associated with the current upload state.

" } }, "documentation":"

Full detail for report resource metadata.

" }, "ReportId":{ "type":"string", "pattern":"report-[a-zA-Z0-9]{16}" }, "ReportSummary":{ "type":"structure", "members":{ "id":{ "shape":"ReportId", "documentation":"

Unique resource ID for the report resource.

" }, "name":{ "shape":"ShortStringAttribute", "documentation":"

Name for the report resource.

" }, "state":{ "shape":"PublishedState", "documentation":"

Current state of the report resource.

" }, "arn":{ "shape":"LongStringAttribute", "documentation":"

ARN for the report resource.

" }, "version":{ "shape":"VersionAttribute", "documentation":"

Version for the report resource.

" }, "uploadState":{ "shape":"UploadState", "documentation":"

The current state of the document upload.

" }, "description":{ "shape":"LongStringAttribute", "documentation":"

Description for the report resource.

" }, "periodStart":{ "shape":"TimestampAttribute", "documentation":"

Timestamp indicating the report resource effective start.

" }, "periodEnd":{ "shape":"TimestampAttribute", "documentation":"

Timestamp indicating the report resource effective end.

" }, "series":{ "shape":"ShortStringAttribute", "documentation":"

Series for the report resource.

" }, "category":{ "shape":"ShortStringAttribute", "documentation":"

Category for the report resource.

" }, "companyName":{ "shape":"ShortStringAttribute", "documentation":"

Associated company name for the report resource.

" }, "productName":{ "shape":"ShortStringAttribute", "documentation":"

Associated product name for the report resource.

" }, "statusMessage":{ "shape":"StatusMessage", "documentation":"

The message associated with the current upload state.

" }, "acceptanceType":{ "shape":"AcceptanceType", "documentation":"

Acceptance type for report.

" } }, "documentation":"

Summary for report resource.

" }, "ReportsList":{ "type":"list", "member":{"shape":"ReportSummary"} }, "ResourceNotFoundException":{ "type":"structure", "required":[ "message", "resourceId", "resourceType" ], "members":{ "message":{"shape":"String"}, "resourceId":{ "shape":"String", "documentation":"

Identifier of the affected resource.

" }, "resourceType":{ "shape":"String", "documentation":"

Type of the affected resource.

" } }, "documentation":"

Request references a resource which does not exist.

", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "ResponseVersion":{ "type":"structure", "required":[ "responseText", "timestamp" ], "members":{ "responseText":{ "shape":"LongStringAttribute", "documentation":"

The response text for this version.

" }, "timestamp":{ "shape":"TimestampAttribute", "documentation":"

ISO 8601 timestamp of when this edit was made.

" } }, "documentation":"

A versioned snapshot of a response edit.

" }, "ResponseVersionList":{ "type":"list", "member":{"shape":"ResponseVersion"} }, "ReviewType":{ "type":"string", "enum":[ "HUMAN", "AI" ] }, "SequenceNumberAttribute":{ "type":"long", "box":true, "min":1 }, "ServiceQuotaExceededException":{ "type":"structure", "required":[ "message", "resourceId", "resourceType", "serviceCode", "quotaCode" ], "members":{ "message":{"shape":"String"}, "resourceId":{ "shape":"String", "documentation":"

Identifier of the affected resource.

" }, "resourceType":{ "shape":"String", "documentation":"

Type of the affected resource.

" }, "serviceCode":{ "shape":"String", "documentation":"

Code for the affected service.

" }, "quotaCode":{ "shape":"String", "documentation":"

Code for the affected quota.

" } }, "documentation":"

Request would cause a service quota to be exceeded.

", "error":{ "httpStatusCode":402, "senderFault":true }, "exception":true }, "ShortStringAttribute":{ "type":"string", "max":256, "min":1, "pattern":"[a-zA-Z0-9_\\-\\s]*" }, "StatusMessage":{"type":"string"}, "String":{"type":"string"}, "TagKey":{ "type":"string", "documentation":"

A tag key.

", "max":128, "min":1, "pattern":"[a-zA-Z0-9\\s_.:/=+\\-@]*" }, "TagKeys":{ "type":"list", "member":{"shape":"TagKey"}, "documentation":"

A list of tag keys.

", "max":50, "min":1 }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"LongStringAttribute", "documentation":"

The Amazon Resource Name (ARN) of the resource.

", "location":"uri", "locationName":"resourceArn" }, "tags":{ "shape":"TagsMap", "documentation":"

Tags to add to the resource.

" } } }, "TagResourceResponse":{ "type":"structure", "members":{} }, "TagValue":{ "type":"string", "documentation":"

A tag value.

", "max":256, "min":0, "pattern":"[a-zA-Z0-9\\s_.:/=+\\-@]*" }, "TagsMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "documentation":"

A map of tag keys to tag values.

", "max":50, "min":0 }, "ThrottlingException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"}, "serviceCode":{ "shape":"String", "documentation":"

Code for the affected service.

" }, "quotaCode":{ "shape":"String", "documentation":"

Code for the affected quota.

" }, "retryAfterSeconds":{ "shape":"Integer", "documentation":"

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

", "location":"header", "locationName":"Retry-After" } }, "documentation":"

Request was denied due to request throttling.

", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true, "retryable":{"throttling":true} }, "TimestampAttribute":{ "type":"timestamp", "timestampFormat":"iso8601" }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"LongStringAttribute", "documentation":"

The Amazon Resource Name (ARN) of the resource.

", "location":"uri", "locationName":"resourceArn" }, "tagKeys":{ "shape":"TagKeys", "documentation":"

Tag keys to remove from the resource.

", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceResponse":{ "type":"structure", "members":{} }, "UploadState":{ "type":"string", "enum":[ "PROCESSING", "COMPLETE", "FAILED", "FAULT" ] }, "ValidationException":{ "type":"structure", "required":[ "message", "reason" ], "members":{ "message":{"shape":"String"}, "reason":{ "shape":"ValidationExceptionReason", "documentation":"

Reason the request failed validation.

" }, "fieldList":{ "shape":"ValidationExceptionFieldList", "documentation":"

The field that caused the error, if applicable.

" } }, "documentation":"

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

", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "ValidationExceptionField":{ "type":"structure", "required":[ "name", "message" ], "members":{ "name":{ "shape":"String", "documentation":"

Name of validation exception.

" }, "message":{ "shape":"String", "documentation":"

Message describing why the field failed validation.

" } }, "documentation":"

Validation exception message and name.

" }, "ValidationExceptionFieldList":{ "type":"list", "member":{"shape":"ValidationExceptionField"} }, "ValidationExceptionReason":{ "type":"string", "enum":[ "unknownOperation", "cannotParse", "fieldValidationFailed", "invalidToken", "other" ] }, "VersionAttribute":{ "type":"long", "box":true, "min":1 } }, "documentation":"

This reference provides descriptions of the low-level AWS Artifact Service API.

" }