{ "smithy": "2.0", "shapes": { "com.amazonaws.artifact#AcceptanceType": { "type": "enum", "members": { "PASSTHROUGH": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Do not require explicit click-through acceptance\nof the Term associated with this Report", "smithy.api#enumValue": "PASSTHROUGH" } }, "EXPLICIT": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Require explicit click-through acceptance of the\nTerm associated with this Report.", "smithy.api#enumValue": "EXPLICIT" } } } }, "com.amazonaws.artifact#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

User does not have sufficient access to perform this action.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.artifact#AccountSettings": { "type": "structure", "members": { "notificationSubscriptionStatus": { "target": "com.amazonaws.artifact#NotificationSubscriptionStatus", "traits": { "smithy.api#documentation": "

Notification subscription status of the customer.

" } } }, "traits": { "smithy.api#documentation": "

Account settings for the customer.

" } }, "com.amazonaws.artifact#AccountSettingsResource": { "type": "resource", "operations": [ { "target": "com.amazonaws.artifact#GetAccountSettings" }, { "target": "com.amazonaws.artifact#PutAccountSettings" } ] }, "com.amazonaws.artifact#AgreementTerms": { "type": "list", "member": { "target": "com.amazonaws.artifact#LongStringAttribute" }, "traits": { "smithy.api#length": { "max": 10 } } }, "com.amazonaws.artifact#AgreementType": { "type": "enum", "members": { "CUSTOM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOM" } }, "DEFAULT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEFAULT" } }, "MODIFIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MODIFIED" } } } }, "com.amazonaws.artifact#Artifact": { "type": "service", "version": "2018-05-10", "operations": [ { "target": "com.amazonaws.artifact#ListTagsForResource" }, { "target": "com.amazonaws.artifact#TagResource" }, { "target": "com.amazonaws.artifact#UntagResource" } ], "resources": [ { "target": "com.amazonaws.artifact#AccountSettingsResource" }, { "target": "com.amazonaws.artifact#ComplianceInquiryResource" }, { "target": "com.amazonaws.artifact#CustomerAgreementResource" }, { "target": "com.amazonaws.artifact#ReportResource" }, { "target": "com.amazonaws.artifact#TermResource" } ], "traits": { "aws.api#service": { "sdkId": "Artifact", "arnNamespace": "artifact", "cloudTrailEventSource": "artifact.amazonaws.com" }, "aws.auth#sigv4": { "name": "artifact" }, "aws.endpoints#standardPartitionalEndpoints": { "endpointPatternType": "service_region_dnsSuffix" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "

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

", "smithy.api#title": "AWS Artifact", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://artifact-fips.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "{PartitionResult#implicitGlobalRegion}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://artifact-fips.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "{PartitionResult#implicitGlobalRegion}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://artifact.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "{PartitionResult#implicitGlobalRegion}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://artifact.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "{PartitionResult#implicitGlobalRegion}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://artifact-fips.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "{PartitionResult#implicitGlobalRegion}" } ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://artifact-fips.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "{PartitionResult#implicitGlobalRegion}" } ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://artifact.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "{PartitionResult#implicitGlobalRegion}" } ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://artifact.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "{PartitionResult#implicitGlobalRegion}" } ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Endpoint": "https://example.com", "UseFIPS": false } }, { "documentation": "For custom endpoint with fips enabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": true } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-east-1" } ] }, "url": "https://artifact-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-east-1" } ] }, "url": "https://artifact-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-east-1" } ] }, "url": "https://artifact.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-east-1" } ] }, "url": "https://artifact.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "cn-northwest-1" } ] }, "url": "https://artifact-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "cn-northwest-1" } ] }, "url": "https://artifact-fips.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "cn-northwest-1" } ] }, "url": "https://artifact.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "cn-northwest-1" } ] }, "url": "https://artifact.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "eusc-de-east-1" } ] }, "url": "https://artifact-fips.eusc-de-east-1.amazonaws.eu" } }, "params": { "Region": "eusc-de-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "eusc-de-east-1" } ] }, "url": "https://artifact.eusc-de-east-1.amazonaws.eu" } }, "params": { "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-iso-east-1" } ] }, "url": "https://artifact-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-iso-east-1" } ] }, "url": "https://artifact.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-isob-east-1" } ] }, "url": "https://artifact-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-isob-east-1" } ] }, "url": "https://artifact.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "eu-isoe-west-1" } ] }, "url": "https://artifact-fips.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { "Region": "eu-isoe-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "eu-isoe-west-1" } ] }, "url": "https://artifact.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { "Region": "eu-isoe-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-isof-south-1" } ] }, "url": "https://artifact-fips.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-isof-south-1" } ] }, "url": "https://artifact.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-gov-west-1" } ] }, "url": "https://artifact-fips.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-gov-west-1" } ] }, "url": "https://artifact-fips.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-gov-west-1" } ] }, "url": "https://artifact.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-gov-west-1" } ] }, "url": "https://artifact.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.artifact#Citation": { "type": "structure", "members": { "sourceLabel": { "target": "com.amazonaws.artifact#ShortStringAttribute", "traits": { "smithy.api#documentation": "

Label identifying the compliance source.

" } }, "sourceContent": { "target": "com.amazonaws.artifact#LongStringAttribute", "traits": { "smithy.api#documentation": "

Content text from the compliance source.

" } }, "sourceLink": { "target": "com.amazonaws.artifact#LongStringAttribute", "traits": { "smithy.api#documentation": "

Link to the compliance source.

" } } }, "traits": { "smithy.api#documentation": "

Citation information for AI-generated responses.

" } }, "com.amazonaws.artifact#CitationList": { "type": "list", "member": { "target": "com.amazonaws.artifact#Citation" } }, "com.amazonaws.artifact#ComplianceInquiryResource": { "type": "resource", "operations": [ { "target": "com.amazonaws.artifact#CreateComplianceInquiry" }, { "target": "com.amazonaws.artifact#ExportComplianceInquiry" }, { "target": "com.amazonaws.artifact#GetComplianceInquiryMetadata" }, { "target": "com.amazonaws.artifact#ListComplianceInquiries" }, { "target": "com.amazonaws.artifact#ListComplianceInquiryQueries" }, { "target": "com.amazonaws.artifact#PutComplianceInquiryFeedback" } ] }, "com.amazonaws.artifact#ConflictException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Identifier of the affected resource.

", "smithy.api#required": {} } }, "resourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Type of the affected resource.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.artifact#CreateComplianceInquiry": { "type": "operation", "input": { "target": "com.amazonaws.artifact#CreateComplianceInquiryRequest" }, "output": { "target": "com.amazonaws.artifact#CreateComplianceInquiryResponse" }, "errors": [ { "target": "com.amazonaws.artifact#AccessDeniedException" }, { "target": "com.amazonaws.artifact#ConflictException" }, { "target": "com.amazonaws.artifact#InternalServerException" }, { "target": "com.amazonaws.artifact#ThrottlingException" }, { "target": "com.amazonaws.artifact#ValidationException" } ], "traits": { "smithy.api#documentation": "

Create a new compliance inquiry.

", "smithy.api#examples": [ { "title": "Invoke CreateComplianceInquiry operation", "documentation": "Creates a compliance inquiry with a single text query.", "input": { "name": "My Compliance Inquiry", "inquiryContent": { "query": "Is my workload compliant with SOC 2?" }, "clientToken": "unique-client-token-1234", "supportMode": "AI_ONLY" }, "output": { "complianceInquirySummary": { "arn": "arn:aws:artifact:us-east-1:123456789012:compliance-inquiry/compliance-inquiry-abcdef0123456789", "name": "My Compliance Inquiry", "id": "compliance-inquiry-abcdef0123456789", "status": "PROCESSING", "statusMessage": "Compliance inquiry processing is in-progress.", "inputSource": "TEXT", "createdAt": "2026-03-24T12:00:00Z" } } } ], "smithy.api#http": { "code": 202, "method": "POST", "uri": "/v1/compliance-inquiry/create" } } }, "com.amazonaws.artifact#CreateComplianceInquiryRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.artifact#InquiryName", "traits": { "smithy.api#documentation": "

Title of the inquiry.

", "smithy.api#required": {} } }, "inquiryContent": { "target": "com.amazonaws.artifact#InquiryContent", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.artifact#IdempotentClientToken", "traits": { "smithy.api#documentation": "

Idempotency token for the request.

", "smithy.api#idempotencyToken": {} } }, "supportMode": { "target": "com.amazonaws.artifact#InquirySupportMode", "traits": { "smithy.api#documentation": "

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

" } }, "tags": { "target": "com.amazonaws.artifact#TagsMap", "traits": { "smithy.api#documentation": "

Tags to associate with the compliance inquiry resource.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.artifact#CreateComplianceInquiryResponse": { "type": "structure", "members": { "complianceInquirySummary": { "target": "com.amazonaws.artifact#InquirySummary", "traits": { "smithy.api#documentation": "

Summary information about the created compliance inquiry.

" } }, "tags": { "target": "com.amazonaws.artifact#TagsMap", "traits": { "smithy.api#documentation": "

Tags associated with the compliance inquiry resource.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.artifact#CustomerAgreementIdAttribute": { "type": "string", "traits": { "smithy.api#pattern": "^customer-agreement-[a-zA-Z0-9]{16}$" } }, "com.amazonaws.artifact#CustomerAgreementList": { "type": "list", "member": { "target": "com.amazonaws.artifact#CustomerAgreementSummary" } }, "com.amazonaws.artifact#CustomerAgreementResource": { "type": "resource", "operations": [ { "target": "com.amazonaws.artifact#ListCustomerAgreements" } ] }, "com.amazonaws.artifact#CustomerAgreementState": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "CUSTOMER_TERMINATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOMER_TERMINATED" } }, "AWS_TERMINATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_TERMINATED" } } } }, "com.amazonaws.artifact#CustomerAgreementSummary": { "type": "structure", "members": { "name": { "target": "com.amazonaws.artifact#LongStringAttribute", "traits": { "smithy.api#documentation": "

Name of the customer-agreement resource.

" } }, "arn": { "target": "com.amazonaws.artifact#LongStringAttribute", "traits": { "smithy.api#documentation": "

ARN of the customer-agreement resource.

" } }, "id": { "target": "com.amazonaws.artifact#CustomerAgreementIdAttribute", "traits": { "smithy.api#documentation": "

Identifier of the customer-agreement resource.

" } }, "agreementArn": { "target": "com.amazonaws.artifact#LongStringAttribute", "traits": { "smithy.api#documentation": "

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

" } }, "awsAccountId": { "target": "com.amazonaws.artifact#ShortStringAttribute", "traits": { "smithy.api#documentation": "

AWS account Id that owns the resource.

" } }, "organizationArn": { "target": "com.amazonaws.artifact#LongStringAttribute", "traits": { "smithy.api#documentation": "

ARN of the organization that owns the resource.

" } }, "effectiveStart": { "target": "com.amazonaws.artifact#TimestampAttribute", "traits": { "smithy.api#documentation": "

Timestamp indicating when the agreement became effective.

" } }, "effectiveEnd": { "target": "com.amazonaws.artifact#TimestampAttribute", "traits": { "smithy.api#documentation": "

Timestamp indicating when the agreement was terminated.

" } }, "state": { "target": "com.amazonaws.artifact#CustomerAgreementState", "traits": { "smithy.api#documentation": "

State of the resource.

" } }, "description": { "target": "com.amazonaws.artifact#LongStringAttribute", "traits": { "smithy.api#documentation": "

Description of the resource.

" } }, "acceptanceTerms": { "target": "com.amazonaws.artifact#AgreementTerms", "traits": { "smithy.api#documentation": "

Terms required to accept the agreement resource.

" } }, "terminateTerms": { "target": "com.amazonaws.artifact#AgreementTerms", "traits": { "smithy.api#documentation": "

Terms required to terminate the customer-agreement resource.

" } }, "type": { "target": "com.amazonaws.artifact#AgreementType", "traits": { "smithy.api#documentation": "

Type of the customer-agreement resource.

" } } }, "traits": { "smithy.api#documentation": "

Summary for customer-agreement resource.

" } }, "com.amazonaws.artifact#ExportComplianceInquiry": { "type": "operation", "input": { "target": "com.amazonaws.artifact#ExportComplianceInquiryRequest" }, "output": { "target": "com.amazonaws.artifact#ExportComplianceInquiryResponse" }, "errors": [ { "target": "com.amazonaws.artifact#AccessDeniedException" }, { "target": "com.amazonaws.artifact#InternalServerException" }, { "target": "com.amazonaws.artifact#ResourceNotFoundException" }, { "target": "com.amazonaws.artifact#ThrottlingException" }, { "target": "com.amazonaws.artifact#ValidationException" } ], "traits": { "smithy.api#documentation": "

Export a compliance inquiry report.

", "smithy.api#examples": [ { "title": "Invoke ExportComplianceInquiry operation", "documentation": "Exports a compliance inquiry report.", "input": { "complianceInquiryId": "compliance-inquiry-abcdef0123456789", "queryIdentifiers": [ 1, 2 ], "includeCitations": true }, "output": { "documentPresignedUrl": "https://s3.us-east-1.amazonaws.com/artifact-bucket/export.pdf?X-Amz-Signature=example" } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/v1/compliance-inquiry/export" } } }, "com.amazonaws.artifact#ExportComplianceInquiryRequest": { "type": "structure", "members": { "complianceInquiryId": { "target": "com.amazonaws.artifact#InquiryId", "traits": { "smithy.api#documentation": "

Unique resource ID for the compliance inquiry.

", "smithy.api#required": {} } }, "queryIdentifiers": { "target": "com.amazonaws.artifact#QueryIdentifiersList", "traits": { "smithy.api#documentation": "

List of query identifiers to include in the export.

" } }, "includeCitations": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

When true, include citations in the exported document.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.artifact#ExportComplianceInquiryResponse": { "type": "structure", "members": { "documentPresignedUrl": { "target": "com.amazonaws.artifact#PresignedUrl", "traits": { "smithy.api#documentation": "

Presigned S3 URL to access the exported compliance inquiry report.

" } }, "tags": { "target": "com.amazonaws.artifact#TagsMap", "traits": { "smithy.api#documentation": "

Tags associated with the compliance inquiry resource.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.artifact#FeedbackCommentAttribute": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1000 }, "smithy.api#pattern": "^[a-zA-Z0-9\\s.,;:!?'\\-()/@#&+=]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.artifact#FeedbackRating": { "type": "enum", "members": { "THUMBS_UP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "THUMBS_UP" } }, "THUMBS_DOWN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "THUMBS_DOWN" } } } }, "com.amazonaws.artifact#FeedbackReasonCode": { "type": "enum", "members": { "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OTHER" } }, "PARTIAL_RESPONSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PARTIAL_RESPONSE" } }, "IRRELEVANT_RESPONSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IRRELEVANT_RESPONSE" } } } }, "com.amazonaws.artifact#FeedbackReasonCodeList": { "type": "list", "member": { "target": "com.amazonaws.artifact#FeedbackReasonCode" } }, "com.amazonaws.artifact#FileSectionList": { "type": "list", "member": { "target": "com.amazonaws.artifact#ShortStringAttribute" } }, "com.amazonaws.artifact#GetAccountSettings": { "type": "operation", "input": { "target": "com.amazonaws.artifact#GetAccountSettingsRequest" }, "output": { "target": "com.amazonaws.artifact#GetAccountSettingsResponse" }, "errors": [ { "target": "com.amazonaws.artifact#AccessDeniedException" }, { "target": "com.amazonaws.artifact#ConflictException" }, { "target": "com.amazonaws.artifact#InternalServerException" }, { "target": "com.amazonaws.artifact#ResourceNotFoundException" }, { "target": "com.amazonaws.artifact#ServiceQuotaExceededException" }, { "target": "com.amazonaws.artifact#ThrottlingException" }, { "target": "com.amazonaws.artifact#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get the account settings for Artifact.

", "smithy.api#examples": [ { "title": "Invoke GetAccountSettings operation", "documentation": "Get the current account settings.", "input": {}, "output": { "accountSettings": { "notificationSubscriptionStatus": "SUBSCRIBED" } } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/v1/account-settings/get" }, "smithy.api#readonly": {} } }, "com.amazonaws.artifact#GetAccountSettingsRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.artifact#GetAccountSettingsResponse": { "type": "structure", "members": { "accountSettings": { "target": "com.amazonaws.artifact#AccountSettings" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.artifact#GetComplianceInquiryMetadata": { "type": "operation", "input": { "target": "com.amazonaws.artifact#GetComplianceInquiryMetadataRequest" }, "output": { "target": "com.amazonaws.artifact#GetComplianceInquiryMetadataResponse" }, "errors": [ { "target": "com.amazonaws.artifact#AccessDeniedException" }, { "target": "com.amazonaws.artifact#InternalServerException" }, { "target": "com.amazonaws.artifact#ResourceNotFoundException" }, { "target": "com.amazonaws.artifact#ThrottlingException" }, { "target": "com.amazonaws.artifact#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get the metadata for a single compliance inquiry.

", "smithy.api#examples": [ { "title": "Invoke GetComplianceInquiryMetadata operation", "documentation": "Gets metadata for a compliance inquiry.", "input": { "complianceInquiryId": "compliance-inquiry-abcdef0123456789" }, "output": { "complianceInquiryDetail": { "arn": "arn:aws:artifact:us-east-1:123456789012:compliance-inquiry/compliance-inquiry-abcdef0123456789", "name": "My Compliance Inquiry", "id": "compliance-inquiry-abcdef0123456789", "status": "COMPLETED", "statusMessage": "Compliance inquiry processing is complete.", "inputSource": "TEXT", "createdAt": "2026-03-24T12:00:00Z", "updatedAt": "2026-03-24T12:05:00Z", "supportMode": "AI_ONLY" } } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/v1/compliance-inquiry/getMetadata" }, "smithy.api#readonly": {} } }, "com.amazonaws.artifact#GetComplianceInquiryMetadataRequest": { "type": "structure", "members": { "complianceInquiryId": { "target": "com.amazonaws.artifact#InquiryId", "traits": { "smithy.api#documentation": "

Unique resource ID for the compliance inquiry.

", "smithy.api#httpQuery": "complianceInquiryId", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.artifact#GetComplianceInquiryMetadataResponse": { "type": "structure", "members": { "complianceInquiryDetail": { "target": "com.amazonaws.artifact#InquiryDetail", "traits": { "smithy.api#documentation": "

Detailed information about the compliance inquiry.

" } }, "tags": { "target": "com.amazonaws.artifact#TagsMap", "traits": { "smithy.api#documentation": "

Tags associated with the compliance inquiry resource.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.artifact#GetReport": { "type": "operation", "input": { "target": "com.amazonaws.artifact#GetReportRequest" }, "output": { "target": "com.amazonaws.artifact#GetReportResponse" }, "errors": [ { "target": "com.amazonaws.artifact#AccessDeniedException" }, { "target": "com.amazonaws.artifact#ConflictException" }, { "target": "com.amazonaws.artifact#InternalServerException" }, { "target": "com.amazonaws.artifact#ResourceNotFoundException" }, { "target": "com.amazonaws.artifact#ServiceQuotaExceededException" }, { "target": "com.amazonaws.artifact#ThrottlingException" }, { "target": "com.amazonaws.artifact#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get the content for a single report.

", "smithy.api#examples": [ { "title": "Invoke GetReport operation on the latest version of a specific report", "documentation": "The GetReport operation is invoked on a reportId and on a optional version.\n Callers must provide a termToken, which is provided by the GetTermForReport\n operation. If callers do not provide a version, it will default to the\n report's latest version", "input": { "reportId": "report-abcdef0123456789", "termToken": "term-token-abcdefghijklm01234567890" }, "output": { "documentPresignedUrl": "" } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/v1/report/get" }, "smithy.api#readonly": {} } }, "com.amazonaws.artifact#GetReportMetadata": { "type": "operation", "input": { "target": "com.amazonaws.artifact#GetReportMetadataRequest" }, "output": { "target": "com.amazonaws.artifact#GetReportMetadataResponse" }, "errors": [ { "target": "com.amazonaws.artifact#AccessDeniedException" }, { "target": "com.amazonaws.artifact#InternalServerException" }, { "target": "com.amazonaws.artifact#ResourceNotFoundException" }, { "target": "com.amazonaws.artifact#ServiceQuotaExceededException" }, { "target": "com.amazonaws.artifact#ThrottlingException" }, { "target": "com.amazonaws.artifact#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get the metadata for a single report.

", "smithy.api#examples": [ { "title": "Invoke GetReportMetadata operation on the latest version of a specific report", "documentation": "The GetReportMetadata operation is invoked on a reportId and on a optional version.\n If callers do not provide a version, it will default to the report's latest version.", "input": { "reportId": "report-bqhUJF3FrQZsMJpb" }, "output": { "reportDetails": { "arn": "arn:aws:artifact:us-east-1::report/report-abcdef0123456789:1", "category": "Artifact Category", "companyName": "AWS", "createdAt": "2022-05-27T23:17:00.343940Z", "description": "Description of report", "id": "report-abcdef0123456789", "name": "Name of report", "periodEnd": "2022-04-01T20:32:04Z", "periodStart": "2022-04-01T20:32:04Z", "productName": "Product of report", "series": "Artifact Series", "state": "PUBLISHED", "termArn": "arn:aws:artifact:us-east-1::term/term-abcdef0123456789:1", "version": 1 } } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/v1/report/getMetadata" }, "smithy.api#readonly": {} } }, "com.amazonaws.artifact#GetReportMetadataRequest": { "type": "structure", "members": { "reportId": { "target": "com.amazonaws.artifact#ReportId", "traits": { "smithy.api#documentation": "

Unique resource ID for the report resource.

", "smithy.api#httpQuery": "reportId", "smithy.api#required": {} } }, "reportVersion": { "target": "com.amazonaws.artifact#VersionAttribute", "traits": { "smithy.api#documentation": "

Version for the report resource.

", "smithy.api#httpQuery": "reportVersion" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.artifact#GetReportMetadataResponse": { "type": "structure", "members": { "reportDetails": { "target": "com.amazonaws.artifact#ReportDetail", "traits": { "smithy.api#documentation": "

Report resource detail.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.artifact#GetReportRequest": { "type": "structure", "members": { "reportId": { "target": "com.amazonaws.artifact#ReportId", "traits": { "smithy.api#documentation": "

Unique resource ID for the report resource.

", "smithy.api#httpQuery": "reportId", "smithy.api#required": {} } }, "reportVersion": { "target": "com.amazonaws.artifact#VersionAttribute", "traits": { "smithy.api#documentation": "

Version for the report resource.

", "smithy.api#httpQuery": "reportVersion" } }, "termToken": { "target": "com.amazonaws.artifact#ShortStringAttribute", "traits": { "smithy.api#documentation": "

Unique download token provided by GetTermForReport API.

", "smithy.api#httpQuery": "termToken", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.artifact#GetReportResponse": { "type": "structure", "members": { "documentPresignedUrl": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Presigned S3 url to access the report content.

", "smithy.api#length": { "min": 1, "max": 10240 } } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.artifact#GetTermForReport": { "type": "operation", "input": { "target": "com.amazonaws.artifact#GetTermForReportRequest" }, "output": { "target": "com.amazonaws.artifact#GetTermForReportResponse" }, "errors": [ { "target": "com.amazonaws.artifact#AccessDeniedException" }, { "target": "com.amazonaws.artifact#ConflictException" }, { "target": "com.amazonaws.artifact#InternalServerException" }, { "target": "com.amazonaws.artifact#ResourceNotFoundException" }, { "target": "com.amazonaws.artifact#ServiceQuotaExceededException" }, { "target": "com.amazonaws.artifact#ThrottlingException" }, { "target": "com.amazonaws.artifact#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get the Term content associated with a single report.

", "smithy.api#examples": [ { "title": "Invoke GetTermForReport operation on the latest version of a specific report", "documentation": "The GetTermForReport operation is invoked on a reportId and on a optional version.\n If callers do not provide a version, it will default to the report's latest version.", "input": { "reportId": "report-abcdef0123456789" }, "output": { "termToken": "term-token-abcdefghijklm01234567890", "documentPresignedUrl": "" } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/v1/report/getTermForReport" }, "smithy.api#readonly": {} } }, "com.amazonaws.artifact#GetTermForReportRequest": { "type": "structure", "members": { "reportId": { "target": "com.amazonaws.artifact#ReportId", "traits": { "smithy.api#documentation": "

Unique resource ID for the report resource.

", "smithy.api#httpQuery": "reportId", "smithy.api#required": {} } }, "reportVersion": { "target": "com.amazonaws.artifact#VersionAttribute", "traits": { "smithy.api#documentation": "

Version for the report resource.

", "smithy.api#httpQuery": "reportVersion" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.artifact#GetTermForReportResponse": { "type": "structure", "members": { "documentPresignedUrl": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Presigned S3 url to access the term content.

", "smithy.api#length": { "min": 1, "max": 10240 } } }, "termToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Unique token representing this request event.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.artifact#IdempotentClientToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\w\\-]+$" } }, "com.amazonaws.artifact#InputSource": { "type": "enum", "members": { "TEXT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TEXT" } }, "FILE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FILE" } } } }, "com.amazonaws.artifact#InquiriesList": { "type": "list", "member": { "target": "com.amazonaws.artifact#InquirySummary" } }, "com.amazonaws.artifact#InquiryContent": { "type": "union", "members": { "query": { "target": "com.amazonaws.artifact#LongStringAttribute", "traits": { "smithy.api#documentation": "

Single text query for AI-generated answer.

" } }, "fileContent": { "target": "com.amazonaws.artifact#InquiryFileContent", "traits": { "smithy.api#documentation": "

File content with multiple questions.

" } } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#sensitive": {} } }, "com.amazonaws.artifact#InquiryDetail": { "type": "structure", "members": { "arn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

ARN of the compliance inquiry resource.

", "smithy.api#required": {} } }, "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Title of the inquiry.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.artifact#InquiryId", "traits": { "smithy.api#documentation": "

Unique resource ID for the compliance inquiry.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.artifact#InquiryStatus", "traits": { "smithy.api#documentation": "

Current processing status of the inquiry.

", "smithy.api#required": {} } }, "statusMessage": { "target": "com.amazonaws.artifact#InquiryStatusMessage", "traits": { "smithy.api#documentation": "

Status message providing additional context.

", "smithy.api#required": {} } }, "inputSource": { "target": "com.amazonaws.artifact#InputSource", "traits": { "smithy.api#documentation": "

Type of inquiry content (text or file).

", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.artifact#TimestampAttribute", "traits": { "smithy.api#documentation": "

Timestamp indicating when the resource was created.

", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.artifact#TimestampAttribute", "traits": { "smithy.api#documentation": "

Timestamp indicating when the resource was last modified.

" } }, "supportMode": { "target": "com.amazonaws.artifact#InquirySupportMode", "traits": { "smithy.api#documentation": "

Support mode for this inquiry. AI_ONLY provides AI-generated responses.

" } } }, "traits": { "smithy.api#documentation": "

Detailed information about a compliance inquiry.

" } }, "com.amazonaws.artifact#InquiryFileContent": { "type": "structure", "members": { "fileSections": { "target": "com.amazonaws.artifact#FileSectionList", "traits": { "smithy.api#documentation": "

List of file sections/sheets to process.

", "smithy.api#length": { "min": 0, "max": 30 } } }, "content": { "target": "smithy.api#Blob", "traits": { "smithy.api#documentation": "

Binary content of the uploaded file.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

File content structure for compliance inquiry uploads.

" } }, "com.amazonaws.artifact#InquiryId": { "type": "string", "traits": { "smithy.api#pattern": "^compliance-inquiry-[a-zA-Z0-9]{16}$" } }, "com.amazonaws.artifact#InquiryName": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.artifact#InquiryStatus": { "type": "enum", "members": { "PROCESSING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROCESSING" } }, "HUMAN_REVIEW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HUMAN_REVIEW" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.artifact#InquiryStatusMessage": { "type": "enum", "members": { "SUCCESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Compliance inquiry processing is complete." } }, "MALWARE_DETECTED_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Malware was detected on the file. Provide a new file and try again." } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Compliance inquiry processing is in-progress." } }, "INTERNAL_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "An internal error occurred while processing the inquiry. Try again at a later time." } }, "HUMAN_REVIEW_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Human review is in progress." } }, "COMPLETED_WITH_ERRORS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Compliance inquiry processing is complete. One or more queries encountered errors during processing." } } } }, "com.amazonaws.artifact#InquirySummary": { "type": "structure", "members": { "arn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

ARN of the compliance inquiry resource.

", "smithy.api#required": {} } }, "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Title of the inquiry.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.artifact#InquiryId", "traits": { "smithy.api#documentation": "

Unique resource ID for the compliance inquiry.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.artifact#InquiryStatus", "traits": { "smithy.api#documentation": "

Current processing status of the inquiry.

", "smithy.api#required": {} } }, "statusMessage": { "target": "com.amazonaws.artifact#InquiryStatusMessage", "traits": { "smithy.api#documentation": "

Status message providing additional context.

", "smithy.api#required": {} } }, "inputSource": { "target": "com.amazonaws.artifact#InputSource", "traits": { "smithy.api#documentation": "

Type of inquiry content (text or file).

", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.artifact#TimestampAttribute", "traits": { "smithy.api#documentation": "

Timestamp indicating when the resource was created.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Summary information about a compliance inquiry.

" } }, "com.amazonaws.artifact#InquirySupportMode": { "type": "enum", "members": { "AI_ONLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AI_ONLY" } } } }, "com.amazonaws.artifact#InternalServerException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpHeader": "Retry-After" } } }, "traits": { "smithy.api#documentation": "

An unknown server exception has occurred.

", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} } }, "com.amazonaws.artifact#ListComplianceInquiries": { "type": "operation", "input": { "target": "com.amazonaws.artifact#ListComplianceInquiriesRequest" }, "output": { "target": "com.amazonaws.artifact#ListComplianceInquiriesResponse" }, "errors": [ { "target": "com.amazonaws.artifact#AccessDeniedException" }, { "target": "com.amazonaws.artifact#InternalServerException" }, { "target": "com.amazonaws.artifact#ResourceNotFoundException" }, { "target": "com.amazonaws.artifact#ThrottlingException" }, { "target": "com.amazonaws.artifact#ValidationException" } ], "traits": { "smithy.api#documentation": "

List available compliance inquiries.

", "smithy.api#examples": [ { "title": "Invoke ListComplianceInquiries operation", "documentation": "Lists all compliance inquiries.", "input": { "maxResults": 10 }, "output": { "complianceInquiries": [ { "arn": "arn:aws:artifact:us-east-1:123456789012:compliance-inquiry/compliance-inquiry-abcdef0123456789", "name": "My Compliance Inquiry", "id": "compliance-inquiry-abcdef0123456789", "status": "COMPLETED", "statusMessage": "Compliance inquiry processing is complete.", "inputSource": "TEXT", "createdAt": "2026-03-24T12:00:00Z" } ] } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/v1/compliance-inquiry/list" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "complianceInquiries" }, "smithy.api#readonly": {} } }, "com.amazonaws.artifact#ListComplianceInquiriesRequest": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.artifact#MaxResultsAttribute", "traits": { "smithy.api#documentation": "

Maximum number of resources to return in the paginated response.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.artifact#NextTokenAttribute", "traits": { "smithy.api#documentation": "

Pagination token to request the next page of resources.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.artifact#ListComplianceInquiriesResponse": { "type": "structure", "members": { "complianceInquiries": { "target": "com.amazonaws.artifact#InquiriesList", "traits": { "smithy.api#documentation": "

List of compliance inquiry resources.

" } }, "nextToken": { "target": "com.amazonaws.artifact#NextTokenAttribute", "traits": { "smithy.api#documentation": "

Pagination token to request the next page of resources.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.artifact#ListComplianceInquiryQueries": { "type": "operation", "input": { "target": "com.amazonaws.artifact#ListComplianceInquiryQueriesRequest" }, "output": { "target": "com.amazonaws.artifact#ListComplianceInquiryQueriesResponse" }, "errors": [ { "target": "com.amazonaws.artifact#AccessDeniedException" }, { "target": "com.amazonaws.artifact#InternalServerException" }, { "target": "com.amazonaws.artifact#ResourceNotFoundException" }, { "target": "com.amazonaws.artifact#ThrottlingException" }, { "target": "com.amazonaws.artifact#ValidationException" } ], "traits": { "smithy.api#documentation": "

List queries within a compliance inquiry.

", "smithy.api#examples": [ { "title": "Invoke ListComplianceInquiryQueries operation", "documentation": "Lists queries within a compliance inquiry.", "input": { "complianceInquiryId": "compliance-inquiry-abcdef0123456789", "maxResults": 10 }, "output": { "queries": [ { "queryIdentifier": 1, "query": "Is my workload compliant with SOC 2?", "response": "Based on the available compliance documentation...", "reviewType": "AI", "citations": [ { "sourceLabel": "SOC 2 Type II Report", "sourceContent": "Relevant compliance content...", "sourceLink": "https://example.com/soc2" } ], "status": "COMPLETED", "statusMessage": "Query processing is complete.", "createdAt": "2026-03-24T12:00:00Z" } ] } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/v1/compliance-inquiry/listQueries" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "queries" }, "smithy.api#readonly": {} } }, "com.amazonaws.artifact#ListComplianceInquiryQueriesRequest": { "type": "structure", "members": { "complianceInquiryId": { "target": "com.amazonaws.artifact#InquiryId", "traits": { "smithy.api#documentation": "

Unique resource ID for the compliance inquiry.

", "smithy.api#httpQuery": "complianceInquiryId", "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.artifact#MaxResultsAttribute", "traits": { "smithy.api#documentation": "

Maximum number of resources to return in the paginated response.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.artifact#NextTokenAttribute", "traits": { "smithy.api#documentation": "

Pagination token to request the next page of resources.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.artifact#ListComplianceInquiryQueriesResponse": { "type": "structure", "members": { "queries": { "target": "com.amazonaws.artifact#QueriesList", "traits": { "smithy.api#documentation": "

List of compliance query summaries.

" } }, "nextToken": { "target": "com.amazonaws.artifact#NextTokenAttribute", "traits": { "smithy.api#documentation": "

Pagination token to request the next page of resources.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.artifact#ListCustomerAgreements": { "type": "operation", "input": { "target": "com.amazonaws.artifact#ListCustomerAgreementsRequest" }, "output": { "target": "com.amazonaws.artifact#ListCustomerAgreementsResponse" }, "errors": [ { "target": "com.amazonaws.artifact#AccessDeniedException" }, { "target": "com.amazonaws.artifact#InternalServerException" }, { "target": "com.amazonaws.artifact#ThrottlingException" }, { "target": "com.amazonaws.artifact#ValidationException" } ], "traits": { "smithy.api#documentation": "

List active customer-agreements applicable to calling identity.

", "smithy.api#examples": [ { "title": "Invoke ListCustomerAgreements operation", "documentation": "The ListCustomerAgreements operation returns a collection of customer-agreement resources in the ACTIVE state for the calling credential.", "input": {}, "output": { "customerAgreements": [ { "name": "Name of agreement", "arn": "arn:aws:artifact::111111111111:customer-agreement/customer-agreement-abcdef0123456789", "id": "customer-agreement-abcdef0123456789", "agreementArn": "arn:aws:artifact:::agreement/agreement-abcdef0123456789", "awsAccountId": "111111111111", "description": "Description of agreement", "effectiveStart": "2022-04-01T20:32:04Z", "type": "DEFAULT", "state": "ACTIVE", "acceptanceTerms": [ "terms acknowledged when agreement was accepted" ], "terminateTerms": [ "terms that must be acknowledged to terminate this agreement" ] } ], "nextToken": "gPFEGk7CF4wS901w7ppYclt7gPFEGk7CF4wS901w7ppYclt7gPFEGk7CF4wS901w7ppYclt7" } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/v1/customer-agreement/list" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "customerAgreements" }, "smithy.api#readonly": {} } }, "com.amazonaws.artifact#ListCustomerAgreementsRequest": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.artifact#MaxResultsAttribute", "traits": { "smithy.api#documentation": "

Maximum number of resources to return in the paginated response.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.artifact#NextTokenAttribute", "traits": { "smithy.api#documentation": "

Pagination token to request the next page of resources.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.artifact#ListCustomerAgreementsResponse": { "type": "structure", "members": { "customerAgreements": { "target": "com.amazonaws.artifact#CustomerAgreementList", "traits": { "smithy.api#documentation": "

List of customer-agreement resources.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.artifact#NextTokenAttribute", "traits": { "smithy.api#documentation": "

Pagination token to request the next page of resources.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.artifact#ListReportVersions": { "type": "operation", "input": { "target": "com.amazonaws.artifact#ListReportVersionsRequest" }, "output": { "target": "com.amazonaws.artifact#ListReportVersionsResponse" }, "errors": [ { "target": "com.amazonaws.artifact#AccessDeniedException" }, { "target": "com.amazonaws.artifact#InternalServerException" }, { "target": "com.amazonaws.artifact#ResourceNotFoundException" }, { "target": "com.amazonaws.artifact#ServiceQuotaExceededException" }, { "target": "com.amazonaws.artifact#ThrottlingException" }, { "target": "com.amazonaws.artifact#ValidationException" } ], "traits": { "smithy.api#documentation": "

List available report versions for a given report.

", "smithy.api#examples": [ { "title": "Invoke ListReportVersions operation", "documentation": "The ListReportVersions operation returns a collection of report versions\n for a given resource.", "input": { "reportId": "report-abcdef0123456789" }, "output": { "reports": [ { "arn": "arn:aws:artifact:us-east-1::report:report-abcdef0123456789:1", "category": "category", "companyName": "companyName", "description": "description", "id": "report-abcdef0123456789", "name": "name", "periodEnd": "2022-04-01T20:32:04Z", "periodStart": "2022-04-01T20:32:04Z", "productName": "productName", "series": "series", "state": "PUBLISHED", "version": 1 } ], "nextToken": "gPFEGk7CF4wS901w7ppYclt7gPFEGk7CF4wS901w7ppYclt7gPFEGk7CF4wS901w7ppYclt7" } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/v1/report/listVersions" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "reports" }, "smithy.api#readonly": {} } }, "com.amazonaws.artifact#ListReportVersionsRequest": { "type": "structure", "members": { "reportId": { "target": "com.amazonaws.artifact#ReportId", "traits": { "smithy.api#documentation": "

Unique resource ID for the report resource.

", "smithy.api#httpQuery": "reportId", "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.artifact#MaxResultsAttribute", "traits": { "smithy.api#documentation": "

Maximum number of resources to return in the paginated response.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.artifact#NextTokenAttribute", "traits": { "smithy.api#documentation": "

Pagination token to request the next page of resources.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.artifact#ListReportVersionsResponse": { "type": "structure", "members": { "reports": { "target": "com.amazonaws.artifact#ReportsList", "traits": { "smithy.api#documentation": "

List of report resources.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.artifact#NextTokenAttribute", "traits": { "smithy.api#documentation": "

Pagination token to request the next page of resources.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.artifact#ListReports": { "type": "operation", "input": { "target": "com.amazonaws.artifact#ListReportsRequest" }, "output": { "target": "com.amazonaws.artifact#ListReportsResponse" }, "errors": [ { "target": "com.amazonaws.artifact#AccessDeniedException" }, { "target": "com.amazonaws.artifact#InternalServerException" }, { "target": "com.amazonaws.artifact#ResourceNotFoundException" }, { "target": "com.amazonaws.artifact#ServiceQuotaExceededException" }, { "target": "com.amazonaws.artifact#ThrottlingException" }, { "target": "com.amazonaws.artifact#ValidationException" } ], "traits": { "smithy.api#documentation": "

List available reports.

", "smithy.api#examples": [ { "title": "Invoke ListReports operation", "documentation": "The ListReports operation returns a collection of report resources.", "input": {}, "output": { "reports": [ { "arn": "arn:aws:artifact:us-east-1::report/report-abcdef0123456789", "category": "Artifact Category", "companyName": "AWS", "description": "Description of report", "id": "report-abcdef0123456789", "name": "Name of report", "periodEnd": "2022-04-01T20:32:04Z", "periodStart": "2022-04-01T20:32:04Z", "productName": "Product of report", "series": "Artifact Series", "state": "PUBLISHED", "version": 1 } ], "nextToken": "gPFEGk7CF4wS901w7ppYclt7gPFEGk7CF4wS901w7ppYclt7gPFEGk7CF4wS901w7ppYclt7" } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/v1/report/list" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "reports" }, "smithy.api#readonly": {} } }, "com.amazonaws.artifact#ListReportsRequest": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.artifact#MaxResultsAttribute", "traits": { "smithy.api#documentation": "

Maximum number of resources to return in the paginated response.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.artifact#NextTokenAttribute", "traits": { "smithy.api#documentation": "

Pagination token to request the next page of resources.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.artifact#ListReportsResponse": { "type": "structure", "members": { "reports": { "target": "com.amazonaws.artifact#ReportsList", "traits": { "smithy.api#documentation": "

List of report resources.

" } }, "nextToken": { "target": "com.amazonaws.artifact#NextTokenAttribute", "traits": { "smithy.api#documentation": "

Pagination token to request the next page of resources.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.artifact#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.artifact#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.artifact#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.artifact#AccessDeniedException" }, { "target": "com.amazonaws.artifact#InternalServerException" }, { "target": "com.amazonaws.artifact#ResourceNotFoundException" }, { "target": "com.amazonaws.artifact#ThrottlingException" }, { "target": "com.amazonaws.artifact#ValidationException" } ], "traits": { "smithy.api#documentation": "

List tags for a resource.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/tags/{resourceArn}" }, "smithy.api#readonly": {} } }, "com.amazonaws.artifact#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.artifact#LongStringAttribute", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.artifact#ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.artifact#TagsMap", "traits": { "smithy.api#documentation": "

Tags associated with the resource.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.artifact#LongStringAttribute": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^[^<>]*$" } }, "com.amazonaws.artifact#MaxResultsAttribute": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 300 } } }, "com.amazonaws.artifact#NextTokenAttribute": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.artifact#NotificationSubscriptionStatus": { "type": "enum", "members": { "SUBSCRIBED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUBSCRIBED" } }, "NOT_SUBSCRIBED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_SUBSCRIBED" } } } }, "com.amazonaws.artifact#PresignedUrl": { "type": "string", "traits": { "smithy.api#documentation": "

A pre-signed URL for accessing content.

", "smithy.api#sensitive": {} } }, "com.amazonaws.artifact#PublishedState": { "type": "enum", "members": { "PUBLISHED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PUBLISHED" } }, "UNPUBLISHED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNPUBLISHED" } } } }, "com.amazonaws.artifact#PutAccountSettings": { "type": "operation", "input": { "target": "com.amazonaws.artifact#PutAccountSettingsRequest" }, "output": { "target": "com.amazonaws.artifact#PutAccountSettingsResponse" }, "errors": [ { "target": "com.amazonaws.artifact#AccessDeniedException" }, { "target": "com.amazonaws.artifact#ConflictException" }, { "target": "com.amazonaws.artifact#InternalServerException" }, { "target": "com.amazonaws.artifact#ResourceNotFoundException" }, { "target": "com.amazonaws.artifact#ServiceQuotaExceededException" }, { "target": "com.amazonaws.artifact#ThrottlingException" }, { "target": "com.amazonaws.artifact#ValidationException" } ], "traits": { "smithy.api#documentation": "

Put the account settings for Artifact.

", "smithy.api#examples": [ { "title": "Invoke PutAccountSettings operation", "documentation": "Set the account settings.", "input": { "notificationSubscriptionStatus": "SUBSCRIBED" }, "output": { "accountSettings": { "notificationSubscriptionStatus": "SUBSCRIBED" } } } ], "smithy.api#http": { "code": 200, "method": "PUT", "uri": "/v1/account-settings/put" }, "smithy.api#idempotent": {} } }, "com.amazonaws.artifact#PutAccountSettingsRequest": { "type": "structure", "members": { "notificationSubscriptionStatus": { "target": "com.amazonaws.artifact#NotificationSubscriptionStatus", "traits": { "smithy.api#documentation": "

Desired notification subscription status.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.artifact#PutAccountSettingsResponse": { "type": "structure", "members": { "accountSettings": { "target": "com.amazonaws.artifact#AccountSettings" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.artifact#PutComplianceInquiryFeedback": { "type": "operation", "input": { "target": "com.amazonaws.artifact#PutComplianceInquiryFeedbackRequest" }, "output": { "target": "com.amazonaws.artifact#PutComplianceInquiryFeedbackResponse" }, "errors": [ { "target": "com.amazonaws.artifact#AccessDeniedException" }, { "target": "com.amazonaws.artifact#ConflictException" }, { "target": "com.amazonaws.artifact#InternalServerException" }, { "target": "com.amazonaws.artifact#ResourceNotFoundException" }, { "target": "com.amazonaws.artifact#ThrottlingException" }, { "target": "com.amazonaws.artifact#ValidationException" } ], "traits": { "smithy.api#documentation": "

Submits feedback on a compliance inquiry response.

", "smithy.api#http": { "code": 200, "method": "PUT", "uri": "/v1/compliance-inquiry/putFeedback" }, "smithy.api#idempotent": {} } }, "com.amazonaws.artifact#PutComplianceInquiryFeedbackRequest": { "type": "structure", "members": { "complianceInquiryId": { "target": "com.amazonaws.artifact#InquiryId", "traits": { "smithy.api#documentation": "

The unique identifier for the compliance inquiry.

", "smithy.api#required": {} } }, "queryIdentifier": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The sequential identifier of the query to provide feedback on.

" } }, "rating": { "target": "com.amazonaws.artifact#FeedbackRating", "traits": { "smithy.api#documentation": "

The rating for the feedback. Valid values are THUMBS_UP and THUMBS_DOWN.

", "smithy.api#required": {} } }, "responseRevisionId": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The response revision ID. Use this value to prevent submitting feedback on a stale response.

" } }, "reasonCodes": { "target": "com.amazonaws.artifact#FeedbackReasonCodeList", "traits": { "smithy.api#documentation": "

The reason codes that describe why you rated the response. Valid values are OTHER, PARTIAL_RESPONSE, and IRRELEVANT_RESPONSE.

" } }, "comment": { "target": "com.amazonaws.artifact#FeedbackCommentAttribute", "traits": { "smithy.api#documentation": "

An optional comment for the feedback.

" } }, "clientToken": { "target": "com.amazonaws.artifact#IdempotentClientToken", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.artifact#PutComplianceInquiryFeedbackResponse": { "type": "structure", "members": { "submittedAt": { "target": "com.amazonaws.artifact#TimestampAttribute", "traits": { "smithy.api#documentation": "

The timestamp when the feedback was submitted.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.artifact#QueriesList": { "type": "list", "member": { "target": "com.amazonaws.artifact#QuerySummary" } }, "com.amazonaws.artifact#QueryIdentifiersList": { "type": "list", "member": { "target": "smithy.api#Integer" } }, "com.amazonaws.artifact#QueryStatus": { "type": "enum", "members": { "PROCESSING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROCESSING" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.artifact#QueryStatusMessage": { "type": "enum", "members": { "SUCCESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Query processing is complete." } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Query processing is in-progress." } }, "INTERNAL_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "An internal error occurred while processing the query. Try again at a later time." } }, "PENDING_HUMAN_REVIEW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Query is pending human review." } }, "RESTRICTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Query contains restricted or unsupported content." } } } }, "com.amazonaws.artifact#QuerySummary": { "type": "structure", "members": { "queryIdentifier": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

Sequential identifier of the query within the inquiry.

", "smithy.api#required": {} } }, "query": { "target": "com.amazonaws.artifact#LongStringAttribute", "traits": { "smithy.api#documentation": "

The actual query text.

", "smithy.api#required": {} } }, "response": { "target": "com.amazonaws.artifact#LongStringAttribute", "traits": { "smithy.api#documentation": "

Generated response to the query.

" } }, "reviewType": { "target": "com.amazonaws.artifact#ReviewType", "traits": { "smithy.api#documentation": "

Type of review for the response.

" } }, "citations": { "target": "com.amazonaws.artifact#CitationList", "traits": { "smithy.api#documentation": "

Supporting citations for the response.

" } }, "status": { "target": "com.amazonaws.artifact#QueryStatus", "traits": { "smithy.api#documentation": "

Current processing status of the query.

", "smithy.api#required": {} } }, "statusMessage": { "target": "com.amazonaws.artifact#QueryStatusMessage", "traits": { "smithy.api#documentation": "

Descriptive status message.

", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.artifact#TimestampAttribute", "traits": { "smithy.api#documentation": "

Timestamp when the query was created.

", "smithy.api#required": {} } }, "updatedResponseVersions": { "target": "com.amazonaws.artifact#ResponseVersionList", "traits": { "smithy.api#documentation": "

Ordered list of response version history entries, oldest first.

" } } }, "traits": { "smithy.api#documentation": "

Summary information about a single query within a compliance inquiry.

" } }, "com.amazonaws.artifact#ReportDetail": { "type": "structure", "members": { "id": { "target": "com.amazonaws.artifact#ReportId", "traits": { "smithy.api#documentation": "

Unique resource ID for the report resource.

" } }, "name": { "target": "com.amazonaws.artifact#ShortStringAttribute", "traits": { "smithy.api#documentation": "

Name for the report resource.

" } }, "description": { "target": "com.amazonaws.artifact#LongStringAttribute", "traits": { "smithy.api#documentation": "

Description for the report resource.

" } }, "periodStart": { "target": "com.amazonaws.artifact#TimestampAttribute", "traits": { "smithy.api#documentation": "

Timestamp indicating the report resource effective start.

" } }, "periodEnd": { "target": "com.amazonaws.artifact#TimestampAttribute", "traits": { "smithy.api#documentation": "

Timestamp indicating the report resource effective end.

" } }, "createdAt": { "target": "com.amazonaws.artifact#TimestampAttribute", "traits": { "smithy.api#documentation": "

Timestamp indicating when the report resource was created.

" } }, "lastModifiedAt": { "target": "com.amazonaws.artifact#TimestampAttribute", "traits": { "smithy.api#documentation": "

Timestamp indicating when the report resource was last modified.

" } }, "deletedAt": { "target": "com.amazonaws.artifact#TimestampAttribute", "traits": { "smithy.api#documentation": "

Timestamp indicating when the report resource was deleted.

" } }, "state": { "target": "com.amazonaws.artifact#PublishedState", "traits": { "smithy.api#documentation": "

Current state of the report resource

" } }, "arn": { "target": "com.amazonaws.artifact#LongStringAttribute", "traits": { "smithy.api#documentation": "

ARN for the report resource.

" } }, "series": { "target": "com.amazonaws.artifact#ShortStringAttribute", "traits": { "smithy.api#documentation": "

Series for the report resource.

" } }, "category": { "target": "com.amazonaws.artifact#ShortStringAttribute", "traits": { "smithy.api#documentation": "

Category for the report resource.

" } }, "companyName": { "target": "com.amazonaws.artifact#ShortStringAttribute", "traits": { "smithy.api#documentation": "

Associated company name for the report resource.

" } }, "productName": { "target": "com.amazonaws.artifact#ShortStringAttribute", "traits": { "smithy.api#documentation": "

Associated product name for the report resource.

" } }, "termArn": { "target": "com.amazonaws.artifact#LongStringAttribute", "traits": { "smithy.api#documentation": "

Unique resource ARN for term resource.

" } }, "version": { "target": "com.amazonaws.artifact#VersionAttribute", "traits": { "smithy.api#documentation": "

Version for the report resource.

" } }, "acceptanceType": { "target": "com.amazonaws.artifact#AcceptanceType", "traits": { "smithy.api#documentation": "

Acceptance type for report.

" } }, "sequenceNumber": { "target": "com.amazonaws.artifact#SequenceNumberAttribute", "traits": { "smithy.api#documentation": "

Sequence number to enforce optimistic locking.

" } }, "uploadState": { "target": "com.amazonaws.artifact#UploadState", "traits": { "smithy.api#documentation": "

The current state of the document upload.

" } }, "statusMessage": { "target": "com.amazonaws.artifact#StatusMessage", "traits": { "smithy.api#documentation": "

The message associated with the current upload state.

" } } }, "traits": { "smithy.api#documentation": "

Full detail for report resource metadata.

" } }, "com.amazonaws.artifact#ReportId": { "type": "string", "traits": { "smithy.api#pattern": "^report-[a-zA-Z0-9]{16}$" } }, "com.amazonaws.artifact#ReportResource": { "type": "resource", "identifiers": { "reportId": { "target": "com.amazonaws.artifact#ReportId" } }, "read": { "target": "com.amazonaws.artifact#GetReportMetadata" }, "list": { "target": "com.amazonaws.artifact#ListReports" }, "operations": [ { "target": "com.amazonaws.artifact#GetReport" }, { "target": "com.amazonaws.artifact#GetTermForReport" }, { "target": "com.amazonaws.artifact#ListReportVersions" } ] }, "com.amazonaws.artifact#ReportSummary": { "type": "structure", "members": { "id": { "target": "com.amazonaws.artifact#ReportId", "traits": { "smithy.api#documentation": "

Unique resource ID for the report resource.

" } }, "name": { "target": "com.amazonaws.artifact#ShortStringAttribute", "traits": { "smithy.api#documentation": "

Name for the report resource.

" } }, "state": { "target": "com.amazonaws.artifact#PublishedState", "traits": { "smithy.api#documentation": "

Current state of the report resource.

" } }, "arn": { "target": "com.amazonaws.artifact#LongStringAttribute", "traits": { "smithy.api#documentation": "

ARN for the report resource.

" } }, "version": { "target": "com.amazonaws.artifact#VersionAttribute", "traits": { "smithy.api#documentation": "

Version for the report resource.

" } }, "uploadState": { "target": "com.amazonaws.artifact#UploadState", "traits": { "smithy.api#documentation": "

The current state of the document upload.

" } }, "description": { "target": "com.amazonaws.artifact#LongStringAttribute", "traits": { "smithy.api#documentation": "

Description for the report resource.

" } }, "periodStart": { "target": "com.amazonaws.artifact#TimestampAttribute", "traits": { "smithy.api#documentation": "

Timestamp indicating the report resource effective start.

" } }, "periodEnd": { "target": "com.amazonaws.artifact#TimestampAttribute", "traits": { "smithy.api#documentation": "

Timestamp indicating the report resource effective end.

" } }, "series": { "target": "com.amazonaws.artifact#ShortStringAttribute", "traits": { "smithy.api#documentation": "

Series for the report resource.

" } }, "category": { "target": "com.amazonaws.artifact#ShortStringAttribute", "traits": { "smithy.api#documentation": "

Category for the report resource.

" } }, "companyName": { "target": "com.amazonaws.artifact#ShortStringAttribute", "traits": { "smithy.api#documentation": "

Associated company name for the report resource.

" } }, "productName": { "target": "com.amazonaws.artifact#ShortStringAttribute", "traits": { "smithy.api#documentation": "

Associated product name for the report resource.

" } }, "statusMessage": { "target": "com.amazonaws.artifact#StatusMessage", "traits": { "smithy.api#documentation": "

The message associated with the current upload state.

" } }, "acceptanceType": { "target": "com.amazonaws.artifact#AcceptanceType", "traits": { "smithy.api#documentation": "

Acceptance type for report.

" } } }, "traits": { "smithy.api#documentation": "

Summary for report resource.

" } }, "com.amazonaws.artifact#ReportsList": { "type": "list", "member": { "target": "com.amazonaws.artifact#ReportSummary" } }, "com.amazonaws.artifact#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Identifier of the affected resource.

", "smithy.api#required": {} } }, "resourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Type of the affected resource.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Request references a resource which does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.artifact#ResponseVersion": { "type": "structure", "members": { "responseText": { "target": "com.amazonaws.artifact#LongStringAttribute", "traits": { "smithy.api#documentation": "

The response text for this version.

", "smithy.api#required": {} } }, "timestamp": { "target": "com.amazonaws.artifact#TimestampAttribute", "traits": { "smithy.api#documentation": "

ISO 8601 timestamp of when this edit was made.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A versioned snapshot of a response edit.

" } }, "com.amazonaws.artifact#ResponseVersionList": { "type": "list", "member": { "target": "com.amazonaws.artifact#ResponseVersion" } }, "com.amazonaws.artifact#ReviewType": { "type": "enum", "members": { "HUMAN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HUMAN" } }, "AI": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AI" } } } }, "com.amazonaws.artifact#SequenceNumberAttribute": { "type": "long", "traits": { "smithy.api#range": { "min": 1 } } }, "com.amazonaws.artifact#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Identifier of the affected resource.

", "smithy.api#required": {} } }, "resourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Type of the affected resource.

", "smithy.api#required": {} } }, "serviceCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Code for the affected service.

", "smithy.api#required": {} } }, "quotaCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Code for the affected quota.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Request would cause a service quota to be exceeded.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.artifact#ShortStringAttribute": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9_\\-\\s]*$" } }, "com.amazonaws.artifact#StatusMessage": { "type": "string" }, "com.amazonaws.artifact#TagKey": { "type": "string", "traits": { "smithy.api#documentation": "

A tag key.

", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9\\s_.:/=+\\-@]*$" } }, "com.amazonaws.artifact#TagKeys": { "type": "list", "member": { "target": "com.amazonaws.artifact#TagKey" }, "traits": { "smithy.api#documentation": "

A list of tag keys.

", "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.artifact#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.artifact#TagResourceRequest" }, "output": { "target": "com.amazonaws.artifact#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.artifact#AccessDeniedException" }, { "target": "com.amazonaws.artifact#InternalServerException" }, { "target": "com.amazonaws.artifact#ResourceNotFoundException" }, { "target": "com.amazonaws.artifact#ThrottlingException" }, { "target": "com.amazonaws.artifact#ValidationException" } ], "traits": { "smithy.api#documentation": "

Add tags to a resource.

", "smithy.api#http": { "code": 204, "method": "POST", "uri": "/tags/{resourceArn}" } } }, "com.amazonaws.artifact#TagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.artifact#LongStringAttribute", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.artifact#TagsMap", "traits": { "smithy.api#documentation": "

Tags to add to the resource.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.artifact#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.artifact#TagValue": { "type": "string", "traits": { "smithy.api#documentation": "

A tag value.

", "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9\\s_.:/=+\\-@]*$" } }, "com.amazonaws.artifact#TagsMap": { "type": "map", "key": { "target": "com.amazonaws.artifact#TagKey" }, "value": { "target": "com.amazonaws.artifact#TagValue" }, "traits": { "smithy.api#documentation": "

A map of tag keys to tag values.

", "smithy.api#length": { "max": 50 } } }, "com.amazonaws.artifact#TermId": { "type": "string", "traits": { "smithy.api#pattern": "^term-[a-zA-Z0-9]{16}$" } }, "com.amazonaws.artifact#TermResource": { "type": "resource", "identifiers": { "termId": { "target": "com.amazonaws.artifact#TermId" } } }, "com.amazonaws.artifact#ThrottlingException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "serviceCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Code for the affected service.

" } }, "quotaCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Code for the affected quota.

" } }, "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

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

", "smithy.api#httpHeader": "Retry-After" } } }, "traits": { "smithy.api#documentation": "

Request was denied due to request throttling.

", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { "throttling": true } } }, "com.amazonaws.artifact#TimestampAttribute": { "type": "timestamp", "traits": { "smithy.api#timestampFormat": "date-time" } }, "com.amazonaws.artifact#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.artifact#UntagResourceRequest" }, "output": { "target": "com.amazonaws.artifact#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.artifact#AccessDeniedException" }, { "target": "com.amazonaws.artifact#InternalServerException" }, { "target": "com.amazonaws.artifact#ResourceNotFoundException" }, { "target": "com.amazonaws.artifact#ThrottlingException" }, { "target": "com.amazonaws.artifact#ValidationException" } ], "traits": { "smithy.api#documentation": "

Remove tags from a resource.

", "smithy.api#http": { "code": 204, "method": "DELETE", "uri": "/tags/{resourceArn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.artifact#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.artifact#LongStringAttribute", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.artifact#TagKeys", "traits": { "smithy.api#documentation": "

Tag keys to remove from the resource.

", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.artifact#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.artifact#UploadState": { "type": "enum", "members": { "PROCESSING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROCESSING" } }, "COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETE" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "FAULT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAULT" } } } }, "com.amazonaws.artifact#ValidationException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.artifact#ValidationExceptionReason", "traits": { "smithy.api#documentation": "

Reason the request failed validation.

", "smithy.api#required": {} } }, "fieldList": { "target": "com.amazonaws.artifact#ValidationExceptionFieldList", "traits": { "smithy.api#documentation": "

The field that caused the error, if applicable.

" } } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.artifact#ValidationExceptionField": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Name of validation exception.

", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Message describing why the field failed validation.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Validation exception message and name.

" } }, "com.amazonaws.artifact#ValidationExceptionFieldList": { "type": "list", "member": { "target": "com.amazonaws.artifact#ValidationExceptionField" } }, "com.amazonaws.artifact#ValidationExceptionReason": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "unknownOperation", "name": "UNKNOWN_OPERATION" }, { "value": "cannotParse", "name": "CANNOT_PARSE" }, { "value": "fieldValidationFailed", "name": "FIELD_VALIDATION_FAILED" }, { "value": "invalidToken", "name": "INVALID_TOKEN" }, { "value": "other", "name": "OTHER" } ] } }, "com.amazonaws.artifact#VersionAttribute": { "type": "long", "traits": { "smithy.api#range": { "min": 1 } } } } }