diff --git a/codegen/aws-models/bedrock-data-automation-runtime.json b/codegen/aws-models/bedrock-data-automation-runtime.json new file mode 100644 index 0000000..87e1799 --- /dev/null +++ b/codegen/aws-models/bedrock-data-automation-runtime.json @@ -0,0 +1,2070 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.bedrockdataautomationruntime#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockdataautomationruntime#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception will be thrown when customer does not have access to API.", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.bedrockdataautomationruntime#AmazonBedrockKeystoneRuntimeService": { + "type": "service", + "version": "2024-06-13", + "operations": [ + { + "target": "com.amazonaws.bedrockdataautomationruntime#InvokeDataAutomation" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#ListTagsForResource" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#TagResource" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.bedrockdataautomationruntime#AutomationJobResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Bedrock Data Automation Runtime", + "arnNamespace": "bedrock", + "endpointPrefix": "bedrock-data-automation-runtime", + "cloudTrailEventSource": "bedrock.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "bedrock" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Amazon Bedrock Data Automation Runtime", + "smithy.api#title": "Runtime for Amazon Bedrock Data Automation", + "smithy.rules#endpointBdd": { + "version": "1.1", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "string" + }, + "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" + } + }, + "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://bedrock-data-automation-runtime-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "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://bedrock-data-automation-runtime-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-data-automation-runtime.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-data-automation-runtime.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "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": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "string" + }, + "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" + } + }, + "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": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-data-automation-runtime-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "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 + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-data-automation-runtime-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-data-automation-runtime.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-data-automation-runtime.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-data-automation-runtime-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": { + "url": "https://bedrock-data-automation-runtime-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": { + "url": "https://bedrock-data-automation-runtime.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": { + "url": "https://bedrock-data-automation-runtime.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-data-automation-runtime-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-data-automation-runtime-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-data-automation-runtime.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-data-automation-runtime.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-data-automation-runtime-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-data-automation-runtime-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-data-automation-runtime.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-data-automation-runtime.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-data-automation-runtime-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": { + "url": "https://bedrock-data-automation-runtime.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": { + "url": "https://bedrock-data-automation-runtime-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": { + "url": "https://bedrock-data-automation-runtime.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.bedrockdataautomationruntime#AssetProcessingConfiguration": { + "type": "structure", + "members": { + "video": { + "target": "com.amazonaws.bedrockdataautomationruntime#VideoAssetProcessingConfiguration", + "traits": { + "smithy.api#documentation": "Video asset processing configuration" + } + } + }, + "traits": { + "smithy.api#documentation": "Config containing asset processing related knobs for all modalities" + } + }, + "com.amazonaws.bedrockdataautomationruntime#AutomationJobResource": { + "type": "resource", + "identifiers": { + "invocationArn": { + "target": "com.amazonaws.bedrockdataautomationruntime#InvocationArn" + } + }, + "create": { + "target": "com.amazonaws.bedrockdataautomationruntime#InvokeDataAutomationAsync" + }, + "read": { + "target": "com.amazonaws.bedrockdataautomationruntime#GetDataAutomationStatus" + } + }, + "com.amazonaws.bedrockdataautomationruntime#AutomationJobStatus": { + "type": "enum", + "members": { + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Created" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Success" + } + }, + "SERVICE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ServiceError" + } + }, + "CLIENT_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ClientError" + } + } + }, + "traits": { + "smithy.api#documentation": "List of status supported by automation jobs" + } + }, + "com.amazonaws.bedrockdataautomationruntime#Blueprint": { + "type": "structure", + "members": { + "blueprintArn": { + "target": "com.amazonaws.bedrockdataautomationruntime#BlueprintArn", + "traits": { + "smithy.api#documentation": "Arn of blueprint.", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrockdataautomationruntime#BlueprintVersion", + "traits": { + "smithy.api#documentation": "Version of blueprint." + } + }, + "stage": { + "target": "com.amazonaws.bedrockdataautomationruntime#BlueprintStage", + "traits": { + "smithy.api#documentation": "Stage of blueprint." + } + } + }, + "traits": { + "smithy.api#documentation": "Structure for single blueprint entity." + } + }, + "com.amazonaws.bedrockdataautomationruntime#BlueprintArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "ARN of a Blueprint", + "smithy.api#length": { + "max": 128 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-insights-public-[a-zA-Z0-9-_]{1,30}|bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})$" + } + }, + "com.amazonaws.bedrockdataautomationruntime#BlueprintList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomationruntime#Blueprint", + "traits": { + "smithy.api#documentation": "Blueprint." + } + }, + "traits": { + "smithy.api#documentation": "Blueprint list.", + "smithy.api#length": { + "min": 1, + "max": 40 + } + } + }, + "com.amazonaws.bedrockdataautomationruntime#BlueprintStage": { + "type": "enum", + "members": { + "DEVELOPMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEVELOPMENT" + } + }, + "LIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIVE" + } + } + }, + "traits": { + "smithy.api#documentation": "Blueprint stage enum." + } + }, + "com.amazonaws.bedrockdataautomationruntime#BlueprintVersion": { + "type": "string", + "traits": { + "smithy.api#documentation": "Blueprint version.", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[0-9]*$" + } + }, + "com.amazonaws.bedrockdataautomationruntime#CustomOutputStatus": { + "type": "enum", + "members": { + "MATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MATCH" + } + }, + "NO_MATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_MATCH" + } + } + }, + "traits": { + "smithy.api#documentation": "Custom output status enum" + } + }, + "com.amazonaws.bedrockdataautomationruntime#DataAutomationArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "Data automation arn.", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-project/[a-zA-Z0-9-_]+$" + } + }, + "com.amazonaws.bedrockdataautomationruntime#DataAutomationConfiguration": { + "type": "structure", + "members": { + "dataAutomationProjectArn": { + "target": "com.amazonaws.bedrockdataautomationruntime#DataAutomationArn", + "traits": { + "smithy.api#documentation": "Data automation project arn.", + "smithy.api#required": {} + } + }, + "stage": { + "target": "com.amazonaws.bedrockdataautomationruntime#DataAutomationStage", + "traits": { + "smithy.api#documentation": "Data automation stage." + } + } + }, + "traits": { + "smithy.api#documentation": "Data automation configuration." + } + }, + "com.amazonaws.bedrockdataautomationruntime#DataAutomationProfileArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "Data automation profile arn.", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-profile/[a-zA-Z0-9-_.]+$" + } + }, + "com.amazonaws.bedrockdataautomationruntime#DataAutomationStage": { + "type": "enum", + "members": { + "LIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIVE" + } + }, + "DEVELOPMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEVELOPMENT" + } + } + }, + "traits": { + "smithy.api#documentation": "Data automation stage." + } + }, + "com.amazonaws.bedrockdataautomationruntime#EncryptionConfiguration": { + "type": "structure", + "members": { + "kmsKeyId": { + "target": "com.amazonaws.bedrockdataautomationruntime#KMSKeyId", + "traits": { + "smithy.api#documentation": "Customer KMS key used for encryption", + "smithy.api#required": {} + } + }, + "kmsEncryptionContext": { + "target": "com.amazonaws.bedrockdataautomationruntime#EncryptionContextMap", + "traits": { + "smithy.api#documentation": "KMS encryption context." + } + } + }, + "traits": { + "smithy.api#documentation": "Encryption configuration." + } + }, + "com.amazonaws.bedrockdataautomationruntime#EncryptionContextKey": { + "type": "string", + "traits": { + "smithy.api#documentation": "Excryption context key.", + "smithy.api#length": { + "min": 1, + "max": 2000 + }, + "smithy.api#pattern": "^.*\\S.*$" + } + }, + "com.amazonaws.bedrockdataautomationruntime#EncryptionContextMap": { + "type": "map", + "key": { + "target": "com.amazonaws.bedrockdataautomationruntime#EncryptionContextKey" + }, + "value": { + "target": "com.amazonaws.bedrockdataautomationruntime#EncryptionContextValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.bedrockdataautomationruntime#EncryptionContextValue": { + "type": "string", + "traits": { + "smithy.api#documentation": "Encryption context value.", + "smithy.api#length": { + "min": 1, + "max": 2000 + }, + "smithy.api#pattern": "^.*\\S.*$" + } + }, + "com.amazonaws.bedrockdataautomationruntime#EventBridgeConfiguration": { + "type": "structure", + "members": { + "eventBridgeEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Event bridge flag.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Event bridge configuration." + } + }, + "com.amazonaws.bedrockdataautomationruntime#GetDataAutomationStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomationruntime#GetDataAutomationStatusRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomationruntime#GetDataAutomationStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomationruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "API used to get data automation status.", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockdataautomationruntime#GetDataAutomationStatusRequest": { + "type": "structure", + "members": { + "invocationArn": { + "target": "com.amazonaws.bedrockdataautomationruntime#InvocationArn", + "traits": { + "smithy.api#documentation": "Invocation arn.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Structure for request of GetDataAutomationStatus API.", + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockdataautomationruntime#AutomationJobResource" + } + ] + } + }, + "com.amazonaws.bedrockdataautomationruntime#GetDataAutomationStatusResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrockdataautomationruntime#AutomationJobStatus", + "traits": { + "smithy.api#documentation": "Job Status." + } + }, + "errorType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Error Type." + } + }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Error Message." + } + }, + "outputConfiguration": { + "target": "com.amazonaws.bedrockdataautomationruntime#OutputConfiguration", + "traits": { + "smithy.api#documentation": "Output configuration." + } + }, + "jobSubmissionTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "Job Submission time.", + "smithy.api#timestampFormat": "date-time" + } + }, + "jobCompletionTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "Job completion time.", + "smithy.api#timestampFormat": "date-time" + } + }, + "jobDurationInSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Job duration in seconds." + } + } + }, + "traits": { + "smithy.api#documentation": "Response of GetDataAutomationStatus API.", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomationruntime#IdempotencyToken": { + "type": "string", + "traits": { + "smithy.api#documentation": "Client specified token used for idempotency checks", + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){1,256}$" + } + }, + "com.amazonaws.bedrockdataautomationruntime#InputConfiguration": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrockdataautomationruntime#S3Uri", + "traits": { + "smithy.api#documentation": "S3 uri.", + "smithy.api#required": {} + } + }, + "assetProcessingConfiguration": { + "target": "com.amazonaws.bedrockdataautomationruntime#AssetProcessingConfiguration", + "traits": { + "smithy.api#documentation": "Asset processing configuration" + } + } + }, + "traits": { + "smithy.api#documentation": "Input configuration." + } + }, + "com.amazonaws.bedrockdataautomationruntime#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockdataautomationruntime#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception is for any internal un-expected service errors.", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.bedrockdataautomationruntime#InvocationArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "Invocation arn.", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-invocation/[a-zA-Z0-9-_]+$" + } + }, + "com.amazonaws.bedrockdataautomationruntime#InvokeDataAutomation": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomationruntime#InvokeDataAutomationRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomationruntime#InvokeDataAutomationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomationruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Sync API: Invoke data automation." + } + }, + "com.amazonaws.bedrockdataautomationruntime#InvokeDataAutomationAsync": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomationruntime#InvokeDataAutomationAsyncRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomationruntime#InvokeDataAutomationAsyncResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomationruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Async API: Invoke data automation.", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrockdataautomationruntime#InvokeDataAutomationAsyncRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.bedrockdataautomationruntime#IdempotencyToken", + "traits": { + "smithy.api#documentation": "Idempotency token.", + "smithy.api#idempotencyToken": {} + } + }, + "inputConfiguration": { + "target": "com.amazonaws.bedrockdataautomationruntime#InputConfiguration", + "traits": { + "smithy.api#documentation": "Input configuration.", + "smithy.api#required": {} + } + }, + "outputConfiguration": { + "target": "com.amazonaws.bedrockdataautomationruntime#OutputConfiguration", + "traits": { + "smithy.api#documentation": "Output configuration.", + "smithy.api#required": {} + } + }, + "dataAutomationConfiguration": { + "target": "com.amazonaws.bedrockdataautomationruntime#DataAutomationConfiguration", + "traits": { + "smithy.api#documentation": "Data automation configuration." + } + }, + "encryptionConfiguration": { + "target": "com.amazonaws.bedrockdataautomationruntime#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "Encryption configuration." + } + }, + "notificationConfiguration": { + "target": "com.amazonaws.bedrockdataautomationruntime#NotificationConfiguration", + "traits": { + "smithy.api#documentation": "Notification configuration." + } + }, + "blueprints": { + "target": "com.amazonaws.bedrockdataautomationruntime#BlueprintList", + "traits": { + "smithy.api#documentation": "Blueprint list." + } + }, + "dataAutomationProfileArn": { + "target": "com.amazonaws.bedrockdataautomationruntime#DataAutomationProfileArn", + "traits": { + "smithy.api#documentation": "Data automation profile ARN", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockdataautomationruntime#TagList", + "traits": { + "smithy.api#documentation": "List of tags." + } + } + }, + "traits": { + "smithy.api#documentation": "Invoke Data Automation Async Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomationruntime#InvokeDataAutomationAsyncResponse": { + "type": "structure", + "members": { + "invocationArn": { + "target": "com.amazonaws.bedrockdataautomationruntime#InvocationArn", + "traits": { + "smithy.api#documentation": "ARN of the automation job", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Invoke Data Automation Async Response", + "smithy.api#output": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrockdataautomationruntime#AutomationJobResource" + } + ] + } + }, + "com.amazonaws.bedrockdataautomationruntime#InvokeDataAutomationRequest": { + "type": "structure", + "members": { + "inputConfiguration": { + "target": "com.amazonaws.bedrockdataautomationruntime#SyncInputConfiguration", + "traits": { + "smithy.api#documentation": "Input configuration.", + "smithy.api#required": {} + } + }, + "dataAutomationConfiguration": { + "target": "com.amazonaws.bedrockdataautomationruntime#DataAutomationConfiguration", + "traits": { + "smithy.api#documentation": "Data automation configuration." + } + }, + "blueprints": { + "target": "com.amazonaws.bedrockdataautomationruntime#BlueprintList", + "traits": { + "smithy.api#documentation": "Blueprint list." + } + }, + "dataAutomationProfileArn": { + "target": "com.amazonaws.bedrockdataautomationruntime#DataAutomationProfileArn", + "traits": { + "smithy.api#documentation": "Data automation profile ARN", + "smithy.api#required": {} + } + }, + "encryptionConfiguration": { + "target": "com.amazonaws.bedrockdataautomationruntime#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "Encryption configuration." + } + }, + "outputConfiguration": { + "target": "com.amazonaws.bedrockdataautomationruntime#OutputConfiguration", + "traits": { + "smithy.api#documentation": "Output configuration." + } + } + }, + "traits": { + "smithy.api#documentation": "Invoke Data Automation Request", + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomationruntime#InvokeDataAutomationResponse": { + "type": "structure", + "members": { + "outputConfiguration": { + "target": "com.amazonaws.bedrockdataautomationruntime#OutputConfiguration", + "traits": { + "smithy.api#documentation": "Output configuration" + } + }, + "semanticModality": { + "target": "com.amazonaws.bedrockdataautomationruntime#SemanticModality", + "traits": { + "smithy.api#documentation": "Detected semantic modality", + "smithy.api#required": {} + } + }, + "outputSegments": { + "target": "com.amazonaws.bedrockdataautomationruntime#OutputSegmentList", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": [], + "smithy.api#documentation": "List of outputs for each logical sub-doc" + } + } + }, + "traits": { + "smithy.api#documentation": "Invoke Data Automation Response", + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomationruntime#KMSKeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]+$" + } + }, + "com.amazonaws.bedrockdataautomationruntime#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomationruntime#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomationruntime#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomationruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List tags for an Amazon Bedrock Data Automation resource" + } + }, + "com.amazonaws.bedrockdataautomationruntime#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceARN": { + "target": "com.amazonaws.bedrockdataautomationruntime#TaggableResourceArn", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomationruntime#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.bedrockdataautomationruntime#TagList" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomationruntime#NonBlankString": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.bedrockdataautomationruntime#NotificationConfiguration": { + "type": "structure", + "members": { + "eventBridgeConfiguration": { + "target": "com.amazonaws.bedrockdataautomationruntime#EventBridgeConfiguration", + "traits": { + "smithy.api#documentation": "Event bridge configuration.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Notification configuration." + } + }, + "com.amazonaws.bedrockdataautomationruntime#OutputConfiguration": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrockdataautomationruntime#S3Uri", + "traits": { + "smithy.api#documentation": "S3 uri.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Output configuration." + } + }, + "com.amazonaws.bedrockdataautomationruntime#OutputSegment": { + "type": "structure", + "members": { + "customOutputStatus": { + "target": "com.amazonaws.bedrockdataautomationruntime#CustomOutputStatus", + "traits": { + "smithy.api#documentation": "Status of blueprint match" + } + }, + "customOutput": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Custom output response" + } + }, + "standardOutput": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Standard output response" + } + } + }, + "traits": { + "smithy.api#documentation": "Results for an output segment" + } + }, + "com.amazonaws.bedrockdataautomationruntime#OutputSegmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomationruntime#OutputSegment", + "traits": { + "smithy.api#documentation": "Output segment" + } + }, + "traits": { + "smithy.api#documentation": "Output segment list" + } + }, + "com.amazonaws.bedrockdataautomationruntime#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockdataautomationruntime#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception will be thrown when resource provided from customer not found.", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.bedrockdataautomationruntime#S3Uri": { + "type": "string", + "traits": { + "smithy.api#documentation": "A path in S3", + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/[^\\x00-\\x1F\\x7F\\{^}%`\\]\">\\[~<#|]*)?$" + } + }, + "com.amazonaws.bedrockdataautomationruntime#SemanticModality": { + "type": "enum", + "members": { + "DOCUMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOCUMENT" + } + }, + "IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGE" + } + }, + "AUDIO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUDIO" + } + }, + "VIDEO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIDEO" + } + } + }, + "traits": { + "smithy.api#documentation": "Semantic modality enum" + } + }, + "com.amazonaws.bedrockdataautomationruntime#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockdataautomationruntime#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception will be thrown when service quota is exceeded.", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.bedrockdataautomationruntime#ServiceUnavailableException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockdataautomationruntime#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception will be thrown when service is temporarily unavailable.", + "smithy.api#error": "server", + "smithy.api#httpError": 503 + } + }, + "com.amazonaws.bedrockdataautomationruntime#SyncInputConfiguration": { + "type": "structure", + "members": { + "bytes": { + "target": "smithy.api#Blob", + "traits": { + "smithy.api#documentation": "Input data as bytes" + } + }, + "s3Uri": { + "target": "com.amazonaws.bedrockdataautomationruntime#S3Uri", + "traits": { + "smithy.api#documentation": "S3 URI of the input data" + } + } + }, + "traits": { + "smithy.api#documentation": "Input configuration for synchronous API" + } + }, + "com.amazonaws.bedrockdataautomationruntime#Tag": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.bedrockdataautomationruntime#TagKey", + "traits": { + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.bedrockdataautomationruntime#TagValue", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Key value pair of a tag" + } + }, + "com.amazonaws.bedrockdataautomationruntime#TagKey": { + "type": "string", + "traits": { + "smithy.api#documentation": "Defines the context of the tag.", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*$" + } + }, + "com.amazonaws.bedrockdataautomationruntime#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomationruntime#TagKey" + }, + "traits": { + "smithy.api#documentation": "List of tag keys", + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.bedrockdataautomationruntime#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockdataautomationruntime#Tag" + }, + "traits": { + "smithy.api#documentation": "List of tags", + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.bedrockdataautomationruntime#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomationruntime#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomationruntime#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomationruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Tag an Amazon Bedrock Data Automation resource" + } + }, + "com.amazonaws.bedrockdataautomationruntime#TagResourceRequest": { + "type": "structure", + "members": { + "resourceARN": { + "target": "com.amazonaws.bedrockdataautomationruntime#TaggableResourceArn", + "traits": { + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrockdataautomationruntime#TagList", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomationruntime#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomationruntime#TagValue": { + "type": "string", + "traits": { + "smithy.api#documentation": "Defines the value within the context. e.g. .", + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.bedrockdataautomationruntime#TaggableResourceArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "ARN of a taggable resource", + "smithy.api#length": { + "min": 20, + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-invocation/[a-zA-Z0-9-_]+$" + } + }, + "com.amazonaws.bedrockdataautomationruntime#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockdataautomationruntime#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception will be thrown when customer reached API TPS limit.", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.bedrockdataautomationruntime#TimestampSegment": { + "type": "structure", + "members": { + "startTimeMillis": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "Start timestamp in milliseconds", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + }, + "endTimeMillis": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "End timestamp in milliseconds", + "smithy.api#range": { + "min": 300000 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Timestamp segment" + } + }, + "com.amazonaws.bedrockdataautomationruntime#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockdataautomationruntime#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrockdataautomationruntime#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockdataautomationruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockdataautomationruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Untag an Amazon Bedrock Data Automation resource" + } + }, + "com.amazonaws.bedrockdataautomationruntime#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceARN": { + "target": "com.amazonaws.bedrockdataautomationruntime#TaggableResourceArn", + "traits": { + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.bedrockdataautomationruntime#TagKeyList", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockdataautomationruntime#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockdataautomationruntime#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockdataautomationruntime#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "This exception will be thrown when customer provided invalid parameters.", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bedrockdataautomationruntime#VideoAssetProcessingConfiguration": { + "type": "structure", + "members": { + "segmentConfiguration": { + "target": "com.amazonaws.bedrockdataautomationruntime#VideoSegmentConfiguration", + "traits": { + "smithy.api#documentation": "Delimits the segment of the input that will be processed" + } + } + }, + "traits": { + "smithy.api#documentation": "Video asset processing configuration" + } + }, + "com.amazonaws.bedrockdataautomationruntime#VideoSegmentConfiguration": { + "type": "union", + "members": { + "timestampSegment": { + "target": "com.amazonaws.bedrockdataautomationruntime#TimestampSegment", + "traits": { + "smithy.api#documentation": "Timestamp segment" + } + } + }, + "traits": { + "smithy.api#documentation": "Delimits the segment of the input that will be processed" + } + } + } +} \ No newline at end of file diff --git a/codegen/aws-models/cloudtrail.json b/codegen/aws-models/cloudtrail.json new file mode 100644 index 0000000..14e1d9e --- /dev/null +++ b/codegen/aws-models/cloudtrail.json @@ -0,0 +1,12193 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.cloudtrail#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceAccessDenied", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

\n You do not have sufficient access to perform this action.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.cloudtrail#AccountHasOngoingImportException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AccountHasOngoingImport", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when you start a new import and a previous import is still in\n progress.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 16 + }, + "smithy.api#pattern": "^\\d+$" + } + }, + "com.amazonaws.cloudtrail#AccountNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AccountNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

This exception is thrown when the specified account is not found or not part of an\n organization.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.cloudtrail#AccountNotRegisteredException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AccountNotRegistered", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the specified account is not registered as the CloudTrail delegated administrator.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#AccountRegisteredException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AccountRegistered", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the account is already registered as the CloudTrail\n delegated administrator.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#AddTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#AddTagsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#AddTagsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ChannelARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#ChannelNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTagParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException" + }, + { + "target": "com.amazonaws.cloudtrail#TagsLimitExceededException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds one or more tags to a trail, event data store, dashboard, or channel, up to a limit of 50. Overwrites an\n existing tag's value when a new value is specified for an existing tag key. Tag key names\n must be unique; you cannot have two keys with the same name but different\n values. If you specify a key without a value, the tag will be created with the specified\n key and a value of null. You can tag a trail or event data store that applies to all\n Amazon Web Services Regions only from the Region in which the trail or event data store\n was created (also known as its home Region).

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#AddTagsRequest": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the ARN of the trail, event data store, dashboard, or channel to which one or more tags will be\n added.

\n

The format of a trail ARN is:\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

\n

The format of an event data store ARN is:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n

\n

The format of a dashboard ARN is: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash\n

\n

The format of a channel ARN is:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n

", + "smithy.api#required": {} + } + }, + "TagsList": { + "target": "com.amazonaws.cloudtrail#TagsList", + "traits": { + "smithy.api#documentation": "

Contains a list of tags, up to a limit of 50

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

Specifies the tags to add to a trail, event data store, dashboard, or channel.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#AddTagsResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Returns the objects or data if successful. Otherwise, returns an error.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#AdvancedEventSelector": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#SelectorName", + "traits": { + "smithy.api#documentation": "

An optional, descriptive name for an advanced event selector, such as \"Log data events\n for only two S3 buckets\".

" + } + }, + "FieldSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedFieldSelectors", + "traits": { + "smithy.api#documentation": "

Contains all selector statements in an advanced event selector.

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

Advanced event selectors let you create fine-grained selectors for CloudTrail management, data, and network activity events. They help you control costs by logging only those\n events that are important to you. For more information about configuring advanced event selectors, see\n the Logging data events, Logging network activity events, and Logging management events topics in the CloudTrail User Guide.

\n

You cannot apply both event selectors and advanced event selectors to a trail.

\n

For information about configurable advanced event selector fields, see \n AdvancedEventSelector \n in the CloudTrail API Reference.

" + } + }, + "com.amazonaws.cloudtrail#AdvancedEventSelectors": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelector" + } + }, + "com.amazonaws.cloudtrail#AdvancedFieldSelector": { + "type": "structure", + "members": { + "Field": { + "target": "com.amazonaws.cloudtrail#SelectorField", + "traits": { + "smithy.api#documentation": "

A field in a CloudTrail event record on which to filter events to be logged. For\n event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for\n selecting events as filtering is not supported.

\n

For more information, see \n AdvancedFieldSelector \n in the CloudTrail API Reference.

\n \n

Selectors don't support the use of wildcards like * . To match multiple values with a single condition, \n you may use StartsWith, EndsWith, NotStartsWith, or NotEndsWith to explicitly match the beginning or end of the event field.

\n ", + "smithy.api#required": {} + } + }, + "Equals": { + "target": "com.amazonaws.cloudtrail#Operator", + "traits": { + "smithy.api#documentation": "

An operator that includes events that match the exact value of the event record field\n specified as the value of Field. This is the only valid operator that you can\n use with the readOnly, eventCategory, and\n resources.type fields.

" + } + }, + "StartsWith": { + "target": "com.amazonaws.cloudtrail#Operator", + "traits": { + "smithy.api#documentation": "

An operator that includes events that match the first few characters of the event record\n field specified as the value of Field.

" + } + }, + "EndsWith": { + "target": "com.amazonaws.cloudtrail#Operator", + "traits": { + "smithy.api#documentation": "

An operator that includes events that match the last few characters of the event record\n field specified as the value of Field.

" + } + }, + "NotEquals": { + "target": "com.amazonaws.cloudtrail#Operator", + "traits": { + "smithy.api#documentation": "

An operator that excludes events that match the exact value of the event record field\n specified as the value of Field.

" + } + }, + "NotStartsWith": { + "target": "com.amazonaws.cloudtrail#Operator", + "traits": { + "smithy.api#documentation": "

An operator that excludes events that match the first few characters of the event\n record field specified as the value of Field.

" + } + }, + "NotEndsWith": { + "target": "com.amazonaws.cloudtrail#Operator", + "traits": { + "smithy.api#documentation": "

An operator that excludes events that match the last few characters of the event record\n field specified as the value of Field.

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

A single selector statement in an advanced event selector.

" + } + }, + "com.amazonaws.cloudtrail#AdvancedFieldSelectors": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#AdvancedFieldSelector" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudtrail#AggregationConfiguration": { + "type": "structure", + "members": { + "Templates": { + "target": "com.amazonaws.cloudtrail#Templates", + "traits": { + "smithy.api#documentation": "

A list of aggregation templates that can be used to configure event aggregation.

", + "smithy.api#required": {} + } + }, + "EventCategory": { + "target": "com.amazonaws.cloudtrail#EventCategoryAggregation", + "traits": { + "smithy.api#documentation": "

Specifies the event category for which aggregation should be performed.

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

An object that contains configuration settings for aggregating events.

" + } + }, + "com.amazonaws.cloudtrail#AggregationConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#AggregationConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.cloudtrail#BillingMode": { + "type": "enum", + "members": { + "EXTENDABLE_RETENTION_PRICING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTENDABLE_RETENTION_PRICING" + } + }, + "FIXED_RETENTION_PRICING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIXED_RETENTION_PRICING" + } + } + } + }, + "com.amazonaws.cloudtrail#Boolean": { + "type": "boolean" + }, + "com.amazonaws.cloudtrail#ByteBuffer": { + "type": "blob" + }, + "com.amazonaws.cloudtrail#CancelQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#CancelQueryRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#CancelQueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveQueryException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#QueryIdNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels a query if the query is not in a terminated state, such as\n CANCELLED, FAILED, TIMED_OUT, or\n FINISHED. You must specify an ARN value for EventDataStore.\n The ID of the query that you want to cancel is also required. When you run\n CancelQuery, the query status might show as CANCELLED even if\n the operation is not yet finished.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#CancelQueryRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#deprecated": { + "message": "EventDataStore is no longer required by CancelQueryRequest" + }, + "smithy.api#documentation": "

The ARN (or the ID suffix of the ARN) of an event data store on which the specified\n query is running.

" + } + }, + "QueryId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the query that you want to cancel. The QueryId comes from the\n response of a StartQuery operation.

", + "smithy.api#required": {} + } + }, + "EventDataStoreOwnerAccountId": { + "target": "com.amazonaws.cloudtrail#AccountId", + "traits": { + "smithy.api#documentation": "

\nThe account ID of the event data store owner.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#CancelQueryResponse": { + "type": "structure", + "members": { + "QueryId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the canceled query.

", + "smithy.api#required": {} + } + }, + "QueryStatus": { + "target": "com.amazonaws.cloudtrail#QueryStatus", + "traits": { + "smithy.api#documentation": "

Shows the status of a query after a CancelQuery request. Typically, the\n values shown are either RUNNING or CANCELLED.

", + "smithy.api#required": {} + } + }, + "EventDataStoreOwnerAccountId": { + "target": "com.amazonaws.cloudtrail#AccountId", + "traits": { + "smithy.api#documentation": "

\n The account ID of the event data store owner.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#CannotDelegateManagementAccountException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CannotDelegateManagementAccount", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the management account of an organization is registered as\n the CloudTrail delegated administrator.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#Channel": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.cloudtrail#ChannelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a channel.

" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#ChannelName", + "traits": { + "smithy.api#documentation": "

The name of the CloudTrail channel. For service-linked channels, the name is\n aws-service-channel/service-name/custom-suffix where\n service-name represents the name of the Amazon Web Services service that\n created the channel and custom-suffix represents the suffix created by the\n Amazon Web Services service.

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

Contains information about a returned CloudTrail channel.

" + } + }, + "com.amazonaws.cloudtrail#ChannelARNInvalidException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ChannelARNInvalid", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the specified value of ChannelARN is not\n valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#ChannelAlreadyExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ChannelAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

\n This exception is thrown when the provided channel already exists.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#ChannelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:]+$" + } + }, + "com.amazonaws.cloudtrail#ChannelExistsForEDSException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ChannelExistsForEDS", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the specified event data store cannot yet be deleted because it \n is in use by a channel.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#ChannelMaxLimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ChannelMaxLimitExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

\n This exception is thrown when the maximum number of channels limit is exceeded.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#ChannelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._\\-]+$" + } + }, + "com.amazonaws.cloudtrail#ChannelNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ChannelNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

This exception is thrown when CloudTrail cannot find the specified channel.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.cloudtrail#Channels": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#Channel" + } + }, + "com.amazonaws.cloudtrail#CloudTrailARNInvalidException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CloudTrailARNInvalid", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when an operation is called with an ARN that is not valid.

\n

The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

\n

The following is the format of an event data store ARN:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n

\n

The following is the format of a dashboard ARN: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash\n

\n

The following is the format of a channel ARN:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CloudTrailAccessNotEnabled", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see How to enable or disable trusted access in the Organizations User Guide and Prepare For Creating a Trail For Your Organization in the CloudTrail User Guide.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#CloudTrailInvalidClientTokenIdException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CloudTrailInvalidClientTokenId", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when a call results in the InvalidClientTokenId\n error code. This can occur when you are creating or updating a trail to send notifications\n to an Amazon SNS topic that is in a suspended Amazon Web Services account.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#CloudTrail_20131101": { + "type": "service", + "version": "2013-11-01", + "operations": [ + { + "target": "com.amazonaws.cloudtrail#AddTags" + }, + { + "target": "com.amazonaws.cloudtrail#CancelQuery" + }, + { + "target": "com.amazonaws.cloudtrail#CreateChannel" + }, + { + "target": "com.amazonaws.cloudtrail#CreateDashboard" + }, + { + "target": "com.amazonaws.cloudtrail#CreateEventDataStore" + }, + { + "target": "com.amazonaws.cloudtrail#CreateTrail" + }, + { + "target": "com.amazonaws.cloudtrail#DeleteChannel" + }, + { + "target": "com.amazonaws.cloudtrail#DeleteDashboard" + }, + { + "target": "com.amazonaws.cloudtrail#DeleteEventDataStore" + }, + { + "target": "com.amazonaws.cloudtrail#DeleteResourcePolicy" + }, + { + "target": "com.amazonaws.cloudtrail#DeleteTrail" + }, + { + "target": "com.amazonaws.cloudtrail#DeregisterOrganizationDelegatedAdmin" + }, + { + "target": "com.amazonaws.cloudtrail#DescribeQuery" + }, + { + "target": "com.amazonaws.cloudtrail#DescribeTrails" + }, + { + "target": "com.amazonaws.cloudtrail#DisableFederation" + }, + { + "target": "com.amazonaws.cloudtrail#EnableFederation" + }, + { + "target": "com.amazonaws.cloudtrail#GenerateQuery" + }, + { + "target": "com.amazonaws.cloudtrail#GetChannel" + }, + { + "target": "com.amazonaws.cloudtrail#GetDashboard" + }, + { + "target": "com.amazonaws.cloudtrail#GetEventConfiguration" + }, + { + "target": "com.amazonaws.cloudtrail#GetEventDataStore" + }, + { + "target": "com.amazonaws.cloudtrail#GetEventSelectors" + }, + { + "target": "com.amazonaws.cloudtrail#GetImport" + }, + { + "target": "com.amazonaws.cloudtrail#GetInsightSelectors" + }, + { + "target": "com.amazonaws.cloudtrail#GetQueryResults" + }, + { + "target": "com.amazonaws.cloudtrail#GetResourcePolicy" + }, + { + "target": "com.amazonaws.cloudtrail#GetTrail" + }, + { + "target": "com.amazonaws.cloudtrail#GetTrailStatus" + }, + { + "target": "com.amazonaws.cloudtrail#ListChannels" + }, + { + "target": "com.amazonaws.cloudtrail#ListDashboards" + }, + { + "target": "com.amazonaws.cloudtrail#ListEventDataStores" + }, + { + "target": "com.amazonaws.cloudtrail#ListImportFailures" + }, + { + "target": "com.amazonaws.cloudtrail#ListImports" + }, + { + "target": "com.amazonaws.cloudtrail#ListInsightsData" + }, + { + "target": "com.amazonaws.cloudtrail#ListInsightsMetricData" + }, + { + "target": "com.amazonaws.cloudtrail#ListPublicKeys" + }, + { + "target": "com.amazonaws.cloudtrail#ListQueries" + }, + { + "target": "com.amazonaws.cloudtrail#ListTags" + }, + { + "target": "com.amazonaws.cloudtrail#ListTrails" + }, + { + "target": "com.amazonaws.cloudtrail#LookupEvents" + }, + { + "target": "com.amazonaws.cloudtrail#PutEventConfiguration" + }, + { + "target": "com.amazonaws.cloudtrail#PutEventSelectors" + }, + { + "target": "com.amazonaws.cloudtrail#PutInsightSelectors" + }, + { + "target": "com.amazonaws.cloudtrail#PutResourcePolicy" + }, + { + "target": "com.amazonaws.cloudtrail#RegisterOrganizationDelegatedAdmin" + }, + { + "target": "com.amazonaws.cloudtrail#RemoveTags" + }, + { + "target": "com.amazonaws.cloudtrail#RestoreEventDataStore" + }, + { + "target": "com.amazonaws.cloudtrail#SearchSampleQueries" + }, + { + "target": "com.amazonaws.cloudtrail#StartDashboardRefresh" + }, + { + "target": "com.amazonaws.cloudtrail#StartEventDataStoreIngestion" + }, + { + "target": "com.amazonaws.cloudtrail#StartImport" + }, + { + "target": "com.amazonaws.cloudtrail#StartLogging" + }, + { + "target": "com.amazonaws.cloudtrail#StartQuery" + }, + { + "target": "com.amazonaws.cloudtrail#StopEventDataStoreIngestion" + }, + { + "target": "com.amazonaws.cloudtrail#StopImport" + }, + { + "target": "com.amazonaws.cloudtrail#StopLogging" + }, + { + "target": "com.amazonaws.cloudtrail#UpdateChannel" + }, + { + "target": "com.amazonaws.cloudtrail#UpdateDashboard" + }, + { + "target": "com.amazonaws.cloudtrail#UpdateEventDataStore" + }, + { + "target": "com.amazonaws.cloudtrail#UpdateTrail" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "CloudTrail", + "arnNamespace": "cloudtrail", + "cloudFormationName": "CloudTrail", + "cloudTrailEventSource": "cloudtrail.amazonaws.com", + "endpointPrefix": "cloudtrail" + }, + "aws.auth#sigv4": { + "name": "cloudtrail" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "CloudTrail\n

This is the CloudTrail API Reference. It provides descriptions of actions, data\n types, common parameters, and common errors for CloudTrail.

\n

CloudTrail is a web service that records Amazon Web Services API calls for your\n Amazon Web Services account and delivers log files to an Amazon S3 bucket. The\n recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response\n elements returned by the service.

\n \n

As an alternative to the API, you can use one of the Amazon Web Services SDKs, which\n consist of libraries and sample code for various programming languages and platforms\n (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide programmatic access to CloudTrail. For example, the SDKs handle cryptographically signing requests,\n managing errors, and retrying requests automatically. For more information about the\n Amazon Web Services SDKs, including how to download and install them, see Tools to Build on Amazon Web Services.

\n \n

See the CloudTrail\n User Guide for information about the data that is included with each Amazon Web Services API call listed in the log files.

", + "smithy.api#title": "AWS CloudTrail", + "smithy.api#xmlNamespace": { + "uri": "http://cloudtrail.amazonaws.com/doc/2013-11-01/" + }, + "smithy.rules#endpointBdd": { + "version": "1.1", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "string" + }, + "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" + } + }, + "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 + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-gov-east-1" + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-gov-west-1" + ] + } + ], + "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://cloudtrail-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "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://cloudtrail.us-gov-east-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://cloudtrail.us-gov-west-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://cloudtrail-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "https://cloudtrail.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "https://cloudtrail.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "root": 2, + "nodeCount": 15, + "nodes": "/////wAAAAH/////AAAAAAAAAA4AAAADAAAAAQAAAAQF9eENAAAAAgAAAAUF9eENAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEMAAAABQX14QoF9eELAAAABAAAAAwAAAAJAAAABgAAAAoF9eEJAAAABwX14QYAAAALAAAACAX14QcF9eEIAAAABQAAAA0F9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAAPAAAABAX14QIF9eED" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "string" + }, + "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" + } + }, + "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": [ + { + "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" + }, + { + "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://cloudtrail-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "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 + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-gov-east-1" + ] + } + ], + "endpoint": { + "url": "https://cloudtrail.us-gov-east-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-gov-west-1" + ] + } + ], + "endpoint": { + "url": "https://cloudtrail.us-gov-west-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://cloudtrail-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "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": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cloudtrail.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "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://cloudtrail.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudtrail-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.cloudtrail#CloudWatchLogsDeliveryUnavailableException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CloudWatchLogsDeliveryUnavailable", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Cannot set a CloudWatch Logs delivery for this Region.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#ConcurrentModificationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ConcurrentModification", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

\n You are trying to update a resource when another request is in progress. Allow sufficient wait time for the previous request to complete, then retry your request. \n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ConflictException", + "httpResponseCode": 409 + }, + "smithy.api#documentation": "

This exception is thrown when the specified resource is not ready for an operation. This\n can occur when you try to run an operation on a resource before CloudTrail has time\n to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the\n operation again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.cloudtrail#ContextKeySelector": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.cloudtrail#Type", + "traits": { + "smithy.api#documentation": "

Specifies the type of the event record field in ContextKeySelector. Valid values include RequestContext, TagContext.

", + "smithy.api#required": {} + } + }, + "Equals": { + "target": "com.amazonaws.cloudtrail#OperatorTargetList", + "traits": { + "smithy.api#documentation": "

A list of keys defined by Type to be included in CloudTrail enriched events.

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

An object that contains information types to be included in CloudTrail enriched events.

" + } + }, + "com.amazonaws.cloudtrail#ContextKeySelectors": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#ContextKeySelector" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.cloudtrail#CreateChannel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#CreateChannelRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#CreateChannelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ChannelAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#ChannelMaxLimitExceededException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidSourceException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTagParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#TagsLimitExceededException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a channel for CloudTrail to ingest events from a partner or external source. \n After you create a channel, a CloudTrail Lake event data store can log events \n from the partner or source that you specify.

" + } + }, + "com.amazonaws.cloudtrail#CreateChannelRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#ChannelName", + "traits": { + "smithy.api#documentation": "

The name of the channel.

", + "smithy.api#required": {} + } + }, + "Source": { + "target": "com.amazonaws.cloudtrail#Source", + "traits": { + "smithy.api#documentation": "

The name of the partner or external event source. You cannot change this name after you create the \n channel. A maximum of one channel is allowed per source.

\n

\n A source can be either Custom for all valid non-Amazon Web Services\n events, or the name of a partner event source. For information about the source names for available partners, see Additional information about integration partners in the CloudTrail User Guide.\n

", + "smithy.api#required": {} + } + }, + "Destinations": { + "target": "com.amazonaws.cloudtrail#Destinations", + "traits": { + "smithy.api#documentation": "

One or more event data stores to which events arriving through a channel will be logged.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.cloudtrail#TagsList" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#CreateChannelResponse": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.cloudtrail#ChannelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the new channel.

" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#ChannelName", + "traits": { + "smithy.api#documentation": "

The name of the new channel.

" + } + }, + "Source": { + "target": "com.amazonaws.cloudtrail#Source", + "traits": { + "smithy.api#documentation": "

The partner or external event source name.

" + } + }, + "Destinations": { + "target": "com.amazonaws.cloudtrail#Destinations", + "traits": { + "smithy.api#documentation": "

The event data stores that log the events arriving through the channel.

" + } + }, + "Tags": { + "target": "com.amazonaws.cloudtrail#TagsList" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#CreateDashboard": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#CreateDashboardRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#CreateDashboardResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidQueryStatementException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTagParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

\nCreates a custom dashboard or the Highlights dashboard.\n

\n \n

\n CloudTrail runs queries to populate the dashboard's widgets during a manual or scheduled refresh. CloudTrail must be granted permissions to run the StartQuery operation on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to each event data store. For more information, \n see Example: Allow CloudTrail to run queries to populate a dashboard in the CloudTrail User Guide.\n

\n

\n To set a refresh schedule, CloudTrail must be granted permissions to run the StartDashboardRefresh operation to refresh the dashboard on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to the dashboard. For more information, \n see \n Resource-based policy example for a dashboard in the CloudTrail User Guide.\n

\n

For more information about dashboards, see CloudTrail Lake dashboards in the CloudTrail User Guide.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#CreateDashboardRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#DashboardName", + "traits": { + "smithy.api#documentation": "

\n The name of the dashboard. The name must be unique to your account.\n

\n

To create the Highlights dashboard, the name must be AWSCloudTrail-Highlights.

", + "smithy.api#required": {} + } + }, + "RefreshSchedule": { + "target": "com.amazonaws.cloudtrail#RefreshSchedule", + "traits": { + "smithy.api#documentation": "

\n The refresh schedule configuration for the dashboard.\n

\n

To create the Highlights dashboard, you must set a refresh schedule and set the Status to ENABLED. The Unit for the refresh schedule must be HOURS \n and the Value must be 6.

" + } + }, + "TagsList": { + "target": "com.amazonaws.cloudtrail#TagsList" + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", + "traits": { + "smithy.api#documentation": "

\n Specifies whether termination protection is enabled for the dashboard. If termination protection is enabled, you cannot delete the dashboard until termination protection is disabled.\n

" + } + }, + "Widgets": { + "target": "com.amazonaws.cloudtrail#RequestWidgetList", + "traits": { + "smithy.api#documentation": "

\nAn array of widgets for a custom dashboard. A custom dashboard can have a maximum of ten widgets.\n

\n

You do not need to specify widgets for the Highlights dashboard.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#CreateDashboardResponse": { + "type": "structure", + "members": { + "DashboardArn": { + "target": "com.amazonaws.cloudtrail#DashboardArn", + "traits": { + "smithy.api#documentation": "

\nThe ARN for the dashboard.\n

" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#DashboardName", + "traits": { + "smithy.api#documentation": "

\nThe name of the dashboard.\n

" + } + }, + "Type": { + "target": "com.amazonaws.cloudtrail#DashboardType", + "traits": { + "smithy.api#documentation": "

\nThe dashboard type.\n

" + } + }, + "Widgets": { + "target": "com.amazonaws.cloudtrail#WidgetList", + "traits": { + "smithy.api#documentation": "

\nAn array of widgets for the dashboard.\n

" + } + }, + "TagsList": { + "target": "com.amazonaws.cloudtrail#TagsList" + }, + "RefreshSchedule": { + "target": "com.amazonaws.cloudtrail#RefreshSchedule", + "traits": { + "smithy.api#documentation": "

\nThe refresh schedule for the dashboard, if configured.\n

" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", + "traits": { + "smithy.api#documentation": "

\n Indicates whether termination protection is enabled for the dashboard.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#CreateEventDataStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#CreateEventDataStoreRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#CreateEventDataStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreMaxLimitExceededException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventSelectorsException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidKmsKeyIdException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTagParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#KmsException" + }, + { + "target": "com.amazonaws.cloudtrail#KmsKeyNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + }, + { + "target": "com.amazonaws.cloudtrail#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new event data store.

" + } + }, + "com.amazonaws.cloudtrail#CreateEventDataStoreRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#EventDataStoreName", + "traits": { + "smithy.api#documentation": "

The name of the event data store.

", + "smithy.api#required": {} + } + }, + "AdvancedEventSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", + "traits": { + "smithy.api#documentation": "

The advanced event selectors to use to select the events for the data store. You can\n configure up to five advanced event selectors for each event data store.

\n

For more information about how to use advanced event selectors to log CloudTrail\n events, see Log events by using advanced event selectors in the CloudTrail User Guide.

\n

For more information about how to use advanced event selectors to include Config configuration items in your event data store, see Create an event data store for Config configuration\n items in the CloudTrail User Guide.

\n

For more information about how to use advanced event selectors to include events outside of Amazon Web Services events in your event data store, see Create an integration to log events from outside Amazon Web Services in the CloudTrail User Guide.

" + } + }, + "MultiRegionEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the event data store includes events from all Regions, or only from\n the Region in which the event data store is created.

" + } + }, + "OrganizationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether an event data store collects events logged for an organization in\n Organizations.

" + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.cloudtrail#RetentionPeriod", + "traits": { + "smithy.api#documentation": "

The retention period of the event data store, in days. If BillingMode is set to EXTENDABLE_RETENTION_PRICING, you can set a retention period of\n up to 3653 days, the equivalent of 10 years. If BillingMode is set to FIXED_RETENTION_PRICING, you can set a retention period of\n up to 2557 days, the equivalent of seven years.

\n

CloudTrail Lake determines whether to retain an event by checking if the eventTime \n of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events \n when the eventTime is older than 90 days.

\n \n

If you plan to copy trail events to this event data store, we recommend \n that you consider both the age of the events that you\n want to copy as well as how long you want to keep the copied events\n in your event data store. For example, if you copy trail events that are 5 years old \n and specify a retention period of 7 years, the event data store \n will retain those events for two years.

\n " + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", + "traits": { + "smithy.api#documentation": "

Specifies whether termination protection is enabled for the event data store. If\n termination protection is enabled, you cannot delete the event data store until termination\n protection is disabled.

" + } + }, + "TagsList": { + "target": "com.amazonaws.cloudtrail#TagsList" + }, + "KmsKeyId": { + "target": "com.amazonaws.cloudtrail#EventDataStoreKmsKeyId", + "traits": { + "smithy.api#documentation": "

Specifies the KMS key ID to use to encrypt the events delivered by\n CloudTrail. The value can be an alias name prefixed by alias/, a\n fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique\n identifier.

\n \n

Disabling or deleting the KMS key, or removing CloudTrail\n permissions on the key, prevents CloudTrail from logging events to the event data\n store, and prevents users from querying the data in the event data store that was\n encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you\n disable or delete a KMS key that you are using with an event data store,\n delete or back up your event data store.

\n \n

CloudTrail also supports KMS multi-Region keys. For more\n information about multi-Region keys, see Using multi-Region\n keys in the Key Management Service Developer Guide.

\n

Examples:

\n " + } + }, + "StartIngestion": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the event data store should start ingesting live events. The default is true.

" + } + }, + "BillingMode": { + "target": "com.amazonaws.cloudtrail#BillingMode", + "traits": { + "smithy.api#documentation": "

The billing mode for the event data store determines the cost for ingesting events and the default and maximum retention period for the event data store.

\n

The following are the possible values:

\n \n

The default value is EXTENDABLE_RETENTION_PRICING.

\n

For more information about CloudTrail pricing, \n see CloudTrail Pricing and \n Managing CloudTrail Lake costs.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#CreateEventDataStoreResponse": { + "type": "structure", + "members": { + "EventDataStoreArn": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN of the event data store.

" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#EventDataStoreName", + "traits": { + "smithy.api#documentation": "

The name of the event data store.

" + } + }, + "Status": { + "target": "com.amazonaws.cloudtrail#EventDataStoreStatus", + "traits": { + "smithy.api#documentation": "

The status of event data store creation.

" + } + }, + "AdvancedEventSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", + "traits": { + "smithy.api#documentation": "

The advanced event selectors that were used to select the events for the data\n store.

" + } + }, + "MultiRegionEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the event data store collects events from all Regions, or only from\n the Region in which it was created.

" + } + }, + "OrganizationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether an event data store is collecting logged events for an organization in\n Organizations.

" + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.cloudtrail#RetentionPeriod", + "traits": { + "smithy.api#documentation": "

The retention period of an event data store, in days.

" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether termination protection is enabled for the event data store.

" + } + }, + "TagsList": { + "target": "com.amazonaws.cloudtrail#TagsList" + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp that shows when the event data store was created.

" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp that shows when an event data store was updated, if applicable.\n UpdatedTimestamp is always either the same or newer than the time shown in\n CreatedTimestamp.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.cloudtrail#EventDataStoreKmsKeyId", + "traits": { + "smithy.api#documentation": "

Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.

\n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" + } + }, + "BillingMode": { + "target": "com.amazonaws.cloudtrail#BillingMode", + "traits": { + "smithy.api#documentation": "

The billing mode for the event data store.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#CreateTrail": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#CreateTrailRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#CreateTrailResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + }, + { + "target": "com.amazonaws.cloudtrail#CloudTrailInvalidClientTokenIdException" + }, + { + "target": "com.amazonaws.cloudtrail#CloudWatchLogsDeliveryUnavailableException" + }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientS3BucketPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientSnsTopicPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidCloudWatchLogsLogGroupArnException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidCloudWatchLogsRoleArnException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidKmsKeyIdException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidS3BucketNameException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidS3PrefixException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidSnsTopicNameException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTagParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#KmsException" + }, + { + "target": "com.amazonaws.cloudtrail#KmsKeyDisabledException" + }, + { + "target": "com.amazonaws.cloudtrail#KmsKeyNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#MaximumNumberOfTrailsExceededException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + }, + { + "target": "com.amazonaws.cloudtrail#S3BucketDoesNotExistException" + }, + { + "target": "com.amazonaws.cloudtrail#TagsLimitExceededException" + }, + { + "target": "com.amazonaws.cloudtrail#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailNotProvidedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#CreateTrailRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the trail. The name must meet the following requirements:

\n ", + "smithy.api#required": {} + } + }, + "S3BucketName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the Amazon S3 bucket designated for publishing log files. \n For information about bucket naming rules, see Bucket naming rules \n in the Amazon Simple Storage Service User Guide.\n

", + "smithy.api#required": {} + } + }, + "S3KeyPrefix": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200\n characters.

" + } + }, + "SnsTopicName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name or ARN of the Amazon SNS topic defined for notification of log file\n delivery. The maximum length is 256 characters.

" + } + }, + "IncludeGlobalServiceEvents": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail is publishing events from global services such as IAM to the\n log files.

" + } + }, + "IsMultiRegionTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail is created in the current Region or in all Regions. The\n default is false, which creates a trail only in the Region where you are signed in. As a\n best practice, consider creating trails that log events in all Regions.

" + } + }, + "EnableLogFileValidation": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether log file integrity validation is enabled. The default is false.

\n \n

When you disable log file integrity validation, the chain of digest files is broken\n after one hour. CloudTrail does not create digest files for log files that were\n delivered during a period in which log file integrity validation was disabled. For\n example, if you enable log file integrity validation at noon on January 1, disable it at\n noon on January 2, and re-enable it at noon on January 10, digest files will not be\n created for the log files delivered from noon on January 2 to noon on January 10. The\n same applies whenever you stop CloudTrail logging or delete a trail.

\n " + } + }, + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that\n represents the log group to which CloudTrail logs will be delivered. You must use a\n log group that exists in your account.

\n

Not required unless you specify CloudWatchLogsRoleArn.

" + } + }, + "CloudWatchLogsRoleArn": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's\n log group. You must use a role that exists in your account.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the KMS key ID to use to encrypt the logs and digest files delivered by CloudTrail. The value can be an alias name prefixed by alias/, a fully\n specified ARN to an alias, a fully specified ARN to a key, or a globally unique\n identifier.

\n

CloudTrail also supports KMS multi-Region keys. For more\n information about multi-Region keys, see Using multi-Region\n keys in the Key Management Service Developer Guide.

\n

Examples:

\n " + } + }, + "IsOrganizationTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail is created for all accounts in an organization in Organizations, or only for the current Amazon Web Services account. The default is false,\n and cannot be true unless the call is made on behalf of an Amazon Web Services account that\n is the management account or delegated administrator account for an organization in Organizations.

" + } + }, + "TagsList": { + "target": "com.amazonaws.cloudtrail#TagsList" + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the settings for each trail.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#CreateTrailResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the trail.

" + } + }, + "S3BucketName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the Amazon S3 bucket designated for publishing log\n files.

" + } + }, + "S3KeyPrefix": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.

" + } + }, + "SnsTopicName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

This field is no longer in use. Use SnsTopicARN.

" + } + }, + "SnsTopicARN": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send\n notifications when log files are delivered. The format of a topic ARN is:

\n

\n arn:aws:sns:us-east-2:123456789012:MyTopic\n

" + } + }, + "IncludeGlobalServiceEvents": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail is publishing events from global services such as IAM to the\n log files.

" + } + }, + "IsMultiRegionTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail exists in one Region or in all Regions.

" + } + }, + "TrailARN": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the ARN of the trail that was created. The format of a trail ARN is:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

" + } + }, + "LogFileValidationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether log file integrity validation is enabled.

" + } + }, + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail\n logs will be delivered.

" + } + }, + "CloudWatchLogsRoleArn": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's\n log group.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.

\n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" + } + }, + "IsOrganizationTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail is an organization trail.

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

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#DashboardArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:]+$" + } + }, + "com.amazonaws.cloudtrail#DashboardDetail": { + "type": "structure", + "members": { + "DashboardArn": { + "target": "com.amazonaws.cloudtrail#DashboardArn", + "traits": { + "smithy.api#documentation": "

\nThe ARN for the dashboard.\n

" + } + }, + "Type": { + "target": "com.amazonaws.cloudtrail#DashboardType", + "traits": { + "smithy.api#documentation": "

\nThe type of dashboard.\n

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

\nProvides information about a CloudTrail Lake dashboard.\n

" + } + }, + "com.amazonaws.cloudtrail#DashboardName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\-]+$" + } + }, + "com.amazonaws.cloudtrail#DashboardStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } + } + }, + "com.amazonaws.cloudtrail#DashboardType": { + "type": "enum", + "members": { + "MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANAGED" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + } + } + }, + "com.amazonaws.cloudtrail#Dashboards": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#DashboardDetail" + } + }, + "com.amazonaws.cloudtrail#DataResource": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The resource type in which you want to log data events. You can specify the following\n basic event selector resource types:

\n \n

Additional resource types are available through advanced\n event selectors. For more\n information, see AdvancedEventSelector.

" + } + }, + "Values": { + "target": "com.amazonaws.cloudtrail#DataResourceValues", + "traits": { + "smithy.api#documentation": "

An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified\n resource type.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

You can configure the DataResource in an EventSelector to log data events for the following three resource types:

\n \n

To log data events for all other resource types including objects stored in \n directory buckets, you must use AdvancedEventSelectors. You must also \n use AdvancedEventSelectors if you want to filter on the eventName field.

\n

Configure the DataResource to specify the resource type and resource ARNs for which you want to log data events.

\n \n

The total number of allowed data resources is 250. This number can be distributed\n between 1 and 5 event selectors, but the total cannot exceed 250 across all\n selectors for the trail.

\n \n

The following example demonstrates how logging works when you configure logging of all\n data events for a general purpose bucket named amzn-s3-demo-bucket1. In this example, the CloudTrail user specified an empty prefix, and the option to log both Read\n and Write data events.

\n
    \n
  1. \n

    A user uploads an image file to amzn-s3-demo-bucket1.

    \n
    2. \n
  2. \n

    The PutObject API operation is an Amazon S3 object-level API.\n It is recorded as a data event in CloudTrail. Because the CloudTrail\n user specified an S3 bucket with an empty prefix, events that occur on any object in\n that bucket are logged. The trail processes and logs the event.

    \n
    3. \n
  3. \n

    A user uploads an object to an Amazon S3 bucket named\n arn:aws:s3:::amzn-s3-demo-bucket1.

    \n
    4. \n
  4. \n

    The PutObject API operation occurred for an object in an S3 bucket\n that the CloudTrail user didn't specify for the trail. The trail doesn’t log\n the event.

    \n
    5. \n
\n

The following example demonstrates how logging works when you configure logging of\n Lambda data events for a Lambda function named\n MyLambdaFunction, but not for all Lambda\n functions.

\n
    \n
  1. \n

    A user runs a script that includes a call to the\n MyLambdaFunction function and the\n MyOtherLambdaFunction function.

    \n
    2. \n
  2. \n

    The Invoke API operation on MyLambdaFunction is\n an Lambda API. It is recorded as a data event in CloudTrail.\n Because the CloudTrail user specified logging data events for\n MyLambdaFunction, any invocations of that function are\n logged. The trail processes and logs the event.

    \n
    3. \n
  3. \n

    The Invoke API operation on\n MyOtherLambdaFunction is an Lambda API. Because\n the CloudTrail user did not specify logging data events for all Lambda functions, the Invoke operation for\n MyOtherLambdaFunction does not match the function specified\n for the trail. The trail doesn’t log the event.

    \n
    4. \n
" + } + }, + "com.amazonaws.cloudtrail#DataResourceValues": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#String" + } + }, + "com.amazonaws.cloudtrail#DataResources": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#DataResource" + } + }, + "com.amazonaws.cloudtrail#Date": { + "type": "timestamp" + }, + "com.amazonaws.cloudtrail#DelegatedAdminAccountLimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DelegatedAdminAccountLimitExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the maximum number of CloudTrail delegated\n administrators is reached.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#DeleteChannel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#DeleteChannelRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#DeleteChannelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ChannelARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#ChannelNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a channel.

" + } + }, + "com.amazonaws.cloudtrail#DeleteChannelRequest": { + "type": "structure", + "members": { + "Channel": { + "target": "com.amazonaws.cloudtrail#ChannelArn", + "traits": { + "smithy.api#documentation": "

The ARN or the UUID value of the channel that you want to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#DeleteChannelResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#DeleteDashboard": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#DeleteDashboardRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#DeleteDashboardResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

\nDeletes the specified dashboard. You cannot delete a dashboard that has termination protection enabled.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#DeleteDashboardRequest": { + "type": "structure", + "members": { + "DashboardId": { + "target": "com.amazonaws.cloudtrail#DashboardArn", + "traits": { + "smithy.api#documentation": "

\nThe name or ARN for the dashboard.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#DeleteDashboardResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#DeleteEventDataStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#DeleteEventDataStoreRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#DeleteEventDataStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ChannelExistsForEDSException" + }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreFederationEnabledException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreHasOngoingImportException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreTerminationProtectedException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disables the event data store specified by EventDataStore, which accepts an\n event data store ARN. After you run DeleteEventDataStore, the event data store\n enters a PENDING_DELETION state, and is automatically deleted after a wait\n period of seven days. TerminationProtectionEnabled must be set to\n False on the event data store and the FederationStatus must be DISABLED. \n You cannot delete an event data store if TerminationProtectionEnabled \n is True or the FederationStatus is ENABLED.

\n

After you run DeleteEventDataStore on an event data store, you cannot run\n ListQueries, DescribeQuery, or GetQueryResults on\n queries that are using an event data store in a PENDING_DELETION state. An\n event data store in the PENDING_DELETION state does not incur costs.

" + } + }, + "com.amazonaws.cloudtrail#DeleteEventDataStoreRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN (or the ID suffix of the ARN) of the event data store to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#DeleteEventDataStoreResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#DeleteResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#DeleteResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#DeleteResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceARNNotValidException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourcePolicyNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Deletes the resource-based policy attached to the CloudTrail event data store, dashboard, or channel.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#DeleteResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.cloudtrail#ResourceArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the CloudTrail event data store, dashboard, or channel you're deleting the resource-based policy from.

\n

Example event data store ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n

\n

Example dashboard ARN format: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash\n

\n

Example channel ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#DeleteResourcePolicyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#DeleteTrail": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#DeleteTrailRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#DeleteTrailResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidHomeRegionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a trail. This operation must be called from the Region in which the trail was\n created. DeleteTrail cannot be called on the shadow trails (replicated trails\n in other Regions) of a trail that is enabled in all Regions.

\n \n

\n While deleting a CloudTrail trail is an irreversible action, CloudTrail does not\n delete log files in the Amazon S3 bucket for that trail, the Amazon S3 bucket itself, or the\n CloudWatchlog group to which the trail delivers events. Deleting a multi-Region trail\n will stop logging of events in all Amazon Web Services Regions enabled in your Amazon Web Services account. Deleting a\n single-Region trail will stop logging of events in that Region only. It will not stop\n logging of events in other Regions even if the trails in those other Regions have\n identical names to the deleted trail.\n

\n

For information about account closure and deletion of CloudTrail trails, see https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-account-closure.html.

\n ", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#DeleteTrailRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name or the CloudTrail ARN of the trail to be deleted. The\n following is the format of a trail ARN.\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

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

The request that specifies the name of a trail to delete.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#DeleteTrailResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#DeliveryS3Uri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?$" + } + }, + "com.amazonaws.cloudtrail#DeliveryStatus": { + "type": "enum", + "members": { + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "FAILED_SIGNING_FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_SIGNING_FILE" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "RESOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_NOT_FOUND" + } + }, + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCESS_DENIED" + } + }, + "ACCESS_DENIED_SIGNING_FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCESS_DENIED_SIGNING_FILE" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN" + } + } + } + }, + "com.amazonaws.cloudtrail#DeregisterOrganizationDelegatedAdmin": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#DeregisterOrganizationDelegatedAdminRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#DeregisterOrganizationDelegatedAdminResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#AccountNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#AccountNotRegisteredException" + }, + { + "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationManagementAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes CloudTrail delegated administrator permissions from a member account in\n an organization.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#DeregisterOrganizationDelegatedAdminRequest": { + "type": "structure", + "members": { + "DelegatedAdminAccountId": { + "target": "com.amazonaws.cloudtrail#AccountId", + "traits": { + "smithy.api#documentation": "

A delegated administrator account ID. This is a member account in an organization that\n is currently designated as a delegated administrator.

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

Removes CloudTrail delegated administrator permissions from a specified member\n account in an organization that is currently designated as a delegated\n administrator.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#DeregisterOrganizationDelegatedAdminResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Returns the following response if successful. Otherwise, returns an error.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#DescribeQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#DescribeQueryRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#DescribeQueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#QueryIdNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns metadata about a query, including query run time in milliseconds, number of\n events scanned and matched, and query status. If the query results were delivered to an S3 bucket, \n the response also provides the S3 URI and the delivery status.

\n

You must specify either QueryId or QueryAlias. Specifying the QueryAlias parameter \n returns information about the last query run for the alias. You can provide \n RefreshId along with QueryAlias to view the query results \n of a dashboard query for the specified RefreshId.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#DescribeQueryRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#deprecated": { + "message": "EventDataStore is no longer required by DescribeQueryRequest" + }, + "smithy.api#documentation": "

The ARN (or the ID suffix of the ARN) of an event data store on which the specified\n query was run.

" + } + }, + "QueryId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The query ID.

" + } + }, + "QueryAlias": { + "target": "com.amazonaws.cloudtrail#QueryAlias", + "traits": { + "smithy.api#documentation": "

\n The alias that identifies a query template.\n

" + } + }, + "RefreshId": { + "target": "com.amazonaws.cloudtrail#RefreshId", + "traits": { + "smithy.api#documentation": "

\nThe ID of the dashboard refresh.\n

" + } + }, + "EventDataStoreOwnerAccountId": { + "target": "com.amazonaws.cloudtrail#AccountId", + "traits": { + "smithy.api#documentation": "

\nThe account ID of the event data store owner.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#DescribeQueryResponse": { + "type": "structure", + "members": { + "QueryId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the query.

" + } + }, + "QueryString": { + "target": "com.amazonaws.cloudtrail#QueryStatement", + "traits": { + "smithy.api#documentation": "

The SQL code of a query.

" + } + }, + "QueryStatus": { + "target": "com.amazonaws.cloudtrail#QueryStatus", + "traits": { + "smithy.api#documentation": "

The status of a query. Values for QueryStatus include QUEUED,\n RUNNING, FINISHED, FAILED,\n TIMED_OUT, or CANCELLED\n

" + } + }, + "QueryStatistics": { + "target": "com.amazonaws.cloudtrail#QueryStatisticsForDescribeQuery", + "traits": { + "smithy.api#documentation": "

Metadata about a query, including the number of events that were matched, the total\n number of events scanned, the query run time in milliseconds, and the query's creation\n time.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The error message returned if a query failed.

" + } + }, + "DeliveryS3Uri": { + "target": "com.amazonaws.cloudtrail#DeliveryS3Uri", + "traits": { + "smithy.api#documentation": "

The URI for the S3 bucket where CloudTrail delivered query results, if\n applicable.

" + } + }, + "DeliveryStatus": { + "target": "com.amazonaws.cloudtrail#DeliveryStatus", + "traits": { + "smithy.api#documentation": "

The delivery status.

" + } + }, + "Prompt": { + "target": "com.amazonaws.cloudtrail#Prompt", + "traits": { + "smithy.api#documentation": "

\n The prompt used for a generated query. For information about generated queries, see \n Create CloudTrail Lake queries from natural language prompts \n in the CloudTrail user guide.\n

" + } + }, + "EventDataStoreOwnerAccountId": { + "target": "com.amazonaws.cloudtrail#AccountId", + "traits": { + "smithy.api#documentation": "

\n The account ID of the event data store owner.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#DescribeTrails": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#DescribeTrailsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#DescribeTrailsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves settings for one or more trails associated with the current Region for your\n account.

", + "smithy.api#idempotent": {}, + "smithy.test#smokeTests": [ + { + "id": "DescribeTrailsSuccess", + "params": {}, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] + } + }, + "com.amazonaws.cloudtrail#DescribeTrailsRequest": { + "type": "structure", + "members": { + "trailNameList": { + "target": "com.amazonaws.cloudtrail#TrailNameList", + "traits": { + "smithy.api#documentation": "

Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The\n format of a trail ARN is:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

\n

If an empty list is specified, information for the trail in the current Region is\n returned.

\n \n \n

If one or more trail names are specified, information is returned only if the names\n match the names of trails belonging only to the current Region and current account. To\n return information about a trail in another Region, you must specify its trail\n ARN.

\n " + } + }, + "includeShadowTrails": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to include shadow trails in the response. A shadow trail is the\n replication in a Region of a trail that was created in a different Region, or in the case\n of an organization trail, the replication of an organization trail in member accounts. If\n you do not include shadow trails, organization trails in a member account and Region\n replication trails will not be returned. The default is true.

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

Returns information about the trail.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#DescribeTrailsResponse": { + "type": "structure", + "members": { + "trailList": { + "target": "com.amazonaws.cloudtrail#TrailList", + "traits": { + "smithy.api#documentation": "

The list of trail objects. Trail objects with string values are only returned if values\n for the objects exist in a trail's configuration. For example, SNSTopicName\n and SNSTopicARN are only returned in results if a trail is configured to send\n SNS notifications. Similarly, KMSKeyId only appears in results if a trail's\n log files are encrypted with KMS\n customer managed keys.

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

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#Destination": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.cloudtrail#DestinationType", + "traits": { + "smithy.api#documentation": "

The type of destination for events arriving from a channel. For channels used for a CloudTrail Lake integration, the value is EVENT_DATA_STORE. For service-linked channels, \n the value is AWS_SERVICE.

", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.cloudtrail#Location", + "traits": { + "smithy.api#documentation": "

For channels used for a CloudTrail Lake integration, the location is the ARN of an event data store that receives events from a channel. \n For service-linked channels, the location is the name of the Amazon Web Services service.

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

Contains information about the destination receiving events.

" + } + }, + "com.amazonaws.cloudtrail#DestinationType": { + "type": "enum", + "members": { + "EVENT_DATA_STORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVENT_DATA_STORE" + } + }, + "AWS_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_SERVICE" + } + } + } + }, + "com.amazonaws.cloudtrail#Destinations": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#Destination" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.cloudtrail#DisableFederation": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#DisableFederationRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#DisableFederationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + }, + { + "target": "com.amazonaws.cloudtrail#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Disables Lake query federation on the specified event data store. When you disable federation, CloudTrail disables \n the integration with Glue, Lake Formation, and Amazon Athena. \n After disabling Lake query federation, you can no longer query your event data in Amazon Athena.

\n

No CloudTrail Lake data is deleted when you disable federation and you can continue to run queries in CloudTrail Lake.

" + } + }, + "com.amazonaws.cloudtrail#DisableFederationRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

\n The ARN (or ID suffix of the ARN) of the event data store for which you want to disable Lake query federation.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#DisableFederationResponse": { + "type": "structure", + "members": { + "EventDataStoreArn": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

\n The ARN of the event data store for which you disabled Lake query federation.\n

" + } + }, + "FederationStatus": { + "target": "com.amazonaws.cloudtrail#FederationStatus", + "traits": { + "smithy.api#documentation": "

\n The federation status.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#Double": { + "type": "double" + }, + "com.amazonaws.cloudtrail#EnableFederation": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#EnableFederationRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#EnableFederationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + }, + { + "target": "com.amazonaws.cloudtrail#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreFederationEnabledException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Enables Lake query federation on the specified event data store. Federating an event data store lets you view the metadata associated with the event data store in the Glue \n Data Catalog and run \n SQL queries against your event data using Amazon Athena. The table metadata stored in the Glue Data Catalog \n lets the Athena query engine know how to find, read, and process the data that you want to query.

\n

When you enable Lake query federation, CloudTrail\n creates a managed database named aws:cloudtrail (if the database doesn't already exist) and a managed federated table in\n the Glue Data Catalog. The event data store ID is used for the table name. CloudTrail registers the role ARN and event data store in\n Lake Formation, the service responsible for allowing fine-grained access control \n of the federated resources in the Glue Data Catalog.

\n

For more information about Lake query federation, see Federate an event data store.

" + } + }, + "com.amazonaws.cloudtrail#EnableFederationRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN (or ID suffix of the ARN) of the event data store for which you want to enable Lake query federation.

", + "smithy.api#required": {} + } + }, + "FederationRoleArn": { + "target": "com.amazonaws.cloudtrail#FederationRoleArn", + "traits": { + "smithy.api#documentation": "

\n The ARN of the federation role to use for the event data store. Amazon Web Services services like Lake Formation use this federation role to access data for the federated event \n data store. The federation role must exist in your account and provide the required minimum permissions.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#EnableFederationResponse": { + "type": "structure", + "members": { + "EventDataStoreArn": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

\n The ARN of the event data store for which you enabled Lake query federation.\n

" + } + }, + "FederationStatus": { + "target": "com.amazonaws.cloudtrail#FederationStatus", + "traits": { + "smithy.api#documentation": "

\n The federation status.\n

" + } + }, + "FederationRoleArn": { + "target": "com.amazonaws.cloudtrail#FederationRoleArn", + "traits": { + "smithy.api#documentation": "

\n The ARN of the federation role.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#ErrorCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^[\\w\\d\\s_.,\\-:\\[\\]]+$" + } + }, + "com.amazonaws.cloudtrail#ErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 1000 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.cloudtrail#Event": { + "type": "structure", + "members": { + "EventId": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The CloudTrail ID of the event returned.

" + } + }, + "EventName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The name of the event returned.

" + } + }, + "ReadOnly": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Information about whether the event is a write event or a read event.

" + } + }, + "AccessKeyId": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services access key ID that was used to sign the request. If the request\n was made with temporary security credentials, this is the access key ID of the temporary\n credentials.

" + } + }, + "EventTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The date and time of the event returned.

" + } + }, + "EventSource": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services service to which the request was made.

" + } + }, + "Username": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

A user name or role name of the requester that called the API in the event\n returned.

" + } + }, + "Resources": { + "target": "com.amazonaws.cloudtrail#ResourceList", + "traits": { + "smithy.api#documentation": "

A list of resources referenced by the event returned.

" + } + }, + "CloudTrailEvent": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

A JSON string that contains a representation of the event returned.

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

Contains information about an event that was returned by a lookup request. The result\n includes a representation of a CloudTrail event.

" + } + }, + "com.amazonaws.cloudtrail#EventCategory": { + "type": "enum", + "members": { + "Insight": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "insight" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the event category for which aggregation configuration is enabled. Valid value is Data.

" + } + }, + "com.amazonaws.cloudtrail#EventCategoryAggregation": { + "type": "enum", + "members": { + "Data": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Data" + } + } + } + }, + "com.amazonaws.cloudtrail#EventDataStore": { + "type": "structure", + "members": { + "EventDataStoreArn": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN of the event data store.

" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#EventDataStoreName", + "traits": { + "smithy.api#documentation": "

The name of the event data store.

" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", + "traits": { + "smithy.api#deprecated": { + "message": "TerminationProtectionEnabled is no longer returned by ListEventDataStores" + }, + "smithy.api#documentation": "

Indicates whether the event data store is protected from\n termination.

" + } + }, + "Status": { + "target": "com.amazonaws.cloudtrail#EventDataStoreStatus", + "traits": { + "smithy.api#deprecated": { + "message": "Status is no longer returned by ListEventDataStores" + }, + "smithy.api#documentation": "

The status of an event data store.

" + } + }, + "AdvancedEventSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", + "traits": { + "smithy.api#deprecated": { + "message": "AdvancedEventSelectors is no longer returned by ListEventDataStores" + }, + "smithy.api#documentation": "

The advanced event selectors that were used to select\n events for the data store.

" + } + }, + "MultiRegionEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#deprecated": { + "message": "MultiRegionEnabled is no longer returned by ListEventDataStores" + }, + "smithy.api#documentation": "

Indicates whether the event data store includes events\n from all Regions, or only from the Region in which it was created.

" + } + }, + "OrganizationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#deprecated": { + "message": "OrganizationEnabled is no longer returned by ListEventDataStores" + }, + "smithy.api#documentation": "

Indicates that an event data store is collecting logged\n events for an organization.

" + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.cloudtrail#RetentionPeriod", + "traits": { + "smithy.api#deprecated": { + "message": "RetentionPeriod is no longer returned by ListEventDataStores" + }, + "smithy.api#documentation": "

The retention period, in days.

" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#deprecated": { + "message": "CreatedTimestamp is no longer returned by ListEventDataStores" + }, + "smithy.api#documentation": "

The timestamp of the event data store's creation.

" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#deprecated": { + "message": "UpdatedTimestamp is no longer returned by ListEventDataStores" + }, + "smithy.api#documentation": "

The timestamp showing when an event data store was\n updated, if applicable. UpdatedTimestamp is always either the same or newer\n than the time shown in CreatedTimestamp.

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

A storage lake of event data against which you can run complex SQL-based queries. An\n event data store can include events that you have logged on your account. To select events for an event data\n store, use advanced event selectors.

" + } + }, + "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventDataStoreARNInvalid", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified event data store ARN is not valid or does not map to an event data store\n in your account.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#EventDataStoreAlreadyExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventDataStoreAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

An event data store with that name already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#EventDataStoreArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:]+$" + } + }, + "com.amazonaws.cloudtrail#EventDataStoreFederationEnabledException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventDataStoreFederationEnabled", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

\n You cannot delete the event data store because Lake query federation is enabled. To delete the event data store, run the DisableFederation operation to \n disable Lake query federation on the event data store. \n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#EventDataStoreHasOngoingImportException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventDataStoreHasOngoingImport", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when you try to update or delete an event data store that\n currently has an import in progress.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#EventDataStoreKmsKeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 350 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:]+$" + } + }, + "com.amazonaws.cloudtrail#EventDataStoreList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.cloudtrail#EventDataStoreMaxLimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventDataStoreMaxLimitExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Your account has used the maximum number of event data stores.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#EventDataStoreName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._\\-]+$" + } + }, + "com.amazonaws.cloudtrail#EventDataStoreNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventDataStoreNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified event data store was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.cloudtrail#EventDataStoreStatus": { + "type": "enum", + "members": { + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "PENDING_DELETION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_DELETION" + } + }, + "STARTING_INGESTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING_INGESTION" + } + }, + "STOPPING_INGESTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING_INGESTION" + } + }, + "STOPPED_INGESTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED_INGESTION" + } + } + } + }, + "com.amazonaws.cloudtrail#EventDataStoreTerminationProtectedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventDataStoreTerminationProtectedException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The event data store cannot be deleted because termination protection is enabled for\n it.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#EventDataStores": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#EventDataStore" + } + }, + "com.amazonaws.cloudtrail#EventName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^[A-Za-z0-9_]+$" + } + }, + "com.amazonaws.cloudtrail#EventSelector": { + "type": "structure", + "members": { + "ReadWriteType": { + "target": "com.amazonaws.cloudtrail#ReadWriteType", + "traits": { + "smithy.api#documentation": "

Specify if you want your trail to log read-only events, write-only events, or all. For\n example, the EC2 GetConsoleOutput is a read-only API operation and\n RunInstances is a write-only API operation.

\n

By default, the value is All.

" + } + }, + "IncludeManagementEvents": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specify if you want your event selector to include management events for your\n trail.

\n

For more information, see Management Events in the CloudTrail User\n Guide.

\n

By default, the value is true.

\n

The first copy of management events is free. You are charged for additional copies of\n management events that you are logging on any subsequent trail in the same Region. For more\n information about CloudTrail pricing, see CloudTrail Pricing.

" + } + }, + "DataResources": { + "target": "com.amazonaws.cloudtrail#DataResources", + "traits": { + "smithy.api#documentation": "

CloudTrail supports data event logging for Amazon S3 objects in standard S3 buckets, Lambda functions, and Amazon DynamoDB tables with basic event selectors.\n You can specify up to 250 resources for an individual event selector, but the total number\n of data resources cannot exceed 250 across all event selectors in a trail. This limit does\n not apply if you configure resource logging for all data events.

\n

For more information, see Data\n Events and Limits in CloudTrail in the CloudTrail User\n Guide.

\n \n

To log data events for all other resource types including objects stored in \n directory buckets, you must use AdvancedEventSelectors. You must also \n use AdvancedEventSelectors if you want to filter on the eventName field.

\n " + } + }, + "ExcludeManagementEventSources": { + "target": "com.amazonaws.cloudtrail#ExcludeManagementEventSources", + "traits": { + "smithy.api#documentation": "

An optional list of service event sources from which you do not want management events\n to be logged on your trail. In this release, the list can be empty (disables the filter),\n or it can filter out Key Management Service or Amazon RDS Data API events by\n containing kms.amazonaws.com or rdsdata.amazonaws.com. By\n default, ExcludeManagementEventSources is empty, and KMS and\n Amazon RDS Data API events are logged to your trail. You can exclude management\n event sources only in Regions that support the event source.

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

Use event selectors to further specify the management and data event settings for your\n trail. By default, trails created without specific event selectors will be configured to\n log all read and write management events, and no data events. When an event occurs in your\n account, CloudTrail evaluates the event selector for all trails. For each trail, if\n the event matches any event selector, the trail processes and logs the event. If the event\n doesn't match any event selector, the trail doesn't log the event.

\n

You can configure up to five event selectors for a trail.

\n

You cannot apply both event selectors and advanced event selectors to a trail.

" + } + }, + "com.amazonaws.cloudtrail#EventSelectors": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#EventSelector" + } + }, + "com.amazonaws.cloudtrail#EventSource": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[a-z0-9_-]+\\.amazonaws\\.com$" + } + }, + "com.amazonaws.cloudtrail#EventsList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#Event" + } + }, + "com.amazonaws.cloudtrail#ExcludeManagementEventSources": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#String" + } + }, + "com.amazonaws.cloudtrail#FederationRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 125 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:@=\\+,\\.]+$" + } + }, + "com.amazonaws.cloudtrail#FederationStatus": { + "type": "enum", + "members": { + "ENABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLING" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLING" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.cloudtrail#GenerateQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#GenerateQueryRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#GenerateQueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#GenerateResponseException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Generates a query from a natural language prompt. This operation uses generative artificial intelligence\n (generative AI) to produce a ready-to-use SQL query from the prompt.\n

\n

The prompt can be a question or a statement about the event data\n in your event data store. For example, you can enter prompts like \"What are my\n top errors in the past month?\" and “Give me a list of users that used SNS.”

\n

The prompt must be in English. For information about limitations, permissions, and supported Regions, see \n Create CloudTrail Lake queries from natural language prompts \n in the CloudTrail user guide.

\n \n

Do not include any personally identifying, confidential, or sensitive information\n in your prompts.

\n

This feature uses generative AI large language models (LLMs); we recommend double-checking the\n LLM response.

\n ", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#GenerateQueryRequest": { + "type": "structure", + "members": { + "EventDataStores": { + "target": "com.amazonaws.cloudtrail#EventDataStoreList", + "traits": { + "smithy.api#documentation": "

\n The ARN (or ID suffix of the ARN) of the event data store\n that you want to query. You can only specify one event data store.\n

", + "smithy.api#required": {} + } + }, + "Prompt": { + "target": "com.amazonaws.cloudtrail#Prompt", + "traits": { + "smithy.api#documentation": "

\n The prompt that you want to use to generate the query. The prompt must be in English. For example prompts, see \n Example prompts \n in the CloudTrail user guide.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#GenerateQueryResponse": { + "type": "structure", + "members": { + "QueryStatement": { + "target": "com.amazonaws.cloudtrail#QueryStatement", + "traits": { + "smithy.api#documentation": "

\n The SQL query statement generated from the prompt.\n

" + } + }, + "QueryAlias": { + "target": "com.amazonaws.cloudtrail#QueryAlias", + "traits": { + "smithy.api#documentation": "

\n An alias that identifies the prompt. When you run the StartQuery operation, you can pass in either the QueryAlias or \n QueryStatement parameter.\n

" + } + }, + "EventDataStoreOwnerAccountId": { + "target": "com.amazonaws.cloudtrail#AccountId", + "traits": { + "smithy.api#documentation": "

\n The account ID of the event data store owner.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#GenerateResponseException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "GenerateResponse", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

\n This exception is thrown when a valid query could not be generated for the provided prompt. \n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#GetChannel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#GetChannelRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#GetChannelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ChannelARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#ChannelNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specific channel.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#GetChannelRequest": { + "type": "structure", + "members": { + "Channel": { + "target": "com.amazonaws.cloudtrail#ChannelArn", + "traits": { + "smithy.api#documentation": "

The ARN or UUID of a channel.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#GetChannelResponse": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.cloudtrail#ChannelArn", + "traits": { + "smithy.api#documentation": "

The ARN of an channel returned by a GetChannel request.

" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#ChannelName", + "traits": { + "smithy.api#documentation": "

The name of the CloudTrail channel. For service-linked channels, the name is\n aws-service-channel/service-name/custom-suffix where\n service-name represents the name of the Amazon Web Services service that\n created the channel and custom-suffix represents the suffix generated by the\n Amazon Web Services service.

" + } + }, + "Source": { + "target": "com.amazonaws.cloudtrail#Source", + "traits": { + "smithy.api#documentation": "

The source for the CloudTrail channel.

" + } + }, + "SourceConfig": { + "target": "com.amazonaws.cloudtrail#SourceConfig", + "traits": { + "smithy.api#documentation": "

Provides information about the advanced event selectors configured for the channel, and\n whether the channel applies to all Regions or a single Region.

" + } + }, + "Destinations": { + "target": "com.amazonaws.cloudtrail#Destinations", + "traits": { + "smithy.api#documentation": "

The destinations for the channel. For channels created for integrations, \n the destinations are the event data stores that log events arriving through the channel. \n For service-linked channels, the destination is the Amazon Web Services service that created the service-linked channel to receive events.

" + } + }, + "IngestionStatus": { + "target": "com.amazonaws.cloudtrail#IngestionStatus", + "traits": { + "smithy.api#documentation": "

A table showing information about the most recent successful and failed attempts \n to ingest events.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#GetDashboard": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#GetDashboardRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#GetDashboardResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

\nReturns the specified dashboard.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#GetDashboardRequest": { + "type": "structure", + "members": { + "DashboardId": { + "target": "com.amazonaws.cloudtrail#DashboardArn", + "traits": { + "smithy.api#documentation": "

\nThe name or ARN for the dashboard.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#GetDashboardResponse": { + "type": "structure", + "members": { + "DashboardArn": { + "target": "com.amazonaws.cloudtrail#DashboardArn", + "traits": { + "smithy.api#documentation": "

\n The ARN for the dashboard.\n

" + } + }, + "Type": { + "target": "com.amazonaws.cloudtrail#DashboardType", + "traits": { + "smithy.api#documentation": "

\nThe type of dashboard.\n

" + } + }, + "Status": { + "target": "com.amazonaws.cloudtrail#DashboardStatus", + "traits": { + "smithy.api#documentation": "

\nThe status of the dashboard.\n

" + } + }, + "Widgets": { + "target": "com.amazonaws.cloudtrail#WidgetList", + "traits": { + "smithy.api#documentation": "

\nAn array of widgets for the dashboard.\n

" + } + }, + "RefreshSchedule": { + "target": "com.amazonaws.cloudtrail#RefreshSchedule", + "traits": { + "smithy.api#documentation": "

\nThe refresh schedule for the dashboard, if configured.\n

" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

\n The timestamp that shows when the dashboard was created.\n

" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

\n The timestamp that shows when the dashboard was last updated.\n

" + } + }, + "LastRefreshId": { + "target": "com.amazonaws.cloudtrail#RefreshId", + "traits": { + "smithy.api#documentation": "

\nThe ID of the last dashboard refresh.\n

" + } + }, + "LastRefreshFailureReason": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

\nProvides information about failures for the last scheduled refresh.\n

" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", + "traits": { + "smithy.api#documentation": "

\nIndicates whether termination protection is enabled for the dashboard.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#GetEventConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#GetEventConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#GetEventConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the current event configuration settings for the specified event data store or trail. The response includes maximum event size configuration, the context key selectors configured for the event data store, and any aggregation settings configured for the trail.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#GetEventConfigurationRequest": { + "type": "structure", + "members": { + "TrailName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The name of the trail for which you want to retrieve event configuration settings.

" + } + }, + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or ID suffix of the ARN of the event data store for which you want to retrieve event configuration settings.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#GetEventConfigurationResponse": { + "type": "structure", + "members": { + "TrailARN": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trail for which the event configuration settings are returned.

" + } + }, + "EventDataStoreArn": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or ID suffix of the ARN of the event data store for which the event configuration settings are returned.

" + } + }, + "MaxEventSize": { + "target": "com.amazonaws.cloudtrail#MaxEventSize", + "traits": { + "smithy.api#documentation": "

The maximum allowed size for events stored in the specified event data store.

" + } + }, + "ContextKeySelectors": { + "target": "com.amazonaws.cloudtrail#ContextKeySelectors", + "traits": { + "smithy.api#documentation": "

The list of context key selectors that are configured for the event data store.

" + } + }, + "AggregationConfigurations": { + "target": "com.amazonaws.cloudtrail#AggregationConfigurations", + "traits": { + "smithy.api#documentation": "

The list of aggregation configurations that are configured for the trail.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#GetEventDataStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#GetEventDataStoreRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#GetEventDataStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about an event data store specified as either an ARN or the ID\n portion of the ARN.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#GetEventDataStoreRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN (or ID suffix of the ARN) of the event data store about which you want\n information.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#GetEventDataStoreResponse": { + "type": "structure", + "members": { + "EventDataStoreArn": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The event data store Amazon Resource Number (ARN).

" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#EventDataStoreName", + "traits": { + "smithy.api#documentation": "

The name of the event data store.

" + } + }, + "Status": { + "target": "com.amazonaws.cloudtrail#EventDataStoreStatus", + "traits": { + "smithy.api#documentation": "

The status of an event data store.

" + } + }, + "AdvancedEventSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", + "traits": { + "smithy.api#documentation": "

The advanced event selectors used to select events for the data store.

" + } + }, + "MultiRegionEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the event data store includes events from all Regions, or only from\n the Region in which it was created.

" + } + }, + "OrganizationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether an event data store is collecting logged events for an organization in\n Organizations.

" + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.cloudtrail#RetentionPeriod", + "traits": { + "smithy.api#documentation": "

The retention period of the event data store, in days.

" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", + "traits": { + "smithy.api#documentation": "

Indicates that termination protection is enabled.

" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp of the event data store's creation.

" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Shows the time that an event data store was updated, if applicable.\n UpdatedTimestamp is always either the same or newer than the time shown in\n CreatedTimestamp.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.cloudtrail#EventDataStoreKmsKeyId", + "traits": { + "smithy.api#documentation": "

Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.

\n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" + } + }, + "BillingMode": { + "target": "com.amazonaws.cloudtrail#BillingMode", + "traits": { + "smithy.api#documentation": "

The billing mode for the event data store.

" + } + }, + "FederationStatus": { + "target": "com.amazonaws.cloudtrail#FederationStatus", + "traits": { + "smithy.api#documentation": "

\n Indicates the Lake query federation status. The status is \n ENABLED if Lake query federation is enabled, or DISABLED if Lake query federation is disabled. You cannot delete an event data store if the FederationStatus is ENABLED.\n

" + } + }, + "FederationRoleArn": { + "target": "com.amazonaws.cloudtrail#FederationRoleArn", + "traits": { + "smithy.api#documentation": "

\n If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.\n

" + } + }, + "PartitionKeys": { + "target": "com.amazonaws.cloudtrail#PartitionKeyList", + "traits": { + "smithy.api#documentation": "

The partition keys for the event data store. To improve query performance and efficiency, CloudTrail Lake organizes \n event data into partitions based on values derived from partition keys.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#GetEventSelectors": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#GetEventSelectorsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#GetEventSelectorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the settings for the event selectors that you configured for your trail. The\n information returned for your event selectors includes the following:

\n \n

For more information about logging management, data, and network activity events, see the following topics\n in the CloudTrail User Guide:

\n ", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#GetEventSelectorsRequest": { + "type": "structure", + "members": { + "TrailName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the trail or trail ARN. If you specify a trail name, the string\n must meet the following requirements:

\n \n

If you specify a trail ARN, it must be in the format:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#GetEventSelectorsResponse": { + "type": "structure", + "members": { + "TrailARN": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The specified trail ARN that has the event selectors.

" + } + }, + "EventSelectors": { + "target": "com.amazonaws.cloudtrail#EventSelectors", + "traits": { + "smithy.api#documentation": "

The event selectors that are configured for the trail.

" + } + }, + "AdvancedEventSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", + "traits": { + "smithy.api#documentation": "

The advanced event selectors that are configured for the trail.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#GetImport": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#GetImportRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#GetImportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ImportNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specific import.

" + } + }, + "com.amazonaws.cloudtrail#GetImportRequest": { + "type": "structure", + "members": { + "ImportId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID for the import.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#GetImportResponse": { + "type": "structure", + "members": { + "ImportId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the import.

" + } + }, + "Destinations": { + "target": "com.amazonaws.cloudtrail#ImportDestinations", + "traits": { + "smithy.api#documentation": "

The ARN of the destination event data store.

" + } + }, + "ImportSource": { + "target": "com.amazonaws.cloudtrail#ImportSource", + "traits": { + "smithy.api#documentation": "

The source S3 bucket.

" + } + }, + "StartEventTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Used with EndEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n

" + } + }, + "EndEventTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Used with StartEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n

" + } + }, + "ImportStatus": { + "target": "com.amazonaws.cloudtrail#ImportStatus", + "traits": { + "smithy.api#documentation": "

The status of the import.

" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp of the import's creation.

" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp of when the import was updated.

" + } + }, + "ImportStatistics": { + "target": "com.amazonaws.cloudtrail#ImportStatistics", + "traits": { + "smithy.api#documentation": "

Provides statistics for the import. CloudTrail does not update import statistics\n in real-time. Returned values for parameters such as EventsCompleted may be\n lower than the actual value, because CloudTrail updates statistics incrementally\n over the course of the import.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#GetInsightSelectors": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#GetInsightSelectorsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#GetInsightSelectorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#InsightNotEnabledException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the settings for the Insights event selectors that you configured for your\n trail or event data store. GetInsightSelectors shows if CloudTrail Insights logging is enabled \n and which Insights types are configured with corresponding event categories. If you run\n GetInsightSelectors on a trail or event data store that does not have Insights events enabled,\n the operation throws the exception InsightNotEnabledException\n

\n

Specify either the EventDataStore parameter to get Insights event selectors for an event data store, \n or the TrailName parameter to the get Insights event selectors for a trail. You cannot specify these parameters together.

\n

For more information, see Working with CloudTrail Insights in the CloudTrail User Guide.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#GetInsightSelectorsRequest": { + "type": "structure", + "members": { + "TrailName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the trail or trail ARN. If you specify a trail name, the string\n must meet the following requirements:

\n \n

If you specify a trail ARN, it must be in the format:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

\n

You cannot use this parameter with the EventDataStore parameter.

" + } + }, + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

\n Specifies the ARN (or ID suffix of the ARN) of the event data store for which you want to get Insights\n selectors.\n

\n

You cannot use this parameter with the TrailName parameter.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#GetInsightSelectorsResponse": { + "type": "structure", + "members": { + "TrailARN": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a trail for which you want to get Insights\n selectors.

" + } + }, + "InsightSelectors": { + "target": "com.amazonaws.cloudtrail#InsightSelectors", + "traits": { + "smithy.api#documentation": "

Contains the Insights types that are enabled on a trail or event data store. It also specifies the event categories on which a particular Insight type is enabled. \n ApiCallRateInsight and ApiErrorRateInsight are valid Insight\n types.The EventCategory field can specify Management or Data events or both. For event data store, you can log Insights for management events only.

" + } + }, + "EventDataStoreArn": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

\n The ARN of the source event data store that enabled Insights events.\n

" + } + }, + "InsightsDestination": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

\n The ARN of the destination event data store that logs Insights events.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#GetQueryResults": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#GetQueryResultsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#GetQueryResultsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidMaxResultsException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#QueryIdNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets event data results of a query. You must specify the QueryID value\n returned by the StartQuery operation.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken" + } + } + }, + "com.amazonaws.cloudtrail#GetQueryResultsRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#deprecated": { + "message": "EventDataStore is no longer required by GetQueryResultsRequest" + }, + "smithy.api#documentation": "

The ARN (or ID suffix of the ARN) of the event data store against which the query was\n run.

" + } + }, + "QueryId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the query for which you want to get results.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token you can use to get the next page of query results.

" + } + }, + "MaxQueryResults": { + "target": "com.amazonaws.cloudtrail#MaxQueryResults", + "traits": { + "smithy.api#documentation": "

The maximum number of query results to display on a single page.

" + } + }, + "EventDataStoreOwnerAccountId": { + "target": "com.amazonaws.cloudtrail#AccountId", + "traits": { + "smithy.api#documentation": "

\nThe account ID of the event data store owner.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#GetQueryResultsResponse": { + "type": "structure", + "members": { + "QueryStatus": { + "target": "com.amazonaws.cloudtrail#QueryStatus", + "traits": { + "smithy.api#documentation": "

The status of the query. Values include QUEUED, RUNNING,\n FINISHED, FAILED, TIMED_OUT, or\n CANCELLED.

" + } + }, + "QueryStatistics": { + "target": "com.amazonaws.cloudtrail#QueryStatistics", + "traits": { + "smithy.api#documentation": "

Shows the count of query results.

" + } + }, + "QueryResultRows": { + "target": "com.amazonaws.cloudtrail#QueryResultRows", + "traits": { + "smithy.api#documentation": "

Contains the individual event results of the query.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token you can use to get the next page of query results.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The error message returned if a query failed.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#GetResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#GetResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#GetResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceARNNotValidException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourcePolicyNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Retrieves the JSON text of the resource-based policy document attached to the CloudTrail event data store, dashboard, or channel.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#GetResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.cloudtrail#ResourceArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the CloudTrail event data store, dashboard, or channel attached to the resource-based policy.

\n

Example event data store ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n

\n

Example dashboard ARN format: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash\n

\n

Example channel ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#GetResourcePolicyResponse": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.cloudtrail#ResourceArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the CloudTrail event data store, dashboard, or channel attached to resource-based policy. \n

\n

Example event data store ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n

\n

Example dashboard ARN format: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash\n

\n

Example channel ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n

" + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.cloudtrail#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

\n A JSON-formatted string that contains the resource-based policy attached to the CloudTrail event data store, dashboard, or channel.\n

" + } + }, + "DelegatedAdminResourcePolicy": { + "target": "com.amazonaws.cloudtrail#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

\n The default resource-based policy that is automatically generated for the delegated administrator of an Organizations organization. \n This policy will be evaluated in tandem with any policy you submit for the resource. For more information about this policy, \n see Default resource policy for delegated administrators.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#GetTrail": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#GetTrailRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#GetTrailResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns settings information for a specified trail.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#GetTrailRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The name or the Amazon Resource Name (ARN) of the trail for which you want to retrieve\n settings information.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#GetTrailResponse": { + "type": "structure", + "members": { + "Trail": { + "target": "com.amazonaws.cloudtrail#Trail" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#GetTrailStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#GetTrailStatusRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#GetTrailStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a JSON-formatted list of information about the specified trail. Fields include\n information on delivery errors, Amazon SNS and Amazon S3 errors, and start\n and stop logging times for each trail. This operation returns trail status from a single\n Region. To return trail status from all Regions, you must call the operation on each\n Region.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#GetTrailStatusRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name or the CloudTrail ARN of the trail for which you are\n requesting status. To get the status of a shadow trail (a replication of the trail in\n another Region), you must specify its ARN.

\n

\n The following is the format of a trail\n ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

\n \n

If the trail is an organization trail and you are a member account in the organization in Organizations, you must provide the full ARN of that trail, and not just the name.

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

The name of a trail about which you want the current status.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#GetTrailStatusResponse": { + "type": "structure", + "members": { + "IsLogging": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Whether the CloudTrail trail is currently logging Amazon Web Services API\n calls.

" + } + }, + "LatestDeliveryError": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Displays any Amazon S3 error that CloudTrail encountered when attempting\n to deliver log files to the designated bucket. For more information, see Error\n Responses in the Amazon S3 API Reference.

\n \n

This error occurs only when there is a problem with the destination S3 bucket, and\n does not occur for requests that time out. To resolve the issue, \n fix the bucket policy so that CloudTrail \n can write to the bucket; or create a new bucket and call UpdateTrail to specify the new bucket.

\n " + } + }, + "LatestNotificationError": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Displays any Amazon SNS error that CloudTrail encountered when attempting\n to send a notification. For more information about Amazon SNS errors, see the\n Amazon SNS\n Developer Guide.

" + } + }, + "LatestDeliveryTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Specifies the date and time that CloudTrail last delivered log files to an\n account's Amazon S3 bucket.

" + } + }, + "LatestNotificationTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Specifies the date and time of the most recent Amazon SNS notification that\n CloudTrail has written a new log file to an account's Amazon S3\n bucket.

" + } + }, + "StartLoggingTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Specifies the most recent date and time when CloudTrail started recording API\n calls for an Amazon Web Services account.

" + } + }, + "StopLoggingTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Specifies the most recent date and time when CloudTrail stopped recording API\n calls for an Amazon Web Services account.

" + } + }, + "LatestCloudWatchLogsDeliveryError": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Displays any CloudWatch Logs error that CloudTrail encountered when attempting\n to deliver logs to CloudWatch Logs.

" + } + }, + "LatestCloudWatchLogsDeliveryTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.

" + } + }, + "LatestDigestDeliveryTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Specifies the date and time that CloudTrail last delivered a digest file to an\n account's Amazon S3 bucket.

" + } + }, + "LatestDigestDeliveryError": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Displays any Amazon S3 error that CloudTrail encountered when attempting\n to deliver a digest file to the designated bucket. For more information, see Error\n Responses in the Amazon S3 API Reference.

\n \n

This error occurs only when there is a problem with the destination S3 bucket, and\n does not occur for requests that time out. To resolve the issue, \n fix the bucket policy so that CloudTrail \n can write to the bucket; or create a new bucket and call UpdateTrail to specify the new bucket.

\n " + } + }, + "LatestDeliveryAttemptTime": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

This field is no longer in use.

" + } + }, + "LatestNotificationAttemptTime": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

This field is no longer in use.

" + } + }, + "LatestNotificationAttemptSucceeded": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

This field is no longer in use.

" + } + }, + "LatestDeliveryAttemptSucceeded": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

This field is no longer in use.

" + } + }, + "TimeLoggingStarted": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

This field is no longer in use.

" + } + }, + "TimeLoggingStopped": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

This field is no longer in use.

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

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#ImportDestinations": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.cloudtrail#ImportFailureList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#ImportFailureListItem" + } + }, + "com.amazonaws.cloudtrail#ImportFailureListItem": { + "type": "structure", + "members": { + "Location": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The location of the failure in the S3 bucket.

" + } + }, + "Status": { + "target": "com.amazonaws.cloudtrail#ImportFailureStatus", + "traits": { + "smithy.api#documentation": "

The status of the import.

" + } + }, + "ErrorType": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The type of import error.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Provides the reason the import failed.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

When the import was last updated.

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

Provides information about an import failure.

" + } + }, + "com.amazonaws.cloudtrail#ImportFailureStatus": { + "type": "enum", + "members": { + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "RETRY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRY" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + } + } + }, + "com.amazonaws.cloudtrail#ImportNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ImportNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified import was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.cloudtrail#ImportSource": { + "type": "structure", + "members": { + "S3": { + "target": "com.amazonaws.cloudtrail#S3ImportSource", + "traits": { + "smithy.api#documentation": "

The source S3 bucket.

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

The import source.

" + } + }, + "com.amazonaws.cloudtrail#ImportStatistics": { + "type": "structure", + "members": { + "PrefixesFound": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "

The number of S3 prefixes found for the import.

" + } + }, + "PrefixesCompleted": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "

The number of S3 prefixes that completed import.

" + } + }, + "FilesCompleted": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "

The number of log files that completed import.

" + } + }, + "EventsCompleted": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "

The number of trail events imported into the event data store.

" + } + }, + "FailedEntries": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "

The number of failed entries.

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

Provides statistics for the specified ImportID. CloudTrail does not\n update import statistics in real-time. Returned values for parameters such as\n EventsCompleted may be lower than the actual value, because CloudTrail updates statistics incrementally over the course of the import.

" + } + }, + "com.amazonaws.cloudtrail#ImportStatus": { + "type": "enum", + "members": { + "INITIALIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIALIZING" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + } + } + }, + "com.amazonaws.cloudtrail#ImportsList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#ImportsListItem" + } + }, + "com.amazonaws.cloudtrail#ImportsListItem": { + "type": "structure", + "members": { + "ImportId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the import.

" + } + }, + "ImportStatus": { + "target": "com.amazonaws.cloudtrail#ImportStatus", + "traits": { + "smithy.api#documentation": "

The status of the import.

" + } + }, + "Destinations": { + "target": "com.amazonaws.cloudtrail#ImportDestinations", + "traits": { + "smithy.api#documentation": "

The ARN of the destination event data store.

" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp of the import's creation.

" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp of the import's last update.

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

Contains information about an import that was returned by a lookup request.

" + } + }, + "com.amazonaws.cloudtrail#InactiveEventDataStoreException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InactiveEventDataStore", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The event data store is inactive.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InactiveQueryException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InactiveQuery", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified query cannot be canceled because it is in the FINISHED,\n FAILED, TIMED_OUT, or CANCELLED state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#IngestionStatus": { + "type": "structure", + "members": { + "LatestIngestionSuccessTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The time stamp of the most recent successful ingestion of events for the channel.

" + } + }, + "LatestIngestionSuccessEventID": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The event ID of the most recent successful ingestion of events.

" + } + }, + "LatestIngestionErrorCode": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The error code for the most recent failure to ingest events.

" + } + }, + "LatestIngestionAttemptTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The time stamp of the most recent attempt to ingest events on the channel.

" + } + }, + "LatestIngestionAttemptEventID": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The event ID of the most recent attempt to ingest events.

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

A table showing information about the most recent successful and failed attempts \n to ingest events.

" + } + }, + "com.amazonaws.cloudtrail#InsightNotEnabledException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsightNotEnabled", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

If you run GetInsightSelectors on a trail or event data store that does not have Insights\n events enabled, the operation throws the exception\n InsightNotEnabledException.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InsightSelector": { + "type": "structure", + "members": { + "InsightType": { + "target": "com.amazonaws.cloudtrail#InsightType", + "traits": { + "smithy.api#documentation": "

The type of Insights events to log on a trail or event data store. ApiCallRateInsight and\n ApiErrorRateInsight are valid Insight types.

\n

The ApiCallRateInsight Insights type analyzes write-only\n management API calls or read and write data API calls that are aggregated per minute against a baseline API call volume.

\n

The ApiErrorRateInsight Insights type analyzes management and data \n API calls that result in error codes. The error is shown if the API call is\n unsuccessful.

" + } + }, + "EventCategories": { + "target": "com.amazonaws.cloudtrail#SourceEventCategories", + "traits": { + "smithy.api#documentation": "

Select the event category on which Insights should be enabled.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A JSON string that contains a list of Insights types that are logged on a trail or event data store.

" + } + }, + "com.amazonaws.cloudtrail#InsightSelectors": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#InsightSelector" + } + }, + "com.amazonaws.cloudtrail#InsightType": { + "type": "enum", + "members": { + "ApiCallRateInsight": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ApiCallRateInsight" + } + }, + "ApiErrorRateInsight": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ApiErrorRateInsight" + } + } + } + }, + "com.amazonaws.cloudtrail#InsightsMetricDataType": { + "type": "enum", + "members": { + "FILL_WITH_ZEROS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FillWithZeros" + } + }, + "NON_ZERO_DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NonZeroData" + } + } + } + }, + "com.amazonaws.cloudtrail#InsightsMetricMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 21600 + } + } + }, + "com.amazonaws.cloudtrail#InsightsMetricNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5000 + } + } + }, + "com.amazonaws.cloudtrail#InsightsMetricPeriod": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 3600 + } + } + }, + "com.amazonaws.cloudtrail#InsightsMetricValues": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#Double" + } + }, + "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientDependencyServiceAccessPermission", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the IAM identity that is used to create\n the organization resource lacks one or more required permissions for creating an\n organization resource in a required service.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientEncryptionPolicy", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

For the CreateTrail\n PutInsightSelectors, UpdateTrail, StartQuery, and StartImport operations, this exception is thrown \n when the policy on the S3 bucket or KMS key does\n not have sufficient permissions for the operation.

\n

For all other operations, this exception is thrown when the policy for the KMS key does\n not have sufficient permissions for the operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InsufficientIAMAccessPermissionException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientIAMAccessPermission", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The task can't be completed because you are signed in with an account that lacks permissions to view or create a service-linked role. Sign in with an account that has the required permissions and then try again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InsufficientS3BucketPolicyException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientS3BucketPolicy", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

This exception is thrown when the policy on the S3 bucket is not sufficient.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.cloudtrail#InsufficientSnsTopicPolicyException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientSnsTopicPolicy", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

This exception is thrown when the policy on the Amazon SNS topic is not\n sufficient.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.cloudtrail#Integer": { + "type": "integer" + }, + "com.amazonaws.cloudtrail#InvalidCloudWatchLogsLogGroupArnException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidCloudWatchLogsLogGroupArn", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the provided CloudWatch Logs log group is not\n valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidCloudWatchLogsRoleArnException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidCloudWatchLogsRoleArn", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the provided role is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidDateRangeException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDateRange", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A date range for the query was specified that is not valid. Be sure that the start time\n is chronologically before the end time. For more information about writing a query, see\n Create or edit a query in the CloudTrail User Guide.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidEventCategoryException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidEventCategory", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Occurs if an event category that is not valid is specified as a value of\n EventCategory.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidEventDataStoreCategory", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when event categories of specified event data stores are not\n valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidEventDataStoreStatus", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The event data store is not in a status that supports the operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidEventSelectorsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidEventSelectors", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the PutEventSelectors operation is called\n with a number of event selectors, advanced event selectors, or data resources that is not\n valid. The combination of event selectors or advanced event selectors and data resources is\n not valid. A trail can have up to 5 event selectors. If a trail uses advanced event\n selectors, a maximum of 500 total values for all conditions in all advanced event selectors\n is allowed. A trail is limited to 250 data resources. These data resources can be\n distributed across event selectors, but the overall total cannot exceed 250.

\n

You can:

\n ", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidHomeRegionException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidHomeRegion", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when an operation is called on a trail from a Region other than\n the Region in which the trail was created.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidImportSourceException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidImportSource", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the provided source S3 bucket is not valid for import.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidInsightSelectorsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidInsightSelectors", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

For PutInsightSelectors, this exception is thrown when the formatting or syntax of the InsightSelectors JSON statement is not\n valid, or the specified InsightType in the InsightSelectors statement is not\n valid. Valid values for InsightType are ApiCallRateInsight and ApiErrorRateInsight. To enable Insights on an event data store, the destination event data store specified by the \n InsightsDestination parameter must log Insights events and the source event data \n store specified by the EventDataStore parameter must log management events.

\n

For UpdateEventDataStore, this exception is thrown if Insights are enabled on the event data store and the updated \n advanced event selectors are not compatible with the configured InsightSelectors. \n If the InsightSelectors includes an InsightType of ApiCallRateInsight, the source event data store must log write management events. \n If the InsightSelectors includes an InsightType of ApiErrorRateInsight, the source event data store must log management events.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidKmsKeyIdException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidKmsKeyId", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the KMS key ARN is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidLookupAttributesException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidLookupAttributes", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Occurs when a lookup attribute is specified that is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidMaxResultsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidMaxResults", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown if the limit specified is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidNextTokenException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidNextToken", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A token that is not valid, or a token that was previously used in a request with\n different parameters. This exception is thrown if the token is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidParameterCombinationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidParameterCombinationError", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the combination of parameters provided is not\n valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidParameterException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidParameter", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request includes a parameter that is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidQueryStatementException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidQueryStatement", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The query that was submitted has validation errors, or uses incorrect syntax or\n unsupported keywords. For more information about writing a query, see Create or edit a query in the CloudTrail User\n Guide.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidQueryStatusException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidQueryStatus", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The query status is not valid for the operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidS3BucketNameException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidS3BucketName", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the provided S3 bucket name is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidS3PrefixException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidS3Prefix", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the provided S3 prefix is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidSnsTopicNameException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidSnsTopicName", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the provided SNS topic name is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidSourceException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidSource", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the specified value of Source is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidTagParameterException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidTagParameter", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the specified tag key or values are not valid. It can also\n occur if there are duplicate tags or too many tags on the resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidTimeRangeException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidTimeRange", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Occurs if the timestamp values are not valid. Either the start time occurs after the end\n time, or the time range is outside the range of possible values.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidTokenException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidToken", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Reserved for future use.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidTrailNameException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidTrailName", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the provided trail name is not valid. Trail names must\n meet the following requirements:

\n ", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#KmsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KmsException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when there is an issue with the specified KMS\n key and the trail or event data store can't be updated.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#KmsKeyDisabledException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KmsKeyDisabled", + "httpResponseCode": 400 + }, + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

This exception is no longer in use.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#KmsKeyNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KmsKeyNotFound", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the KMS key does not exist, when the S3\n bucket and the KMS key are not in the same Region, or when the KMS key associated with the Amazon SNS topic either does not exist or is\n not in the same Region.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#ListChannels": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#ListChannelsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#ListChannelsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the channels in the current account, and their source names. \n

", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.cloudtrail#ListChannelsMaxResultsCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.cloudtrail#ListChannelsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.cloudtrail#ListChannelsMaxResultsCount", + "traits": { + "smithy.api#documentation": "

The maximum number of CloudTrail channels to display on a single page.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token to use to get the next page of results after a previous API call. This token\n must be passed in with the same parameters that were specified in the original call. For\n example, if the original call specified an AttributeKey of 'Username' with a value of\n 'root', the call with NextToken should include those same parameters.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#ListChannelsResponse": { + "type": "structure", + "members": { + "Channels": { + "target": "com.amazonaws.cloudtrail#Channels", + "traits": { + "smithy.api#documentation": "

The list of channels in the account.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token to use to get the next page of results after a previous API call.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#ListDashboards": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#ListDashboardsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#ListDashboardsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Returns information about all dashboards in the account, in the current Region.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#ListDashboardsMaxResultsCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.cloudtrail#ListDashboardsRequest": { + "type": "structure", + "members": { + "NamePrefix": { + "target": "com.amazonaws.cloudtrail#DashboardName", + "traits": { + "smithy.api#documentation": "

\nSpecify a name prefix to filter on.\n

" + } + }, + "Type": { + "target": "com.amazonaws.cloudtrail#DashboardType", + "traits": { + "smithy.api#documentation": "

\nSpecify a dashboard type to filter on: CUSTOM or MANAGED.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

\n A token you can use to get the next page of dashboard results.\n

" + } + }, + "MaxResults": { + "target": "com.amazonaws.cloudtrail#ListDashboardsMaxResultsCount", + "traits": { + "smithy.api#documentation": "

\n The maximum number of dashboards to display on a single page.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#ListDashboardsResponse": { + "type": "structure", + "members": { + "Dashboards": { + "target": "com.amazonaws.cloudtrail#Dashboards", + "traits": { + "smithy.api#documentation": "

\n Contains information about dashboards in the account, in the current Region that match the applied filters.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

\n A token you can use to get the next page of dashboard results.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#ListEventDataStores": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#ListEventDataStoresRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#ListEventDataStoresResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#InvalidMaxResultsException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about all event data stores in the account, in the current\n Region.

", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.cloudtrail#ListEventDataStoresMaxResultsCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.cloudtrail#ListEventDataStoresRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token you can use to get the next page of event data store results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.cloudtrail#ListEventDataStoresMaxResultsCount", + "traits": { + "smithy.api#documentation": "

The maximum number of event data stores to display on a single page.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#ListEventDataStoresResponse": { + "type": "structure", + "members": { + "EventDataStores": { + "target": "com.amazonaws.cloudtrail#EventDataStores", + "traits": { + "smithy.api#documentation": "

Contains information about event data stores in the account, in the current\n Region.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token you can use to get the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#ListImportFailures": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#ListImportFailuresRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#ListImportFailuresResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of failures for the specified import.

", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Failures", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.cloudtrail#ListImportFailuresMaxResultsCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.cloudtrail#ListImportFailuresRequest": { + "type": "structure", + "members": { + "ImportId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the import.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.cloudtrail#ListImportFailuresMaxResultsCount", + "traits": { + "smithy.api#documentation": "

The maximum number of failures to display on a single page.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token you can use to get the next page of import failures.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#ListImportFailuresResponse": { + "type": "structure", + "members": { + "Failures": { + "target": "com.amazonaws.cloudtrail#ImportFailureList", + "traits": { + "smithy.api#documentation": "

Contains information about the import failures.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token you can use to get the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#ListImports": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#ListImportsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#ListImportsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information on all imports, or a select set of imports by\n ImportStatus or Destination.

", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Imports", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.cloudtrail#ListImportsMaxResultsCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.cloudtrail#ListImportsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.cloudtrail#ListImportsMaxResultsCount", + "traits": { + "smithy.api#documentation": "

The maximum number of imports to display on a single page.

" + } + }, + "Destination": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN of the destination event data store.

" + } + }, + "ImportStatus": { + "target": "com.amazonaws.cloudtrail#ImportStatus", + "traits": { + "smithy.api#documentation": "

The status of the import.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token you can use to get the next page of import results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#ListImportsResponse": { + "type": "structure", + "members": { + "Imports": { + "target": "com.amazonaws.cloudtrail#ImportsList", + "traits": { + "smithy.api#documentation": "

The list of returned imports.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token you can use to get the next page of import results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#ListInsightsData": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#ListInsightsDataRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#ListInsightsDataResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns Insights events generated on a trail that logs data events. You can list Insights events that occurred in a Region within the last 90 days.

\n

ListInsightsData supports the following Dimensions for Insights events:

\n \n

All dimensions are optional. The default number of results returned is 50, with a\n maximum of 50 possible. The response includes a token that you can use to get the next page\n of results.

\n

The rate of ListInsightsData requests is limited to two per second, per account, per Region. If\n this limit is exceeded, a throttling error occurs.

", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Events", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.cloudtrail#ListInsightsDataDimensionKey": { + "type": "enum", + "members": { + "EVENT_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EventId" + } + }, + "EVENT_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EventName" + } + }, + "EVENT_SOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EventSource" + } + } + } + }, + "com.amazonaws.cloudtrail#ListInsightsDataDimensionValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 + } + } + }, + "com.amazonaws.cloudtrail#ListInsightsDataDimensions": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudtrail#ListInsightsDataDimensionKey" + }, + "value": { + "target": "com.amazonaws.cloudtrail#ListInsightsDataDimensionValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.cloudtrail#ListInsightsDataMaxResultsCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.cloudtrail#ListInsightsDataRequest": { + "type": "structure", + "members": { + "InsightSource": { + "target": "com.amazonaws.cloudtrail#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name(ARN) of the trail for which you want to retrieve Insights events.

", + "smithy.api#required": {} + } + }, + "DataType": { + "target": "com.amazonaws.cloudtrail#ListInsightsDataType", + "traits": { + "smithy.api#documentation": "

Specifies the category of events returned. To fetch Insights events, specify InsightsEvents as the value of DataType\n

", + "smithy.api#required": {} + } + }, + "Dimensions": { + "target": "com.amazonaws.cloudtrail#ListInsightsDataDimensions", + "traits": { + "smithy.api#documentation": "

Contains a map of dimensions. Currently the map can contain only one item.

" + } + }, + "StartTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.

" + } + }, + "EndTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.cloudtrail#ListInsightsDataMaxResultsCount", + "traits": { + "smithy.api#documentation": "

The number of events to return. Possible values are 1 through 50. The default is 50.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. \n For example, if the original call specified a EventName as a dimension with PutObject as a value, the call with NextToken should include those same parameters.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#ListInsightsDataResponse": { + "type": "structure", + "members": { + "Events": { + "target": "com.amazonaws.cloudtrail#EventsList", + "traits": { + "smithy.api#documentation": "

A list of events returned based on the InsightSource, DataType or Dimensions specified. The events list is sorted by time. The most recent event is listed first.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token to use to get the next page of results after a previous API call. If the token does not appear, there are no more results to return. The token must be passed in with the same parameters as the previous call. \n For example, if the original call specified a EventName as a dimension with PutObject as a value, the call with NextToken should include those same parameters.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#ListInsightsDataType": { + "type": "enum", + "members": { + "INSIGHTS_EVENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InsightsEvents" + } + } + } + }, + "com.amazonaws.cloudtrail#ListInsightsMetricData": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#ListInsightsMetricDataRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#ListInsightsMetricDataResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns Insights metrics data for trails that have enabled Insights. The request must include the EventSource, \n EventName, and InsightType parameters.

\n

If the InsightType is set to ApiErrorRateInsight, the request must also include the ErrorCode parameter.

\n

The following are the available time periods for ListInsightsMetricData. Each cutoff is inclusive.

\n \n

To use ListInsightsMetricData operation, you must have the following permissions:

\n ", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.cloudtrail#ListInsightsMetricDataRequest": { + "type": "structure", + "members": { + "TrailName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name(ARN) or name of the trail for which you want to retrieve Insights metrics data. \n This parameter should only be provided to fetch Insights metrics data generated on trails logging data events. \n This parameter is not required for Insights metric data generated on trails logging management events.

" + } + }, + "EventSource": { + "target": "com.amazonaws.cloudtrail#EventSource", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services service to which the request was made, such as iam.amazonaws.com or s3.amazonaws.com.

", + "smithy.api#required": {} + } + }, + "EventName": { + "target": "com.amazonaws.cloudtrail#EventName", + "traits": { + "smithy.api#documentation": "

The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.

", + "smithy.api#required": {} + } + }, + "InsightType": { + "target": "com.amazonaws.cloudtrail#InsightType", + "traits": { + "smithy.api#documentation": "

The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight. \n The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. \n The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes.

", + "smithy.api#required": {} + } + }, + "ErrorCode": { + "target": "com.amazonaws.cloudtrail#ErrorCode", + "traits": { + "smithy.api#documentation": "

Conditionally required if the InsightType parameter is set to ApiErrorRateInsight.

\n

If returning metrics for the ApiErrorRateInsight Insights type, this is the error to retrieve data for. For example, AccessDenied.

" + } + }, + "StartTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Specifies, in UTC, the start time for time-series data. The value specified is inclusive; results include data points with the specified time stamp.

\n

The default is 90 days before the time of request.

" + } + }, + "EndTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Specifies, in UTC, the end time for time-series data. The value specified is exclusive; \n results include data points up to the specified time stamp.

\n

The default is the time of request.

" + } + }, + "Period": { + "target": "com.amazonaws.cloudtrail#InsightsMetricPeriod", + "traits": { + "smithy.api#documentation": "

Granularity of data to retrieve, in seconds. Valid values are 60, 300, and 3600. \n If you specify any other value, you will get an error. The default is 3600 seconds.

" + } + }, + "DataType": { + "target": "com.amazonaws.cloudtrail#InsightsMetricDataType", + "traits": { + "smithy.api#documentation": "

Type of data points to return. Valid values are NonZeroData and \n FillWithZeros. The default is NonZeroData.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.cloudtrail#InsightsMetricMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of data points to return. Valid values are integers from 1 to 21600. \n The default value is 21600.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#InsightsMetricNextToken", + "traits": { + "smithy.api#documentation": "

Returned if all datapoints can't be returned in a single call. For example, due to reaching MaxResults.

\n

Add this parameter to the request to continue retrieving results starting from the last evaluated point.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#ListInsightsMetricDataResponse": { + "type": "structure", + "members": { + "TrailARN": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the ARN of the trail. This is only returned when Insights is enabled on a trail logging data events.

" + } + }, + "EventSource": { + "target": "com.amazonaws.cloudtrail#EventSource", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services service to which the request was made, such as iam.amazonaws.com or s3.amazonaws.com.

" + } + }, + "EventName": { + "target": "com.amazonaws.cloudtrail#EventName", + "traits": { + "smithy.api#documentation": "

The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.

" + } + }, + "InsightType": { + "target": "com.amazonaws.cloudtrail#InsightType", + "traits": { + "smithy.api#documentation": "

The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight. \n The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. \n The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes.

" + } + }, + "ErrorCode": { + "target": "com.amazonaws.cloudtrail#ErrorCode", + "traits": { + "smithy.api#documentation": "

Only returned if InsightType parameter was set to ApiErrorRateInsight.

\n

If returning metrics for the ApiErrorRateInsight Insights type, this is the error to retrieve data for. For example, AccessDenied.

" + } + }, + "Timestamps": { + "target": "com.amazonaws.cloudtrail#Timestamps", + "traits": { + "smithy.api#documentation": "

List of timestamps at intervals corresponding to the specified time period.

" + } + }, + "Values": { + "target": "com.amazonaws.cloudtrail#InsightsMetricValues", + "traits": { + "smithy.api#documentation": "

List of values representing the API call rate or error rate at each timestamp. The number of values is equal to the number of timestamps.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#InsightsMetricNextToken", + "traits": { + "smithy.api#documentation": "

Only returned if the full results could not be returned in a single query. You can set the NextToken parameter \n in the next request to this value to continue retrieval.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#ListPublicKeys": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#ListPublicKeysRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#ListPublicKeysResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#InvalidTimeRangeException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTokenException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns all public keys whose private keys were used to sign the digest files within the\n specified time range. The public key is needed to validate digest files that were signed\n with its corresponding private key.

\n \n

CloudTrail uses different private and public key pairs per Region. Each digest\n file is signed with a private key unique to its Region. When you validate a digest file\n from a specific Region, you must look in the same Region for its corresponding public\n key.

\n ", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PublicKeyList" + } + } + }, + "com.amazonaws.cloudtrail#ListPublicKeysRequest": { + "type": "structure", + "members": { + "StartTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Optionally specifies, in UTC, the start of the time range to look up public keys for\n CloudTrail digest files. If not specified, the current time is used, and the\n current public key is returned.

" + } + }, + "EndTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Optionally specifies, in UTC, the end of the time range to look up public keys for\n CloudTrail digest files. If not specified, the current time is used.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

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

Requests the public keys for a specified time range.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#ListPublicKeysResponse": { + "type": "structure", + "members": { + "PublicKeyList": { + "target": "com.amazonaws.cloudtrail#PublicKeyList", + "traits": { + "smithy.api#documentation": "

Contains an array of PublicKey objects.

\n \n

The returned public keys may have validity time ranges that overlap.

\n " + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

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

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#ListQueries": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#ListQueriesRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#ListQueriesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidDateRangeException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidMaxResultsException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidQueryStatusException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of queries and query statuses for the past seven days. You must specify\n an ARN value for EventDataStore. Optionally, to shorten the list of results,\n you can specify a time range, formatted as timestamps, by adding StartTime and\n EndTime parameters, and a QueryStatus value. Valid values for\n QueryStatus include QUEUED, RUNNING,\n FINISHED, FAILED, TIMED_OUT, or\n CANCELLED.

", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.cloudtrail#ListQueriesMaxResultsCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.cloudtrail#ListQueriesRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN (or the ID suffix of the ARN) of an event data store on which queries were\n run.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token you can use to get the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.cloudtrail#ListQueriesMaxResultsCount", + "traits": { + "smithy.api#documentation": "

The maximum number of queries to show on a page.

" + } + }, + "StartTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Use with EndTime to bound a ListQueries request, and limit its\n results to only those queries run within a specified time period.

" + } + }, + "EndTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Use with StartTime to bound a ListQueries request, and limit\n its results to only those queries run within a specified time period.

" + } + }, + "QueryStatus": { + "target": "com.amazonaws.cloudtrail#QueryStatus", + "traits": { + "smithy.api#documentation": "

The status of queries that you want to return in results. Valid values for\n QueryStatus include QUEUED, RUNNING,\n FINISHED, FAILED, TIMED_OUT, or\n CANCELLED.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#ListQueriesResponse": { + "type": "structure", + "members": { + "Queries": { + "target": "com.amazonaws.cloudtrail#Queries", + "traits": { + "smithy.api#documentation": "

Lists matching query results, and shows query ID, status, and creation time of each\n query.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token you can use to get the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#ListTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#ListTagsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#ListTagsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ChannelARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTokenException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags for the specified trails, event data stores, dashboards, or channels in the current Region.

", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ResourceTagList" + } + } + }, + "com.amazonaws.cloudtrail#ListTagsRequest": { + "type": "structure", + "members": { + "ResourceIdList": { + "target": "com.amazonaws.cloudtrail#ResourceIdList", + "traits": { + "smithy.api#documentation": "

Specifies a list of trail, event data store, dashboard, or channel ARNs whose tags will be listed. The list\n has a limit of 20 ARNs.

\n

Example trail ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

\n

Example event data store ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n

\n

Example dashboard ARN format: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash\n

\n

Example channel ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

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

Specifies a list of tags to return.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#ListTagsResponse": { + "type": "structure", + "members": { + "ResourceTagList": { + "target": "com.amazonaws.cloudtrail#ResourceTagList", + "traits": { + "smithy.api#documentation": "

A list of resource tags.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

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

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#ListTrails": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#ListTrailsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#ListTrailsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists trails that are in the current account.

", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Trails" + } + } + }, + "com.amazonaws.cloudtrail#ListTrailsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The token to use to get the next page of results after a previous API call. This token\n must be passed in with the same parameters that were specified in the original call. For\n example, if the original call specified an AttributeKey of 'Username' with a value of\n 'root', the call with NextToken should include those same parameters.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#ListTrailsResponse": { + "type": "structure", + "members": { + "Trails": { + "target": "com.amazonaws.cloudtrail#Trails", + "traits": { + "smithy.api#documentation": "

Returns the name, ARN, and home Region of trails in the current account.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The token to use to get the next page of results after a previous API call. If the token\n does not appear, there are no more results to return. The token must be passed in with the\n same parameters as the previous call. For example, if the original call specified an\n AttributeKey of 'Username' with a value of 'root', the call with NextToken should include\n those same parameters.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#Location": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 1024 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:*]+$" + } + }, + "com.amazonaws.cloudtrail#Long": { + "type": "long" + }, + "com.amazonaws.cloudtrail#LookupAttribute": { + "type": "structure", + "members": { + "AttributeKey": { + "target": "com.amazonaws.cloudtrail#LookupAttributeKey", + "traits": { + "smithy.api#documentation": "

Specifies an attribute on which to filter the events returned.

", + "smithy.api#required": {} + } + }, + "AttributeValue": { + "target": "com.amazonaws.cloudtrail#LookupAttributeValue", + "traits": { + "smithy.api#documentation": "

Specifies a value for the specified AttributeKey.

\n

The maximum length for the AttributeValue is 2000 characters. The\n following characters ('_', ' ', ',',\n '\\\\n') count as two characters towards the 2000 character limit.

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

Specifies an attribute and value that filter the events returned.

" + } + }, + "com.amazonaws.cloudtrail#LookupAttributeKey": { + "type": "enum", + "members": { + "EVENT_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EventId" + } + }, + "EVENT_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EventName" + } + }, + "READ_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReadOnly" + } + }, + "USERNAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Username" + } + }, + "RESOURCE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceType" + } + }, + "RESOURCE_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceName" + } + }, + "EVENT_SOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EventSource" + } + }, + "ACCESS_KEY_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessKeyId" + } + } + } + }, + "com.amazonaws.cloudtrail#LookupAttributeValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 + } + } + }, + "com.amazonaws.cloudtrail#LookupAttributesList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#LookupAttribute" + } + }, + "com.amazonaws.cloudtrail#LookupEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#LookupEventsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#LookupEventsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#InvalidEventCategoryException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidLookupAttributesException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidMaxResultsException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTimeRangeException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Looks up management events or CloudTrail Insights events that are captured by CloudTrail. \n You can look up events that occurred in a Region within the last 90 days.

\n \n

\n LookupEvents returns recent Insights events for trails that enable Insights. To view Insights events for an event data store, you can run queries on your \n Insights event data store, and you can also view the Lake dashboard for Insights.

\n \n

Lookup supports the following attributes for management events:

\n \n

Lookup supports the following attributes for Insights events:

\n \n

All attributes are optional. The default number of results returned is 50, with a\n maximum of 50 possible. The response includes a token that you can use to get the next page\n of results.

\n \n

The rate of lookup requests is limited to two per second, per account, per Region. If\n this limit is exceeded, a throttling error occurs.

\n ", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Events", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.cloudtrail#LookupEventsRequest": { + "type": "structure", + "members": { + "LookupAttributes": { + "target": "com.amazonaws.cloudtrail#LookupAttributesList", + "traits": { + "smithy.api#documentation": "

Contains a list of lookup attributes. Currently the list can contain only one\n item.

" + } + }, + "StartTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Specifies that only events that occur after or at the specified time are returned. If\n the specified start time is after the specified end time, an error is returned.

" + } + }, + "EndTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Specifies that only events that occur before or at the specified time are returned. If\n the specified end time is before the specified start time, an error is returned.

" + } + }, + "EventCategory": { + "target": "com.amazonaws.cloudtrail#EventCategory", + "traits": { + "smithy.api#documentation": "

Specifies the event category. If you do not specify an event category, events of the\n category are not returned in the response. For example, if you do not specify\n insight as the value of EventCategory, no Insights events are\n returned.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.cloudtrail#MaxResults", + "traits": { + "smithy.api#documentation": "

The number of events to return. Possible values are 1 through 50. The default is\n 50.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to get the next page of results after a previous API call. This token\n must be passed in with the same parameters that were specified in the original call. For\n example, if the original call specified an AttributeKey of 'Username' with a value of\n 'root', the call with NextToken should include those same parameters.

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

Contains a request for LookupEvents.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#LookupEventsResponse": { + "type": "structure", + "members": { + "Events": { + "target": "com.amazonaws.cloudtrail#EventsList", + "traits": { + "smithy.api#documentation": "

A list of events returned based on the lookup attributes specified and the CloudTrail event. The events list is sorted by time. The most recent event is listed\n first.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to get the next page of results after a previous API call. If the token\n does not appear, there are no more results to return. The token must be passed in with the\n same parameters as the previous call. For example, if the original call specified an\n AttributeKey of 'Username' with a value of 'root', the call with NextToken should include\n those same parameters.

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

Contains a response to a LookupEvents action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#MaxConcurrentQueriesException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "MaxConcurrentQueries", + "httpResponseCode": 429 + }, + "smithy.api#documentation": "

You are already running the maximum number of concurrent queries. The maximum number of concurrent queries is 10. Wait a minute for some\n queries to finish, and then run the query again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.cloudtrail#MaxEventSize": { + "type": "enum", + "members": { + "Standard": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Standard" + } + }, + "Large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Large" + } + } + } + }, + "com.amazonaws.cloudtrail#MaxQueryResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.cloudtrail#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.cloudtrail#MaximumNumberOfTrailsExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "MaximumNumberOfTrailsExceeded", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

This exception is thrown when the maximum number of trails is reached.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.cloudtrail#NextToken": { + "type": "string" + }, + "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "NoManagementAccountSLRExists", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

This exception is thrown when the management account does not have a service-linked\n role.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.cloudtrail#NotOrganizationManagementAccountException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "NotOrganizationManagementAccount", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

This exception is thrown when the account making the request is not the organization's\n management account.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "NotOrganizationMasterAccount", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the Amazon Web Services account making the request to\n create or update an organization trail or event data store is not the management account\n for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#OperationNotPermittedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "OperationNotPermitted", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the requested operation is not permitted.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#Operator": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#OperatorValue" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudtrail#OperatorTargetList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#OperatorTargetListMember" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.cloudtrail#OperatorTargetListMember": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.cloudtrail#OperatorValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "OrganizationNotInAllFeaturesMode", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when Organizations is not configured to support all\n features. All features must be enabled in Organizations to support creating an\n organization trail or event data store.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#OrganizationsNotInUseException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "OrganizationsNotInUse", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

This exception is thrown when the request is made from an Amazon Web Services account\n that is not a member of an organization. To make this request, sign in using the\n credentials of an account that belongs to an organization.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.cloudtrail#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 1000 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.cloudtrail#PartitionKey": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#PartitionKeyName", + "traits": { + "smithy.api#documentation": "

The name of the partition key.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.cloudtrail#PartitionKeyType", + "traits": { + "smithy.api#documentation": "

The data type of the partition key. For example, bigint or string.

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

Contains information about a partition key for an event data store.

" + } + }, + "com.amazonaws.cloudtrail#PartitionKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#PartitionKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.cloudtrail#PartitionKeyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" + } + }, + "com.amazonaws.cloudtrail#PartitionKeyType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" + } + }, + "com.amazonaws.cloudtrail#Prompt": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 500 + }, + "smithy.api#pattern": "^[ -~\\n]*$" + } + }, + "com.amazonaws.cloudtrail#PublicKey": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.cloudtrail#ByteBuffer", + "traits": { + "smithy.api#documentation": "

The DER encoded public key value in PKCS#1 format.

" + } + }, + "ValidityStartTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The starting time of validity of the public key.

" + } + }, + "ValidityEndTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The ending time of validity of the public key.

" + } + }, + "Fingerprint": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The fingerprint of the public key.

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

Contains information about a returned public key.

" + } + }, + "com.amazonaws.cloudtrail#PublicKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#PublicKey" + } + }, + "com.amazonaws.cloudtrail#PutEventConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#PutEventConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#PutEventConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientIAMAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidHomeRegionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the event configuration settings for the specified event data store or trail. This operation supports updating the maximum event size, adding or modifying context key selectors for event data store, and configuring aggregation settings for the trail.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#PutEventConfigurationRequest": { + "type": "structure", + "members": { + "TrailName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The name of the trail for which you want to update event configuration settings.

" + } + }, + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or ID suffix of the ARN of the event data store for which event configuration settings are updated.

" + } + }, + "MaxEventSize": { + "target": "com.amazonaws.cloudtrail#MaxEventSize", + "traits": { + "smithy.api#documentation": "

The maximum allowed size for events to be stored in the specified event data store. If you are using context key selectors, MaxEventSize must be set to Large.

" + } + }, + "ContextKeySelectors": { + "target": "com.amazonaws.cloudtrail#ContextKeySelectors", + "traits": { + "smithy.api#documentation": "

A list of context key selectors that will be included to provide enriched event data.

" + } + }, + "AggregationConfigurations": { + "target": "com.amazonaws.cloudtrail#AggregationConfigurations", + "traits": { + "smithy.api#documentation": "

The list of aggregation configurations that you want to configure for the trail.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#PutEventConfigurationResponse": { + "type": "structure", + "members": { + "TrailARN": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the trail that has aggregation enabled.

" + } + }, + "EventDataStoreArn": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or ID suffix of the ARN of the event data store for which the event configuration settings were updated.

" + } + }, + "MaxEventSize": { + "target": "com.amazonaws.cloudtrail#MaxEventSize", + "traits": { + "smithy.api#documentation": "

The maximum allowed size for events stored in the specified event data store.

" + } + }, + "ContextKeySelectors": { + "target": "com.amazonaws.cloudtrail#ContextKeySelectors", + "traits": { + "smithy.api#documentation": "

The list of context key selectors that are configured for the event data store.

" + } + }, + "AggregationConfigurations": { + "target": "com.amazonaws.cloudtrail#AggregationConfigurations", + "traits": { + "smithy.api#documentation": "

A list of aggregation configurations that are configured for the trail.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#PutEventSelectors": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#PutEventSelectorsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#PutEventSelectorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventSelectorsException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidHomeRegionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Configures event selectors (also referred to as basic event selectors) or advanced event selectors for your trail. You can use\n either AdvancedEventSelectors or EventSelectors, but not both. If\n you apply AdvancedEventSelectors to a trail, any existing\n EventSelectors are overwritten.

\n

You can use AdvancedEventSelectors to \n log management events, data events for all resource types, and network activity events.

\n

You can use EventSelectors to log management events and data events for the following resource types:

\n \n

You can't use EventSelectors to log network activity events.

\n

If you want your trail to log Insights events, be sure the event selector or advanced event selector enables \n logging of the Insights event types you want configured for your trail. For more information about logging Insights events, see Working with CloudTrail Insights in the CloudTrail User Guide.\n By default, trails created without specific event selectors are configured to\n log all read and write management events, and no data events or network activity events.

\n

When an event occurs in your account, CloudTrail evaluates the event selectors or\n advanced event selectors in all trails. For each trail, if the event matches any event\n selector, the trail processes and logs the event. If the event doesn't match any event\n selector, the trail doesn't log the event.

\n

Example

\n
    \n
  1. \n

    You create an event selector for a trail and specify that you want to log write-only\n events.

    \n
    2. \n
  2. \n

    The EC2 GetConsoleOutput and RunInstances API operations\n occur in your account.

    \n
    3. \n
  3. \n

    CloudTrail evaluates whether the events match your event selectors.

    \n
    4. \n
  4. \n

    The RunInstances is a write-only event and it matches your event\n selector. The trail logs the event.

    \n
    5. \n
  5. \n

    The GetConsoleOutput is a read-only event that doesn't match your\n event selector. The trail doesn't log the event.

    \n
    6. \n
\n

The PutEventSelectors operation must be called from the Region in which the\n trail was created; otherwise, an InvalidHomeRegionException exception is\n thrown.

\n

You can configure up to five event selectors for each trail.

\n

You can add advanced event selectors, and conditions for your advanced event selectors,\n up to a maximum of 500 values for all conditions and selectors on a trail. For more information, see\n Logging management events, Logging\n data events, Logging\n network activity events, and Quotas in CloudTrail in the CloudTrail User\n Guide.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#PutEventSelectorsRequest": { + "type": "structure", + "members": { + "TrailName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the trail or trail ARN. If you specify a trail name, the string\n must meet the following requirements:

\n \n

If you specify a trail ARN, it must be in the following format.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", + "smithy.api#required": {} + } + }, + "EventSelectors": { + "target": "com.amazonaws.cloudtrail#EventSelectors", + "traits": { + "smithy.api#documentation": "

Specifies the settings for your event selectors. You can use event selectors to log management events and data events for the following resource types:

\n \n

You can't use event selectors to log network activity events.

\n

You can configure up to five event\n selectors for a trail. You can use either EventSelectors or\n AdvancedEventSelectors in a PutEventSelectors request, but not\n both. If you apply EventSelectors to a trail, any existing\n AdvancedEventSelectors are overwritten.

" + } + }, + "AdvancedEventSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", + "traits": { + "smithy.api#documentation": "

Specifies the settings for advanced event selectors. You can use advanced event selectors to \n log management events, data events for all resource types, and network activity events.

\n

You can add advanced event\n selectors, and conditions for your advanced event selectors, up to a maximum of 500 values\n for all conditions and selectors on a trail. You can use either\n AdvancedEventSelectors or EventSelectors, but not both. If you\n apply AdvancedEventSelectors to a trail, any existing\n EventSelectors are overwritten. For more information about advanced event\n selectors, see Logging data events and \n Logging network activity events\n in the CloudTrail User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#PutEventSelectorsResponse": { + "type": "structure", + "members": { + "TrailARN": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the ARN of the trail that was updated with event selectors. The following is\n the format of a trail ARN.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

" + } + }, + "EventSelectors": { + "target": "com.amazonaws.cloudtrail#EventSelectors", + "traits": { + "smithy.api#documentation": "

Specifies the event selectors configured for your trail.

" + } + }, + "AdvancedEventSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", + "traits": { + "smithy.api#documentation": "

Specifies the advanced event selectors configured for your trail.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#PutInsightSelectors": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#PutInsightSelectorsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#PutInsightSelectorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientS3BucketPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidHomeRegionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidInsightSelectorsException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#KmsException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#S3BucketDoesNotExistException" + }, + { + "target": "com.amazonaws.cloudtrail#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lets you enable Insights event logging on specific event categories by specifying the Insights selectors that you\n want to enable on an existing trail or event data store. You also use PutInsightSelectors to turn\n off Insights event logging, by passing an empty list of Insights types. The valid Insights\n event types are ApiErrorRateInsight and\n ApiCallRateInsight, and valid EventCategories are Management and Data.

\n \n

\n Insights on data events are not supported on event data stores. For event data stores, you can only enable Insights on management events.\n

\n \n

To enable Insights on an event data store, you must specify the ARNs (or ID suffix of the ARNs) for the source event data store (EventDataStore) and the destination event data store (InsightsDestination). The source event data store logs management events and enables Insights. \n The destination event data store logs Insights events based upon the management event activity of the source event data store. The source and destination event data stores must belong to the same Amazon Web Services account.

\n

To log Insights events for a trail, you must specify the name (TrailName) of the CloudTrail trail for which you want to change or add Insights\n selectors.

\n \n

To log CloudTrail Insights events on API call volume, the trail or event data store\n must log write management events. To log CloudTrail\n Insights events on API error rate, the trail or event data store must log read or\n write management events. You can call GetEventSelectors on a trail \n to check whether the trail logs management events. You can call GetEventDataStore on an \n event data store to check whether the event data store logs management events.

\n

For more information, see Working with CloudTrail Insights in the CloudTrail User Guide.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#PutInsightSelectorsRequest": { + "type": "structure", + "members": { + "TrailName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The name of the CloudTrail trail for which you want to change or add Insights\n selectors.

\n

You cannot use this parameter with the EventDataStore and InsightsDestination parameters.

" + } + }, + "InsightSelectors": { + "target": "com.amazonaws.cloudtrail#InsightSelectors", + "traits": { + "smithy.api#documentation": "

Contains the Insights types you want to log on a specific category of events on a trail or event data store. \n ApiCallRateInsight and ApiErrorRateInsight are valid Insight\n types.The EventCategory field can specify Management or Data events or both. For event data store, you can log Insights for management events only.

\n

The ApiCallRateInsight Insights type analyzes write-only management\n\t API calls or read and write data API calls that are aggregated per minute against a baseline API call volume.

\n

The ApiErrorRateInsight Insights type analyzes management and data \n\t API calls that result in error codes. The error is shown if the API call is\n\t unsuccessful.

", + "smithy.api#required": {} + } + }, + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN (or ID suffix of the ARN) of the source event data store for which you want to change or add Insights\n selectors. To enable Insights on an event data store, you must provide both the \n EventDataStore and InsightsDestination parameters.

\n

You cannot use this parameter with the TrailName parameter.

" + } + }, + "InsightsDestination": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

\n The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events. To enable Insights on an event data store, you must provide both the \n EventDataStore and InsightsDestination parameters.\n

\n

You cannot use this parameter with the TrailName parameter.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#PutInsightSelectorsResponse": { + "type": "structure", + "members": { + "TrailARN": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a trail for which you want to change or add Insights\n selectors.

" + } + }, + "InsightSelectors": { + "target": "com.amazonaws.cloudtrail#InsightSelectors", + "traits": { + "smithy.api#documentation": "

Contains the Insights types you want to log on a specific category of events in a trail or event data store. \n ApiCallRateInsight and ApiErrorRateInsight are valid Insight\n types.The EventCategory field can specify Management or Data events or both. For event data store, you can only log Insights for management events only.

" + } + }, + "EventDataStoreArn": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source event data store for which you want to change or add Insights\n selectors.

" + } + }, + "InsightsDestination": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

\n The ARN of the destination event data store that logs Insights events.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#PutResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#PutResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#PutResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceARNNotValidException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourcePolicyNotValidException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Attaches a resource-based permission policy to a CloudTrail event data store, dashboard, or channel. For more information about resource-based policies, see \n CloudTrail resource-based policy examples \n in the CloudTrail User Guide.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#PutResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.cloudtrail#ResourceArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the CloudTrail event data store, dashboard, or channel attached to the resource-based policy.

\n

Example event data store ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n

\n

Example dashboard ARN format: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash\n

\n

Example channel ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n

", + "smithy.api#required": {} + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.cloudtrail#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

\n A JSON-formatted string for an Amazon Web Services resource-based policy.\n

\n

For example resource-based policies, see \n CloudTrail resource-based policy examples \n in the CloudTrail User Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#PutResourcePolicyResponse": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.cloudtrail#ResourceArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the CloudTrail event data store, dashboard, or channel attached to the resource-based policy.\n

\n

Example event data store ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n

\n

Example dashboard ARN format: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash\n

\n

Example channel ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n

" + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.cloudtrail#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

\n The JSON-formatted string of the Amazon Web Services resource-based policy attached to the CloudTrail event data store, dashboard, or channel.\n

" + } + }, + "DelegatedAdminResourcePolicy": { + "target": "com.amazonaws.cloudtrail#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

\n The default resource-based policy that is automatically generated for the delegated administrator of an Organizations organization. \n This policy will be evaluated in tandem with any policy you submit for the resource. For more information about this policy, \n see Default resource policy for delegated administrators.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#Queries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#Query" + } + }, + "com.amazonaws.cloudtrail#Query": { + "type": "structure", + "members": { + "QueryId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of a query.

" + } + }, + "QueryStatus": { + "target": "com.amazonaws.cloudtrail#QueryStatus", + "traits": { + "smithy.api#documentation": "

The status of the query. This can be QUEUED, RUNNING,\n FINISHED, FAILED, TIMED_OUT, or\n CANCELLED.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The creation time of a query.

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

A SQL string of criteria about events that you want to collect in an event data\n store.

" + } + }, + "com.amazonaws.cloudtrail#QueryAlias": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9._\\-]*$" + } + }, + "com.amazonaws.cloudtrail#QueryIdNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "QueryIdNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The query ID does not exist or does not map to a query.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.cloudtrail#QueryParameter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.cloudtrail#QueryParameterKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:$]+$" + } + }, + "com.amazonaws.cloudtrail#QueryParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:]+$" + } + }, + "com.amazonaws.cloudtrail#QueryParameterValues": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudtrail#QueryParameterKey" + }, + "value": { + "target": "com.amazonaws.cloudtrail#QueryParameterValue" + } + }, + "com.amazonaws.cloudtrail#QueryParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#QueryParameter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.cloudtrail#QueryResultColumn": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudtrail#QueryResultKey" + }, + "value": { + "target": "com.amazonaws.cloudtrail#QueryResultValue" + } + }, + "com.amazonaws.cloudtrail#QueryResultKey": { + "type": "string" + }, + "com.amazonaws.cloudtrail#QueryResultRow": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#QueryResultColumn" + } + }, + "com.amazonaws.cloudtrail#QueryResultRows": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#QueryResultRow" + } + }, + "com.amazonaws.cloudtrail#QueryResultValue": { + "type": "string" + }, + "com.amazonaws.cloudtrail#QueryStatement": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + }, + "smithy.api#pattern": "^(?s)" + } + }, + "com.amazonaws.cloudtrail#QueryStatistics": { + "type": "structure", + "members": { + "ResultsCount": { + "target": "com.amazonaws.cloudtrail#Integer", + "traits": { + "smithy.api#documentation": "

The number of results returned.

" + } + }, + "TotalResultsCount": { + "target": "com.amazonaws.cloudtrail#Integer", + "traits": { + "smithy.api#documentation": "

The total number of results returned by a query.

" + } + }, + "BytesScanned": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "

The total bytes that the query scanned in the event data store. This value matches the\n number of bytes for which your account is billed for the query, unless the query is still\n running.

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

Metadata about a query, such as the number of results.

" + } + }, + "com.amazonaws.cloudtrail#QueryStatisticsForDescribeQuery": { + "type": "structure", + "members": { + "EventsMatched": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "

The number of events that matched a query.

" + } + }, + "EventsScanned": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "

The number of events that the query scanned in the event data store.

" + } + }, + "BytesScanned": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "

The total bytes that the query scanned in the event data store. This value matches the\n number of bytes for which your account is billed for the query, unless the query is still\n running.

" + } + }, + "ExecutionTimeInMillis": { + "target": "com.amazonaws.cloudtrail#Integer", + "traits": { + "smithy.api#documentation": "

The query's run time, in milliseconds.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The creation time of the query.

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

Gets metadata about a query, including the number of events that were matched, the total\n number of events scanned, the query run time in milliseconds, and the query's creation\n time.

" + } + }, + "com.amazonaws.cloudtrail#QueryStatus": { + "type": "enum", + "members": { + "QUEUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUEUED" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "FINISHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FINISHED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "TIMED_OUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMED_OUT" + } + } + } + }, + "com.amazonaws.cloudtrail#ReadWriteType": { + "type": "enum", + "members": { + "ReadOnly": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReadOnly" + } + }, + "WriteOnly": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WriteOnly" + } + }, + "All": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "All" + } + } + } + }, + "com.amazonaws.cloudtrail#RefreshId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 20 + }, + "smithy.api#pattern": "^\\d+$" + } + }, + "com.amazonaws.cloudtrail#RefreshSchedule": { + "type": "structure", + "members": { + "Frequency": { + "target": "com.amazonaws.cloudtrail#RefreshScheduleFrequency", + "traits": { + "smithy.api#documentation": "

\nThe frequency at which you want the dashboard refreshed.\n

" + } + }, + "Status": { + "target": "com.amazonaws.cloudtrail#RefreshScheduleStatus", + "traits": { + "smithy.api#documentation": "

\nSpecifies whether the refresh schedule is enabled. Set the value to ENABLED to enable the refresh schedule, or to DISABLED to turn off the refresh schedule.\n

" + } + }, + "TimeOfDay": { + "target": "com.amazonaws.cloudtrail#TimeOfDay", + "traits": { + "smithy.api#documentation": "

\n The time of day in UTC to run the schedule; for hourly only refer to minutes; default is 00:00.\n

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

\nThe schedule for a dashboard refresh.\n

" + } + }, + "com.amazonaws.cloudtrail#RefreshScheduleFrequency": { + "type": "structure", + "members": { + "Unit": { + "target": "com.amazonaws.cloudtrail#RefreshScheduleFrequencyUnit", + "traits": { + "smithy.api#documentation": "

\n The unit to use for the refresh.\n

\n

For custom dashboards, the unit can be HOURS or DAYS.

\n

For the Highlights dashboard, the Unit must be HOURS.

" + } + }, + "Value": { + "target": "com.amazonaws.cloudtrail#RefreshScheduleFrequencyValue", + "traits": { + "smithy.api#documentation": "

\nThe value for the refresh schedule.\n

\n

\n For custom dashboards, the following values are valid when the unit is HOURS: 1, 6, 12, 24\n

\n

For custom dashboards, the only valid value when the unit is DAYS is 1.

\n

For the Highlights dashboard, the Value must be 6.

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

\nSpecifies the frequency for a dashboard refresh schedule.\n

\n

\n For a custom dashboard, you can schedule a refresh for every 1, 6, 12, or 24 hours, or every day.\n

" + } + }, + "com.amazonaws.cloudtrail#RefreshScheduleFrequencyUnit": { + "type": "enum", + "members": { + "HOURS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOURS" + } + }, + "DAYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAYS" + } + } + } + }, + "com.amazonaws.cloudtrail#RefreshScheduleFrequencyValue": { + "type": "integer" + }, + "com.amazonaws.cloudtrail#RefreshScheduleStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.cloudtrail#RegisterOrganizationDelegatedAdmin": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#RegisterOrganizationDelegatedAdminRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#RegisterOrganizationDelegatedAdminResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#AccountNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#AccountRegisteredException" + }, + { + "target": "com.amazonaws.cloudtrail#CannotDelegateManagementAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#DelegatedAdminAccountLimitExceededException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientIAMAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationManagementAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Registers an organization’s member account as the CloudTrail delegated administrator.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#RegisterOrganizationDelegatedAdminRequest": { + "type": "structure", + "members": { + "MemberAccountId": { + "target": "com.amazonaws.cloudtrail#AccountId", + "traits": { + "smithy.api#documentation": "

An organization member account ID that you want to designate as a delegated\n administrator.

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

Specifies an organization member account ID as a CloudTrail delegated\n administrator.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#RegisterOrganizationDelegatedAdminResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Returns the following response if successful. Otherwise, returns an error.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#RemoveTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#RemoveTagsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#RemoveTagsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ChannelARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#ChannelNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTagParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified tags from a trail, event data store, dashboard, or channel.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#RemoveTagsRequest": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the ARN of the trail, event data store, dashboard, or channel from which tags should be\n removed.

\n

Example trail ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

\n

Example event data store ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n

\n

Example dashboard ARN format: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash\n

\n

Example channel ARN format:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n

", + "smithy.api#required": {} + } + }, + "TagsList": { + "target": "com.amazonaws.cloudtrail#TagsList", + "traits": { + "smithy.api#documentation": "

Specifies a list of tags to be removed.

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

Specifies the tags to remove from a trail, event data store, dashboard, or channel.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#RemoveTagsResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#RequestWidget": { + "type": "structure", + "members": { + "QueryStatement": { + "target": "com.amazonaws.cloudtrail#QueryStatement", + "traits": { + "smithy.api#documentation": "

\nThe query statement for the widget. For custom dashboard widgets, you can query across multiple event data stores as long as all event data stores exist in your account.\n

\n \n

When a query uses ? with eventTime, ? must be surrounded by single quotes as follows: '?'.

\n ", + "smithy.api#required": {} + } + }, + "QueryParameters": { + "target": "com.amazonaws.cloudtrail#QueryParameters", + "traits": { + "smithy.api#documentation": "

\n The optional query parameters. The following query parameters are valid: $StartTime$, $EndTime$, and $Period$.\n

" + } + }, + "ViewProperties": { + "target": "com.amazonaws.cloudtrail#ViewPropertiesMap", + "traits": { + "smithy.api#documentation": "

\n The view properties for the widget. For more information about view properties, see \n View properties for widgets\n in the CloudTrail User Guide.\n

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

\nContains information about a widget on a CloudTrail Lake dashboard.\n

" + } + }, + "com.amazonaws.cloudtrail#RequestWidgetList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#RequestWidget" + } + }, + "com.amazonaws.cloudtrail#Resource": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The type of a resource referenced by the event returned. When the resource type cannot\n be determined, null is returned. Some examples of resource types are: Instance for EC2, Trail for CloudTrail, DBInstance for Amazon RDS, and AccessKey for IAM. To learn more about how to look up and filter\n events by the resource types supported for a service, see Filtering CloudTrail Events.

" + } + }, + "ResourceName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The name of the resource referenced by the event returned. These are user-created names\n whose values will depend on the environment. For example, the resource name might be\n \"auto-scaling-test-group\" for an Auto Scaling Group or \"i-1234567\" for an EC2\n Instance.

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

Specifies the type and name of a resource referenced by an event.

" + } + }, + "com.amazonaws.cloudtrail#ResourceARNNotValidException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceARNNotValid", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

\n This exception is thrown when the provided resource does not exist, or the ARN format of the resource is not valid.\n

\n

The following is the format of an event data store ARN:\n arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n

\n

The following is the format of a dashboard ARN: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash\n

\n

The following is the format of a channel ARN:\n arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:]+$" + } + }, + "com.amazonaws.cloudtrail#ResourceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#String" + } + }, + "com.amazonaws.cloudtrail#ResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#Resource" + }, + "traits": { + "smithy.api#documentation": "

A list of resources referenced by the event returned.

" + } + }, + "com.amazonaws.cloudtrail#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceNotFound", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the specified resource is not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#ResourcePolicy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8192 + } + } + }, + "com.amazonaws.cloudtrail#ResourcePolicyNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourcePolicyNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n This exception is thrown when the specified resource policy is not found.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.cloudtrail#ResourcePolicyNotValidException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourcePolicyNotValid", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

\n This exception is thrown when the resouce-based policy has syntax errors, or contains a principal that is not valid.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#ResourceTag": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the ARN of the resource.

" + } + }, + "TagsList": { + "target": "com.amazonaws.cloudtrail#TagsList", + "traits": { + "smithy.api#documentation": "

A list of tags.

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

A resource tag.

" + } + }, + "com.amazonaws.cloudtrail#ResourceTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#ResourceTag" + } + }, + "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceTypeNotSupported", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the specified resource type is not supported by CloudTrail.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#RestoreEventDataStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#RestoreEventDataStoreRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#RestoreEventDataStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreMaxLimitExceededException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Restores a deleted event data store specified by EventDataStore, which\n accepts an event data store ARN. You can only restore a deleted event data store within the\n seven-day wait period after deletion. Restoring an event data store can take several\n minutes, depending on the size of the event data store.

" + } + }, + "com.amazonaws.cloudtrail#RestoreEventDataStoreRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN (or the ID suffix of the ARN) of the event data store that you want to\n restore.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#RestoreEventDataStoreResponse": { + "type": "structure", + "members": { + "EventDataStoreArn": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The event data store ARN.

" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#EventDataStoreName", + "traits": { + "smithy.api#documentation": "

The name of the event data store.

" + } + }, + "Status": { + "target": "com.amazonaws.cloudtrail#EventDataStoreStatus", + "traits": { + "smithy.api#documentation": "

The status of the event data store.

" + } + }, + "AdvancedEventSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", + "traits": { + "smithy.api#documentation": "

The advanced event selectors that were used to select events.

" + } + }, + "MultiRegionEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the event data store is collecting events from all Regions, or only\n from the Region in which the event data store was created.

" + } + }, + "OrganizationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether an event data store is collecting logged events for an organization in\n Organizations.

" + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.cloudtrail#RetentionPeriod", + "traits": { + "smithy.api#documentation": "

The retention period, in days.

" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", + "traits": { + "smithy.api#documentation": "

Indicates that termination protection is enabled and the event data store cannot be\n automatically deleted.

" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp of an event data store's creation.

" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp that shows when an event data store was updated, if applicable.\n UpdatedTimestamp is always either the same or newer than the time shown in\n CreatedTimestamp.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.cloudtrail#EventDataStoreKmsKeyId", + "traits": { + "smithy.api#documentation": "

Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.

\n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" + } + }, + "BillingMode": { + "target": "com.amazonaws.cloudtrail#BillingMode", + "traits": { + "smithy.api#documentation": "

The billing mode for the event data store.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#RetentionPeriod": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 7, + "max": 3653 + } + } + }, + "com.amazonaws.cloudtrail#S3BucketDoesNotExistException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "S3BucketDoesNotExist", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

This exception is thrown when the specified S3 bucket does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.cloudtrail#S3ImportSource": { + "type": "structure", + "members": { + "S3LocationUri": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The URI for the source S3 bucket.

", + "smithy.api#required": {} + } + }, + "S3BucketRegion": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The Region associated with the source S3 bucket.

", + "smithy.api#required": {} + } + }, + "S3BucketAccessRoleArn": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The IAM ARN role used to access the source S3 bucket.

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

The settings for the source S3 bucket.

" + } + }, + "com.amazonaws.cloudtrail#SampleQueryDescription": { + "type": "string" + }, + "com.amazonaws.cloudtrail#SampleQueryName": { + "type": "string" + }, + "com.amazonaws.cloudtrail#SampleQueryRelevance": { + "type": "float", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.cloudtrail#SampleQuerySQL": { + "type": "string" + }, + "com.amazonaws.cloudtrail#SearchSampleQueries": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#SearchSampleQueriesRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#SearchSampleQueriesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Searches sample queries and returns a list of sample queries that are sorted by relevance. \n To search for sample queries, provide a natural language SearchPhrase in English.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#SearchSampleQueriesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.cloudtrail#SearchSampleQueriesRequest": { + "type": "structure", + "members": { + "SearchPhrase": { + "target": "com.amazonaws.cloudtrail#SearchSampleQueriesSearchPhrase", + "traits": { + "smithy.api#documentation": "

\n The natural language phrase to use for the semantic search. The phrase must be in English. The length constraint is in characters, not words.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.cloudtrail#SearchSampleQueriesMaxResults", + "traits": { + "smithy.api#documentation": "

\n The maximum number of results to return on a single page. The default value is 10.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

\n A token you can use to get the next page of results. The length constraint is in characters, not words.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#SearchSampleQueriesResponse": { + "type": "structure", + "members": { + "SearchResults": { + "target": "com.amazonaws.cloudtrail#SearchSampleQueriesSearchResults", + "traits": { + "smithy.api#documentation": "

\n A list of objects containing the search results ordered from most relevant to least relevant.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "

\n A token you can use to get the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#SearchSampleQueriesSearchPhrase": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 1000 + }, + "smithy.api#pattern": "^[ -~\\n]*$" + } + }, + "com.amazonaws.cloudtrail#SearchSampleQueriesSearchResult": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#SampleQueryName", + "traits": { + "smithy.api#documentation": "

\n The name of a sample query.\n

" + } + }, + "Description": { + "target": "com.amazonaws.cloudtrail#SampleQueryDescription", + "traits": { + "smithy.api#documentation": "

\n A longer description of a sample query.\n

" + } + }, + "SQL": { + "target": "com.amazonaws.cloudtrail#SampleQuerySQL", + "traits": { + "smithy.api#documentation": "

\n The SQL code of the sample query.\n

" + } + }, + "Relevance": { + "target": "com.amazonaws.cloudtrail#SampleQueryRelevance", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n A value between 0 and 1 indicating the similarity between the search phrase and result.\n

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

\n A search result returned by the SearchSampleQueries operation.\n

" + } + }, + "com.amazonaws.cloudtrail#SearchSampleQueriesSearchResults": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#SearchSampleQueriesSearchResult" + } + }, + "com.amazonaws.cloudtrail#SelectorField": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": "^[\\w|\\d|\\.|_]+$" + } + }, + "com.amazonaws.cloudtrail#SelectorName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.cloudtrail#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ServiceQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

\n This exception is thrown when the quota is exceeded. For information about CloudTrail quotas, see Service quotas \n in the Amazon Web Services General Reference.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#Source": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.cloudtrail#SourceConfig": { + "type": "structure", + "members": { + "ApplyToAllRegions": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the channel applies to a single Region or to all Regions.

" + } + }, + "AdvancedEventSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", + "traits": { + "smithy.api#documentation": "

The advanced event selectors that are configured for the channel.

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

Contains configuration information about the channel.

" + } + }, + "com.amazonaws.cloudtrail#SourceEventCategories": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#SourceEventCategory" + } + }, + "com.amazonaws.cloudtrail#SourceEventCategory": { + "type": "enum", + "members": { + "Management": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Management" + } + }, + "Data": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Data" + } + } + } + }, + "com.amazonaws.cloudtrail#StartDashboardRefresh": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#StartDashboardRefreshRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#StartDashboardRefreshResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

\nStarts a refresh of the specified dashboard.\n

\n

\n Each time a dashboard is refreshed, CloudTrail runs queries to populate the dashboard's widgets. CloudTrail must be granted permissions to run the StartQuery operation on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to each event data store. For more information, \n see Example: Allow CloudTrail to run queries to populate a dashboard in the CloudTrail User Guide.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#StartDashboardRefreshRequest": { + "type": "structure", + "members": { + "DashboardId": { + "target": "com.amazonaws.cloudtrail#DashboardArn", + "traits": { + "smithy.api#documentation": "

\nThe name or ARN of the dashboard.\n

", + "smithy.api#required": {} + } + }, + "QueryParameterValues": { + "target": "com.amazonaws.cloudtrail#QueryParameterValues", + "traits": { + "smithy.api#documentation": "

\n The query parameter values for the dashboard\n

\n

For custom dashboards, the following query parameters are valid: $StartTime$, $EndTime$, and $Period$.

\n

For managed dashboards, the following query parameters are valid: $StartTime$,\n $EndTime$, $Period$, and $EventDataStoreId$. The\n $EventDataStoreId$ query parameter is required.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#StartDashboardRefreshResponse": { + "type": "structure", + "members": { + "RefreshId": { + "target": "com.amazonaws.cloudtrail#RefreshId", + "traits": { + "smithy.api#documentation": "

\nThe refresh ID for the dashboard.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#StartEventDataStoreIngestion": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#StartEventDataStoreIngestionRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#StartEventDataStoreIngestionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To start ingestion, the event data store Status must be STOPPED_INGESTION \n and the eventCategory must be Management, Data, NetworkActivity, or ConfigurationItem.

" + } + }, + "com.amazonaws.cloudtrail#StartEventDataStoreIngestionRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN (or ID suffix of the ARN) of the event data store for which you want to start ingestion.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#StartEventDataStoreIngestionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#StartImport": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#StartImportRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#StartImportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#AccountHasOngoingImportException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#ImportNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidImportSourceException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an import of logged trail events from a source S3 bucket to a destination event\n data store. By default, CloudTrail only imports events contained in the S3 bucket's\n CloudTrail prefix and the prefixes inside the CloudTrail prefix, and does not check prefixes for other Amazon Web Services\n services. If you want to import CloudTrail events contained in another prefix, you\n must include the prefix in the S3LocationUri. For more considerations about\n importing trail events, see Considerations for copying trail events in the CloudTrail User Guide.

\n

When you start a new import, the Destinations and\n ImportSource parameters are required. Before starting a new import, disable\n any access control lists (ACLs) attached to the source S3 bucket. For more information\n about disabling ACLs, see Controlling ownership of\n objects and disabling ACLs for your bucket.

\n

When you retry an import, the ImportID parameter is required.

\n \n

If the destination event data store is for an organization, you must use the\n management account to import trail events. You cannot use the delegated administrator\n account for the organization.

\n " + } + }, + "com.amazonaws.cloudtrail#StartImportRequest": { + "type": "structure", + "members": { + "Destinations": { + "target": "com.amazonaws.cloudtrail#ImportDestinations", + "traits": { + "smithy.api#documentation": "

The ARN of the destination event data store. Use this parameter for a new import.\n

" + } + }, + "ImportSource": { + "target": "com.amazonaws.cloudtrail#ImportSource", + "traits": { + "smithy.api#documentation": "

The source S3 bucket for the import. Use this parameter for a new import.

" + } + }, + "StartEventTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Use with EndEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n When you specify a time range, CloudTrail checks the prefix and log file names to\n verify the names contain a date between the specified StartEventTime and\n EndEventTime before attempting to import events.

" + } + }, + "EndEventTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Use with StartEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n When you specify a time range, CloudTrail checks the prefix and log file names to\n verify the names contain a date between the specified StartEventTime and\n EndEventTime before attempting to import events.

" + } + }, + "ImportId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the import. Use this parameter when you are retrying an import.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#StartImportResponse": { + "type": "structure", + "members": { + "ImportId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the import.

" + } + }, + "Destinations": { + "target": "com.amazonaws.cloudtrail#ImportDestinations", + "traits": { + "smithy.api#documentation": "

The ARN of the destination event data store.

" + } + }, + "ImportSource": { + "target": "com.amazonaws.cloudtrail#ImportSource", + "traits": { + "smithy.api#documentation": "

The source S3 bucket for the import.

" + } + }, + "StartEventTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Used with EndEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n

" + } + }, + "EndEventTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Used with StartEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n

" + } + }, + "ImportStatus": { + "target": "com.amazonaws.cloudtrail#ImportStatus", + "traits": { + "smithy.api#documentation": "

Shows the status of the import after a StartImport request. An import\n finishes with a status of COMPLETED if there were no failures, or\n FAILED if there were failures.

" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp for the import's creation.

" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp of the import's last update, if applicable.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#StartLogging": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#StartLoggingRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#StartLoggingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidHomeRegionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts the recording of Amazon Web Services API calls and log file delivery for a trail.\n For a trail that is enabled in all Regions, this operation must be called from the Region\n in which the trail was created. This operation cannot be called on the shadow trails\n (replicated trails in other Regions) of a trail that is enabled in all Regions.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#StartLoggingRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name or the CloudTrail ARN of the trail for which CloudTrail\n logs Amazon Web Services API calls. The following is the format of a trail ARN.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

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

The request to CloudTrail to start logging Amazon Web Services API calls for an\n account.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#StartLoggingResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#StartQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#StartQueryRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#StartQueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientS3BucketPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidQueryStatementException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidS3BucketNameException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidS3PrefixException" + }, + { + "target": "com.amazonaws.cloudtrail#MaxConcurrentQueriesException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#S3BucketDoesNotExistException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a CloudTrail Lake query. Use the QueryStatement\n parameter to provide your SQL query, enclosed in single quotation marks. Use the optional\n DeliveryS3Uri parameter to deliver the query results to an S3\n bucket.

\n

\n StartQuery requires you specify either the QueryStatement parameter, or a QueryAlias and any QueryParameters. In the current release, \n the QueryAlias and QueryParameters parameters are used only for the queries that populate the CloudTrail Lake dashboards.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#StartQueryRequest": { + "type": "structure", + "members": { + "QueryStatement": { + "target": "com.amazonaws.cloudtrail#QueryStatement", + "traits": { + "smithy.api#documentation": "

The SQL code of your query.

" + } + }, + "DeliveryS3Uri": { + "target": "com.amazonaws.cloudtrail#DeliveryS3Uri", + "traits": { + "smithy.api#documentation": "

The URI for the S3 bucket where CloudTrail delivers the query results.

" + } + }, + "QueryAlias": { + "target": "com.amazonaws.cloudtrail#QueryAlias", + "traits": { + "smithy.api#documentation": "

\n The alias that identifies a query template.\n

" + } + }, + "QueryParameters": { + "target": "com.amazonaws.cloudtrail#QueryParameters", + "traits": { + "smithy.api#documentation": "

\n The query parameters for the specified QueryAlias.\n

" + } + }, + "EventDataStoreOwnerAccountId": { + "target": "com.amazonaws.cloudtrail#AccountId", + "traits": { + "smithy.api#documentation": "

\nThe account ID of the event data store owner.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#StartQueryResponse": { + "type": "structure", + "members": { + "QueryId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the started query.

" + } + }, + "EventDataStoreOwnerAccountId": { + "target": "com.amazonaws.cloudtrail#AccountId", + "traits": { + "smithy.api#documentation": "

\n The account ID of the event data store owner.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#StopEventDataStoreIngestion": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#StopEventDataStoreIngestionRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#StopEventDataStoreIngestionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To stop ingestion, the event data store Status must be ENABLED \n and the eventCategory must be Management, Data, NetworkActivity, or ConfigurationItem.

" + } + }, + "com.amazonaws.cloudtrail#StopEventDataStoreIngestionRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN (or ID suffix of the ARN) of the event data store for which you want to stop ingestion.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#StopEventDataStoreIngestionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#StopImport": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#StopImportRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#StopImportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ImportNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a specified import.

" + } + }, + "com.amazonaws.cloudtrail#StopImportRequest": { + "type": "structure", + "members": { + "ImportId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID of the import.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#StopImportResponse": { + "type": "structure", + "members": { + "ImportId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "

The ID for the import.

" + } + }, + "ImportSource": { + "target": "com.amazonaws.cloudtrail#ImportSource", + "traits": { + "smithy.api#documentation": "

The source S3 bucket for the import.

" + } + }, + "Destinations": { + "target": "com.amazonaws.cloudtrail#ImportDestinations", + "traits": { + "smithy.api#documentation": "

The ARN of the destination event data store.

" + } + }, + "ImportStatus": { + "target": "com.amazonaws.cloudtrail#ImportStatus", + "traits": { + "smithy.api#documentation": "

The status of the import.

" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp of the import's creation.

" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp of the import's last update.

" + } + }, + "StartEventTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Used with EndEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n

" + } + }, + "EndEventTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

Used with StartEventTime to bound a StartImport request, and\n limit imported trail events to only those events logged within a specified time period.\n

" + } + }, + "ImportStatistics": { + "target": "com.amazonaws.cloudtrail#ImportStatistics", + "traits": { + "smithy.api#documentation": "

Returns information on the stopped import.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#StopLogging": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#StopLoggingRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#StopLoggingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidHomeRegionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Suspends the recording of Amazon Web Services API calls and log file delivery for the\n specified trail. Under most circumstances, there is no need to use this action. You can\n update a trail without stopping it first. This action is the only way to stop recording.\n For a trail enabled in all Regions, this operation must be called from the Region in which\n the trail was created, or an InvalidHomeRegionException will occur. This\n operation cannot be called on the shadow trails (replicated trails in other Regions) of a\n trail enabled in all Regions.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#StopLoggingRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name or the CloudTrail ARN of the trail for which CloudTrail\n will stop logging Amazon Web Services API calls. The following is the format of a trail\n ARN.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

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

Passes the request to CloudTrail to stop logging Amazon Web Services API calls for\n the specified account.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#StopLoggingResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#String": { + "type": "string" + }, + "com.amazonaws.cloudtrail#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.cloudtrail#TagKey", + "traits": { + "smithy.api#documentation": "

The key in a key-value pair. The key must be must be no longer than 128 Unicode\n characters. The key must be unique for the resource to which it applies.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.cloudtrail#TagValue", + "traits": { + "smithy.api#documentation": "

The value in a key-value pair of a tag. The value must be no longer than 256 Unicode\n characters.

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

A custom key-value pair associated with a resource such as a CloudTrail\n trail, event data store, dashboard, or channel.

" + } + }, + "com.amazonaws.cloudtrail#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.cloudtrail#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.cloudtrail#TagsLimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TagsLimitExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The number of tags per trail, event data store, dashboard, or channel has exceeded the permitted amount. Currently, the limit is\n 50.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#TagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#Tag" + }, + "traits": { + "smithy.api#documentation": "

A list of tags.

", + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.cloudtrail#Template": { + "type": "enum", + "members": { + "API_ACTIVITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "API_ACTIVITY" + } + }, + "RESOURCE_ACCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_ACCESS" + } + }, + "USER_ACTIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_ACTIONS" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the type of the aggregation templates in the aggregation configuration. Valid values include API_ACTIVITY, RESOURCE_ACCESS and USER_ACTIONS.

" + } + }, + "com.amazonaws.cloudtrail#Templates": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#Template" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.cloudtrail#TerminationProtectionEnabled": { + "type": "boolean" + }, + "com.amazonaws.cloudtrail#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ThrottlingException", + "httpResponseCode": 429 + }, + "smithy.api#documentation": "

\n This exception is thrown when the request rate exceeds the limit. \n

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.cloudtrail#TimeOfDay": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{2}:[0-9]{2}$" + } + }, + "com.amazonaws.cloudtrail#Timestamps": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#Date" + } + }, + "com.amazonaws.cloudtrail#Trail": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Name of the trail set by calling CreateTrail. The maximum length is\n 128 characters.

" + } + }, + "S3BucketName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Name of the Amazon S3 bucket into which CloudTrail delivers your trail\n files. See Amazon S3\n Bucket naming rules.

" + } + }, + "S3KeyPrefix": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200\n characters.

" + } + }, + "SnsTopicName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

This field is no longer in use. Use SnsTopicARN.

" + } + }, + "SnsTopicARN": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send\n notifications when log files are delivered. The following is the format of a topic\n ARN.

\n

\n arn:aws:sns:us-east-2:123456789012:MyTopic\n

" + } + }, + "IncludeGlobalServiceEvents": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Set to True to include Amazon Web Services API calls\n from Amazon Web Services global services such as IAM. Otherwise, False.

" + } + }, + "IsMultiRegionTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail exists only in one Region or exists in all Regions.

" + } + }, + "HomeRegion": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The Region in which the trail was created.

" + } + }, + "TrailARN": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the ARN of the trail. The following is the format of a trail ARN.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

" + } + }, + "LogFileValidationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether log file validation is enabled.

" + } + }, + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log\n group to which CloudTrail logs will be delivered.

" + } + }, + "CloudWatchLogsRoleArn": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's\n log group.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the KMS key ID that encrypts the logs and digest files delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.

\n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" + } + }, + "HasCustomEventSelectors": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies if the trail has custom event selectors.

" + } + }, + "HasInsightSelectors": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether a trail has insight types specified in an InsightSelector\n list.

" + } + }, + "IsOrganizationTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail is an organization trail.

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

The settings for a trail.

" + } + }, + "com.amazonaws.cloudtrail#TrailAlreadyExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TrailAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the specified trail already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#TrailInfo": { + "type": "structure", + "members": { + "TrailARN": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The ARN of a trail.

" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The name of a trail.

" + } + }, + "HomeRegion": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region in which a trail was created.

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

Information about a CloudTrail trail, including the trail's name, home Region,\n and Amazon Resource Name (ARN).

" + } + }, + "com.amazonaws.cloudtrail#TrailList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#Trail" + } + }, + "com.amazonaws.cloudtrail#TrailNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#String" + } + }, + "com.amazonaws.cloudtrail#TrailNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TrailNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

This exception is thrown when the trail with the given name is not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.cloudtrail#TrailNotProvidedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TrailNotProvided", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

This exception is no longer in use.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.cloudtrail#Trails": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#TrailInfo" + } + }, + "com.amazonaws.cloudtrail#Type": { + "type": "enum", + "members": { + "TagContext": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TagContext" + } + }, + "RequestContext": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RequestContext" + } + } + } + }, + "com.amazonaws.cloudtrail#UUID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-f0-9\\-]+$" + } + }, + "com.amazonaws.cloudtrail#UnsupportedOperationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Brief description of the exception returned by the request.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "UnsupportedOperation", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This exception is thrown when the requested operation is not supported.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#UpdateChannel": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#UpdateChannelRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#UpdateChannelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ChannelAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#ChannelARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#ChannelNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreCategoryException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a channel specified by a required channel ARN or UUID.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#UpdateChannelRequest": { + "type": "structure", + "members": { + "Channel": { + "target": "com.amazonaws.cloudtrail#ChannelArn", + "traits": { + "smithy.api#documentation": "

The ARN or ID (the ARN suffix) of the channel that you want to update.

", + "smithy.api#required": {} + } + }, + "Destinations": { + "target": "com.amazonaws.cloudtrail#Destinations", + "traits": { + "smithy.api#documentation": "

The ARNs of event data stores that you want to log events arriving through the channel.

" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#ChannelName", + "traits": { + "smithy.api#documentation": "

\n Changes the name of the channel.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#UpdateChannelResponse": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.cloudtrail#ChannelArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel that was updated.

" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#ChannelName", + "traits": { + "smithy.api#documentation": "

The name of the channel that was updated.

" + } + }, + "Source": { + "target": "com.amazonaws.cloudtrail#Source", + "traits": { + "smithy.api#documentation": "

The event source of the channel that was updated.

" + } + }, + "Destinations": { + "target": "com.amazonaws.cloudtrail#Destinations", + "traits": { + "smithy.api#documentation": "

The event data stores that log events arriving through the channel.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#UpdateDashboard": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#UpdateDashboardRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#UpdateDashboardResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidQueryStatementException" + }, + { + "target": "com.amazonaws.cloudtrail#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

\nUpdates the specified dashboard.\n

\n

\n To set a refresh schedule, CloudTrail must be granted permissions to run the StartDashboardRefresh operation to refresh the dashboard on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to the dashboard. For more information, \n see \n Resource-based policy example for a dashboard in the CloudTrail User Guide.\n

\n

\n CloudTrail runs queries to populate the dashboard's widgets during a manual or scheduled refresh. CloudTrail must be granted permissions to run the StartQuery operation on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to each event data store. For more information, \n see Example: Allow CloudTrail to run queries to populate a dashboard in the CloudTrail User Guide.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#UpdateDashboardRequest": { + "type": "structure", + "members": { + "DashboardId": { + "target": "com.amazonaws.cloudtrail#DashboardArn", + "traits": { + "smithy.api#documentation": "

\n The name or ARN of the dashboard.\n

", + "smithy.api#required": {} + } + }, + "Widgets": { + "target": "com.amazonaws.cloudtrail#RequestWidgetList", + "traits": { + "smithy.api#documentation": "

\nAn array of widgets for the dashboard. A custom dashboard can have a maximum of 10 widgets.\n

\n

To add new widgets, pass in an array that includes the existing widgets along with any new widgets. Run the GetDashboard operation to get the list of widgets for the dashboard.

\n

To remove widgets, pass in an array that includes the existing widgets minus the widgets you want removed.

" + } + }, + "RefreshSchedule": { + "target": "com.amazonaws.cloudtrail#RefreshSchedule", + "traits": { + "smithy.api#documentation": "

\nThe refresh schedule configuration for the dashboard.\n

" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", + "traits": { + "smithy.api#documentation": "

\n Specifies whether termination protection is enabled for the dashboard. If termination protection is enabled, you cannot delete the dashboard until termination protection is disabled.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#UpdateDashboardResponse": { + "type": "structure", + "members": { + "DashboardArn": { + "target": "com.amazonaws.cloudtrail#DashboardArn", + "traits": { + "smithy.api#documentation": "

\nThe ARN for the dashboard.\n

" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#DashboardName", + "traits": { + "smithy.api#documentation": "

\nThe name for the dashboard.\n

" + } + }, + "Type": { + "target": "com.amazonaws.cloudtrail#DashboardType", + "traits": { + "smithy.api#documentation": "

\nThe type of dashboard.\n

" + } + }, + "Widgets": { + "target": "com.amazonaws.cloudtrail#WidgetList", + "traits": { + "smithy.api#documentation": "

\nAn array of widgets for the dashboard.\n

" + } + }, + "RefreshSchedule": { + "target": "com.amazonaws.cloudtrail#RefreshSchedule", + "traits": { + "smithy.api#documentation": "

\nThe refresh schedule for the dashboard, if configured.\n

" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", + "traits": { + "smithy.api#documentation": "

\n Indicates whether termination protection is enabled for the dashboard.\n

" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

\n The timestamp that shows when the dashboard was created.\n

" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

\n The timestamp that shows when the dashboard was updated.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#UpdateEventDataStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#UpdateEventDataStoreRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#UpdateEventDataStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreHasOngoingImportException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventSelectorsException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidInsightSelectorsException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidKmsKeyIdException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#KmsException" + }, + { + "target": "com.amazonaws.cloudtrail#KmsKeyNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + }, + { + "target": "com.amazonaws.cloudtrail#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an event data store. The required EventDataStore value is an ARN or\n the ID portion of the ARN. Other parameters are optional, but at least one optional\n parameter must be specified, or CloudTrail throws an error.\n RetentionPeriod is in days, and valid values are integers between 7 and\n 3653 if the BillingMode is set to EXTENDABLE_RETENTION_PRICING, or between 7 and 2557 if BillingMode is set to FIXED_RETENTION_PRICING. By default, TerminationProtection is enabled.

\n

For event data stores for CloudTrail events, AdvancedEventSelectors\n includes or excludes management, data, or network activity events in your event data store. For more\n information about AdvancedEventSelectors, see AdvancedEventSelectors.

\n

For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or non-Amazon Web Services events,\n AdvancedEventSelectors includes events of that type in your event data store.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#UpdateEventDataStoreRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN (or the ID suffix of the ARN) of the event data store that you want to\n update.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#EventDataStoreName", + "traits": { + "smithy.api#documentation": "

The event data store name.

" + } + }, + "AdvancedEventSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", + "traits": { + "smithy.api#documentation": "

The advanced event selectors used to select events for the event data store. You can\n configure up to five advanced event selectors for each event data store.

" + } + }, + "MultiRegionEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether an event data store collects events from all Regions, or only from the\n Region in which it was created.

" + } + }, + "OrganizationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether an event data store collects events logged for an organization in\n Organizations.

\n \n

Only the management account for the organization can convert an organization event data store to a non-organization event data store, or convert a non-organization event data store to \n an organization event data store.

\n " + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.cloudtrail#RetentionPeriod", + "traits": { + "smithy.api#documentation": "

The retention period of the event data store, in days. If BillingMode is set to EXTENDABLE_RETENTION_PRICING, you can set a retention period of\n up to 3653 days, the equivalent of 10 years. If BillingMode is set to FIXED_RETENTION_PRICING, you can set a retention period of\n up to 2557 days, the equivalent of seven years.

\n

CloudTrail Lake determines whether to retain an event by checking if the eventTime \n of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events \n when the eventTime is older than 90 days.

\n \n

If you decrease the retention period of an event data store, CloudTrail will remove any events with an eventTime older than the new retention period. For example, if the previous \n retention period was 365 days and you decrease it to 100 days, CloudTrail will remove events with an eventTime older than 100 days.

\n " + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", + "traits": { + "smithy.api#documentation": "

Indicates that termination protection is enabled and the event data store cannot be\n automatically deleted.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.cloudtrail#EventDataStoreKmsKeyId", + "traits": { + "smithy.api#documentation": "

Specifies the KMS key ID to use to encrypt the events delivered by\n CloudTrail. The value can be an alias name prefixed by alias/, a\n fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique\n identifier.

\n \n

Disabling or deleting the KMS key, or removing CloudTrail\n permissions on the key, prevents CloudTrail from logging events to the event data\n store, and prevents users from querying the data in the event data store that was\n encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you\n disable or delete a KMS key that you are using with an event data store,\n delete or back up your event data store.

\n \n

CloudTrail also supports KMS multi-Region keys. For more\n information about multi-Region keys, see Using multi-Region\n keys in the Key Management Service Developer Guide.

\n

Examples:

\n " + } + }, + "BillingMode": { + "target": "com.amazonaws.cloudtrail#BillingMode", + "traits": { + "smithy.api#documentation": "\n

You can't change the billing mode from EXTENDABLE_RETENTION_PRICING to FIXED_RETENTION_PRICING. If BillingMode is set to \n EXTENDABLE_RETENTION_PRICING and you want to use FIXED_RETENTION_PRICING instead, you'll need to stop ingestion on the event data store and create a new event data store that uses FIXED_RETENTION_PRICING.

\n \n

The billing mode for the event data store determines the cost \n for ingesting events and the default and maximum retention period for the event data store.

\n

The following are the possible values:

\n \n

For more information about CloudTrail pricing, \n see CloudTrail Pricing and \n Managing CloudTrail Lake costs.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#UpdateEventDataStoreResponse": { + "type": "structure", + "members": { + "EventDataStoreArn": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "

The ARN of the event data store.

" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#EventDataStoreName", + "traits": { + "smithy.api#documentation": "

The name of the event data store.

" + } + }, + "Status": { + "target": "com.amazonaws.cloudtrail#EventDataStoreStatus", + "traits": { + "smithy.api#documentation": "

The status of an event data store.

" + } + }, + "AdvancedEventSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", + "traits": { + "smithy.api#documentation": "

The advanced event selectors that are applied to the event data store.

" + } + }, + "MultiRegionEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the event data store includes events from all Regions, or only from\n the Region in which it was created.

" + } + }, + "OrganizationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether an event data store is collecting logged events for an organization in\n Organizations.

" + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.cloudtrail#RetentionPeriod", + "traits": { + "smithy.api#documentation": "

The retention period, in days.

" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether termination protection is enabled for the event data store.

" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp that shows when an event data store was first created.

" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "

The timestamp that shows when the event data store was last updated.\n UpdatedTimestamp is always either the same or newer than the time shown in\n CreatedTimestamp.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.cloudtrail#EventDataStoreKmsKeyId", + "traits": { + "smithy.api#documentation": "

Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.

\n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" + } + }, + "BillingMode": { + "target": "com.amazonaws.cloudtrail#BillingMode", + "traits": { + "smithy.api#documentation": "

The billing mode for the event data store.

" + } + }, + "FederationStatus": { + "target": "com.amazonaws.cloudtrail#FederationStatus", + "traits": { + "smithy.api#documentation": "

\n Indicates the Lake query federation status. The status is \n ENABLED if Lake query federation is enabled, or DISABLED if Lake query federation is disabled. You cannot delete an event data store if the FederationStatus is ENABLED.\n

" + } + }, + "FederationRoleArn": { + "target": "com.amazonaws.cloudtrail#FederationRoleArn", + "traits": { + "smithy.api#documentation": "

\n If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#UpdateTrail": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#UpdateTrailRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#UpdateTrailResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + }, + { + "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#CloudTrailInvalidClientTokenIdException" + }, + { + "target": "com.amazonaws.cloudtrail#CloudWatchLogsDeliveryUnavailableException" + }, + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientEncryptionPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientS3BucketPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientSnsTopicPolicyException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidCloudWatchLogsLogGroupArnException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidCloudWatchLogsRoleArnException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventSelectorsException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidHomeRegionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidKmsKeyIdException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidS3BucketNameException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidS3PrefixException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidSnsTopicNameException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#KmsException" + }, + { + "target": "com.amazonaws.cloudtrail#KmsKeyDisabledException" + }, + { + "target": "com.amazonaws.cloudtrail#KmsKeyNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#NoManagementAccountSLRExistsException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + }, + { + "target": "com.amazonaws.cloudtrail#S3BucketDoesNotExistException" + }, + { + "target": "com.amazonaws.cloudtrail#ThrottlingException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#TrailNotProvidedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates trail settings that control what events you are logging, and how to handle log\n files. Changes to a trail do not require stopping the CloudTrail service. Use this\n action to designate an existing bucket for log delivery. If the existing bucket has\n previously been a target for CloudTrail log files, an IAM policy\n exists for the bucket. UpdateTrail must be called from the Region in which the\n trail was created; otherwise, an InvalidHomeRegionException is thrown.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#UpdateTrailRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the trail or trail ARN. If Name is a trail name, the\n string must meet the following requirements:

\n \n

If Name is a trail ARN, it must be in the following format.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

", + "smithy.api#required": {} + } + }, + "S3BucketName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the Amazon S3 bucket designated for publishing log files.\n See Amazon S3\n Bucket naming rules.

" + } + }, + "S3KeyPrefix": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200\n characters.

" + } + }, + "SnsTopicName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name or ARN of the Amazon SNS topic defined for notification of log file\n delivery. The maximum length is 256 characters.

" + } + }, + "IncludeGlobalServiceEvents": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" + } + }, + "IsMultiRegionTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail applies only to the current Region or to all Regions. The\n default is false. If the trail exists only in the current Region and this value is set to\n true, shadow trails (replications of the trail) will be created in the other Regions. If\n the trail exists in all Regions and this value is set to false, the trail will remain in\n the Region where it was created, and its shadow trails in other Regions will be deleted. As\n a best practice, consider using trails that log events in all Regions.

" + } + }, + "EnableLogFileValidation": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether log file validation is enabled. The default is false.

\n \n

When you disable log file integrity validation, the chain of digest files is broken\n after one hour. CloudTrail does not create digest files for log files that were\n delivered during a period in which log file integrity validation was disabled. For\n example, if you enable log file integrity validation at noon on January 1, disable it at\n noon on January 2, and re-enable it at noon on January 10, digest files will not be\n created for the log files delivered from noon on January 2 to noon on January 10. The\n same applies whenever you stop CloudTrail logging or delete a trail.

\n " + } + }, + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that\n represents the log group to which CloudTrail logs are delivered. You must use a log\n group that exists in your account.

\n

Not required unless you specify CloudWatchLogsRoleArn.

" + } + }, + "CloudWatchLogsRoleArn": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's\n log group. You must use a role that exists in your account.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the KMS key ID to use to encrypt the logs and digest files delivered by CloudTrail. The value can be an alias name prefixed by \"alias/\", a fully specified ARN to\n an alias, a fully specified ARN to a key, or a globally unique identifier.

\n

CloudTrail also supports KMS multi-Region keys. For more\n information about multi-Region keys, see Using multi-Region\n keys in the Key Management Service Developer Guide.

\n

Examples:

\n " + } + }, + "IsOrganizationTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail is applied to all accounts in an organization in Organizations, or only for the current Amazon Web Services account. The default is false,\n and cannot be true unless the call is made on behalf of an Amazon Web Services account that\n is the management account for an organization in Organizations. If the trail is not an organization trail and this is set to\n true, the trail will be created in all Amazon Web Services accounts that\n belong to the organization. If the trail is an organization trail and this is set to\n false, the trail will remain in the current Amazon Web Services account but\n be deleted from all member accounts in the organization.

\n \n

Only the management account for the organization can convert an organization trail to a non-organization trail, or convert a non-organization trail to \n an organization trail.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies settings to update for the trail.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#UpdateTrailResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the trail.

" + } + }, + "S3BucketName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the Amazon S3 bucket designated for publishing log\n files.

" + } + }, + "S3KeyPrefix": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your IAM Log Files.

" + } + }, + "SnsTopicName": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

This field is no longer in use. Use SnsTopicARN.

" + } + }, + "SnsTopicARN": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send\n notifications when log files are delivered. The following is the format of a topic\n ARN.

\n

\n arn:aws:sns:us-east-2:123456789012:MyTopic\n

" + } + }, + "IncludeGlobalServiceEvents": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" + } + }, + "IsMultiRegionTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail exists in one Region or in all Regions.

" + } + }, + "TrailARN": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the ARN of the trail that was updated. The following is the format of a trail\n ARN.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

" + } + }, + "LogFileValidationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether log file integrity validation is enabled.

" + } + }, + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail\n logs are delivered.

" + } + }, + "CloudWatchLogsRoleArn": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's\n log group.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "

Specifies the KMS key ID that encrypts the logs and digest files delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the\n following format.

\n

\n arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\n

" + } + }, + "IsOrganizationTrail": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the trail is an organization trail.

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

Returns the objects or data listed below if successful. Otherwise, returns an\n error.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudtrail#ViewPropertiesKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._\\-]+$" + } + }, + "com.amazonaws.cloudtrail#ViewPropertiesMap": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudtrail#ViewPropertiesKey" + }, + "value": { + "target": "com.amazonaws.cloudtrail#ViewPropertiesValue" + } + }, + "com.amazonaws.cloudtrail#ViewPropertiesValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._\\- ]+$" + } + }, + "com.amazonaws.cloudtrail#Widget": { + "type": "structure", + "members": { + "QueryAlias": { + "target": "com.amazonaws.cloudtrail#QueryAlias", + "traits": { + "smithy.api#documentation": "

The query alias used to identify the query for the widget.\n

" + } + }, + "QueryStatement": { + "target": "com.amazonaws.cloudtrail#QueryStatement", + "traits": { + "smithy.api#documentation": "

\nThe SQL query statement for the widget.\n

" + } + }, + "QueryParameters": { + "target": "com.amazonaws.cloudtrail#QueryParameters", + "traits": { + "smithy.api#documentation": "

\n The query parameters for the widget.\n

" + } + }, + "ViewProperties": { + "target": "com.amazonaws.cloudtrail#ViewPropertiesMap", + "traits": { + "smithy.api#documentation": "

\n The view properties for the widget. For more information about view properties, see \n View properties for widgets\n in the CloudTrail User Guide..\n

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

\n A widget on a CloudTrail Lake dashboard.\n

" + } + }, + "com.amazonaws.cloudtrail#WidgetList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#Widget" + } + } + } +} diff --git a/codegen/aws-models/cognito-identity.json b/codegen/aws-models/cognito-identity.json new file mode 100644 index 0000000..38aebef --- /dev/null +++ b/codegen/aws-models/cognito-identity.json @@ -0,0 +1,3908 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.cognitoidentity#ARNString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + } + } + }, + "com.amazonaws.cognitoidentity#AWSCognitoIdentityService": { + "type": "service", + "version": "2014-06-30", + "operations": [ + { + "target": "com.amazonaws.cognitoidentity#CreateIdentityPool" + }, + { + "target": "com.amazonaws.cognitoidentity#DeleteIdentities" + }, + { + "target": "com.amazonaws.cognitoidentity#DeleteIdentityPool" + }, + { + "target": "com.amazonaws.cognitoidentity#DescribeIdentity" + }, + { + "target": "com.amazonaws.cognitoidentity#DescribeIdentityPool" + }, + { + "target": "com.amazonaws.cognitoidentity#GetCredentialsForIdentity" + }, + { + "target": "com.amazonaws.cognitoidentity#GetId" + }, + { + "target": "com.amazonaws.cognitoidentity#GetIdentityPoolRoles" + }, + { + "target": "com.amazonaws.cognitoidentity#GetOpenIdToken" + }, + { + "target": "com.amazonaws.cognitoidentity#GetOpenIdTokenForDeveloperIdentity" + }, + { + "target": "com.amazonaws.cognitoidentity#GetPrincipalTagAttributeMap" + }, + { + "target": "com.amazonaws.cognitoidentity#ListIdentities" + }, + { + "target": "com.amazonaws.cognitoidentity#ListIdentityPools" + }, + { + "target": "com.amazonaws.cognitoidentity#ListTagsForResource" + }, + { + "target": "com.amazonaws.cognitoidentity#LookupDeveloperIdentity" + }, + { + "target": "com.amazonaws.cognitoidentity#MergeDeveloperIdentities" + }, + { + "target": "com.amazonaws.cognitoidentity#SetIdentityPoolRoles" + }, + { + "target": "com.amazonaws.cognitoidentity#SetPrincipalTagAttributeMap" + }, + { + "target": "com.amazonaws.cognitoidentity#TagResource" + }, + { + "target": "com.amazonaws.cognitoidentity#UnlinkDeveloperIdentity" + }, + { + "target": "com.amazonaws.cognitoidentity#UnlinkIdentity" + }, + { + "target": "com.amazonaws.cognitoidentity#UntagResource" + }, + { + "target": "com.amazonaws.cognitoidentity#UpdateIdentityPool" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Cognito Identity", + "arnNamespace": "cognito-identity", + "cloudFormationName": "Cognito", + "cloudTrailEventSource": "cognito-identity.amazonaws.com", + "endpointPrefix": "cognito-identity" + }, + "aws.auth#sigv4": { + "name": "cognito-identity" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Amazon Cognito Federated Identities\n

Amazon Cognito Federated Identities is a web service that delivers scoped temporary\n credentials to mobile devices and other untrusted environments. It uniquely identifies a\n device and supplies the user with a consistent identity over the lifetime of an\n application.

\n

Using Amazon Cognito Federated Identities, you can enable authentication with one or\n more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon\n Cognito user pool, and you can also choose to support unauthenticated access from your app.\n Cognito delivers a unique identifier for each user and acts as an OpenID token provider\n trusted by Security Token Service (STS) to access temporary, limited-privilege Amazon Web Services credentials.

\n

For a description of the authentication flow from the Amazon Cognito Developer Guide\n see Authentication\n Flow.

\n

For more information see Amazon Cognito Federated\n Identities.

", + "smithy.api#title": "Amazon Cognito Identity", + "smithy.api#xmlNamespace": { + "uri": "http://cognito-identity.amazonaws.com/doc/2014-06-30/" + }, + "smithy.rules#endpointBdd": { + "version": "1.1", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "string" + }, + "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" + } + }, + "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": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + }, + true + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-east-1" + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-east-2" + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-west-1" + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-west-2" + ] + } + ], + "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://cognito-identity-fips.us-east-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://cognito-identity-fips.us-east-2.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://cognito-identity-fips.us-west-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://cognito-identity-fips.us-west-2.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://cognito-identity-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "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://cognito-identity-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "https://cognito-identity.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://cognito-identity.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "https://cognito-identity.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "root": 2, + "nodeCount": 18, + "nodes": "/////wAAAAH/////AAAAAAAAABEAAAADAAAAAQAAAAQF9eEQAAAAAgAAAAUF9eEQAAAAAwAAAAkAAAAGAAAABQAAAAcF9eEPAAAABgAAAAgF9eEOAAAABwX14QwF9eENAAAABAAAAAsAAAAKAAAABQX14QkF9eELAAAABQAAAAwF9eEKAAAABgAAAA0F9eEJAAAACAX14QQAAAAOAAAACQX14QUAAAAPAAAACgX14QYAAAAQAAAACwX14QcF9eEIAAAAAwX14QEAAAASAAAABQX14QIF9eED" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "string" + }, + "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" + } + }, + "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": [ + { + "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" + }, + { + "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": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-east-1" + ] + } + ], + "endpoint": { + "url": "https://cognito-identity-fips.us-east-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-east-2" + ] + } + ], + "endpoint": { + "url": "https://cognito-identity-fips.us-east-2.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-west-1" + ] + } + ], + "endpoint": { + "url": "https://cognito-identity-fips.us-west-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-west-2" + ] + } + ], + "endpoint": { + "url": "https://cognito-identity-fips.us-west-2.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://cognito-identity-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "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 + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cognito-identity-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "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": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://cognito-identity.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://cognito-identity.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "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://cognito-identity.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cognito-identity.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cognito-identity-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": { + "url": "https://cognito-identity.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cognito-identity-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cognito-identity.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cognito-identity-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cognito-identity.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cognito-identity-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cognito-identity.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cognito-identity-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cognito-identity.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cognito-identity-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cognito-identity.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cognito-identity-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cognito-identity.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cognito-identity-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cognito-identity.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cognito-identity-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cognito-identity-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cognito-identity.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cognito-identity.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cognito-identity-fips.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cognito-identity-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cognito-identity-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cognito-identity.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cognito-identity.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cognito-identity-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": { + "url": "https://cognito-identity.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": { + "url": "https://cognito-identity-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": { + "url": "https://cognito-identity.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.cognitoidentity#AccessKeyString": { + "type": "string" + }, + "com.amazonaws.cognitoidentity#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 15 + }, + "smithy.api#pattern": "^\\d+$" + } + }, + "com.amazonaws.cognitoidentity#AmbiguousRoleResolutionType": { + "type": "enum", + "members": { + "AUTHENTICATED_ROLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AuthenticatedRole" + } + }, + "DENY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deny" + } + } + } + }, + "com.amazonaws.cognitoidentity#ClaimName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+$" + } + }, + "com.amazonaws.cognitoidentity#ClaimValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.cognitoidentity#ClassicFlow": { + "type": "boolean" + }, + "com.amazonaws.cognitoidentity#CognitoIdentityProvider": { + "type": "structure", + "members": { + "ProviderName": { + "target": "com.amazonaws.cognitoidentity#CognitoIdentityProviderName", + "traits": { + "smithy.api#documentation": "

The provider name for an Amazon Cognito user pool. For example,\n cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.

" + } + }, + "ClientId": { + "target": "com.amazonaws.cognitoidentity#CognitoIdentityProviderClientId", + "traits": { + "smithy.api#documentation": "

The client ID for the Amazon Cognito user pool.

" + } + }, + "ServerSideTokenCheck": { + "target": "com.amazonaws.cognitoidentity#CognitoIdentityProviderTokenCheck", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

TRUE if server-side token validation is enabled for the identity provider’s\n token.

\n

Once you set ServerSideTokenCheck to TRUE for an identity pool, that\n identity pool will check with the integrated user pools to make sure that the user has not\n been globally signed out or deleted before the identity pool provides an OIDC token or\n Amazon Web Services credentials for the user.

\n

If the user is signed out or deleted, the identity pool will return a 400 Not\n Authorized error.

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

A provider representing an Amazon Cognito user pool and its client ID.

" + } + }, + "com.amazonaws.cognitoidentity#CognitoIdentityProviderClientId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\w_]+$" + } + }, + "com.amazonaws.cognitoidentity#CognitoIdentityProviderList": { + "type": "list", + "member": { + "target": "com.amazonaws.cognitoidentity#CognitoIdentityProvider" + } + }, + "com.amazonaws.cognitoidentity#CognitoIdentityProviderName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\w._:/-]+$" + } + }, + "com.amazonaws.cognitoidentity#CognitoIdentityProviderTokenCheck": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.cognitoidentity#ConcurrentModificationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cognitoidentity#String", + "traits": { + "smithy.api#documentation": "

The message returned by a ConcurrentModificationException.

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

Thrown if there are parallel requests to modify a resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cognitoidentity#CreateIdentityPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentity#CreateIdentityPoolInput" + }, + "output": { + "target": "com.amazonaws.cognitoidentity#IdentityPool" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentity#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentity#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentity#LimitExceededException" + }, + { + "target": "com.amazonaws.cognitoidentity#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceConflictException" + }, + { + "target": "com.amazonaws.cognitoidentity#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new identity pool. The identity pool is a store of user identity\n information that is specific to your Amazon Web Services account. The keys for\n SupportedLoginProviders are as follows:

\n \n \n

If you don't provide a value for a parameter, Amazon Cognito sets it to its default value. \n

\n \n

You must use Amazon Web Services developer credentials to call this\n operation.

" + } + }, + "com.amazonaws.cognitoidentity#CreateIdentityPoolInput": { + "type": "structure", + "members": { + "IdentityPoolName": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolName", + "traits": { + "smithy.api#documentation": "

A string that you provide.

", + "smithy.api#required": {} + } + }, + "AllowUnauthenticatedIdentities": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolUnauthenticated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

TRUE if the identity pool supports unauthenticated logins.

", + "smithy.api#required": {} + } + }, + "AllowClassicFlow": { + "target": "com.amazonaws.cognitoidentity#ClassicFlow", + "traits": { + "smithy.api#documentation": "

Enables or disables the Basic (Classic) authentication flow. For more information, see\n Identity Pools (Federated Identities) Authentication Flow in the\n Amazon Cognito Developer Guide.

" + } + }, + "SupportedLoginProviders": { + "target": "com.amazonaws.cognitoidentity#IdentityProviders", + "traits": { + "smithy.api#documentation": "

Optional key:value pairs mapping provider names to provider app IDs.

" + } + }, + "DeveloperProviderName": { + "target": "com.amazonaws.cognitoidentity#DeveloperProviderName", + "traits": { + "smithy.api#documentation": "

The \"domain\" by which Cognito will refer to your users. This name acts as a\n placeholder that allows your backend and the Cognito service to communicate about the\n developer provider. For the DeveloperProviderName, you can use letters as well\n as period (.), underscore (_), and dash\n (-).

\n

Once you have set a developer provider name, you cannot change it. Please take care\n in setting this parameter.

" + } + }, + "OpenIdConnectProviderARNs": { + "target": "com.amazonaws.cognitoidentity#OIDCProviderList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the OpenID Connect providers.

" + } + }, + "CognitoIdentityProviders": { + "target": "com.amazonaws.cognitoidentity#CognitoIdentityProviderList", + "traits": { + "smithy.api#documentation": "

An array of Amazon Cognito user pools and their client IDs.

" + } + }, + "SamlProviderARNs": { + "target": "com.amazonaws.cognitoidentity#SAMLProviderList", + "traits": { + "smithy.api#documentation": "

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity\n pool.

" + } + }, + "IdentityPoolTags": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolTagsType", + "traits": { + "smithy.api#documentation": "

Tags to assign to the identity pool. A tag is a label that you can apply to identity\n pools to categorize and manage them in different ways, such as by purpose, owner,\n environment, or other criteria.

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

Input to the CreateIdentityPool action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentity#Credentials": { + "type": "structure", + "members": { + "AccessKeyId": { + "target": "com.amazonaws.cognitoidentity#AccessKeyString", + "traits": { + "smithy.api#documentation": "

The Access Key portion of the credentials.

" + } + }, + "SecretKey": { + "target": "com.amazonaws.cognitoidentity#SecretKeyString", + "traits": { + "smithy.api#documentation": "

The Secret Access Key portion of the credentials

" + } + }, + "SessionToken": { + "target": "com.amazonaws.cognitoidentity#SessionTokenString", + "traits": { + "smithy.api#documentation": "

The Session Token portion of the credentials

" + } + }, + "Expiration": { + "target": "com.amazonaws.cognitoidentity#DateType", + "traits": { + "smithy.api#documentation": "

The date at which these credentials will expire.

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

Credentials for the provided identity ID.

" + } + }, + "com.amazonaws.cognitoidentity#DateType": { + "type": "timestamp" + }, + "com.amazonaws.cognitoidentity#DeleteIdentities": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentity#DeleteIdentitiesInput" + }, + "output": { + "target": "com.amazonaws.cognitoidentity#DeleteIdentitiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentity#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentity#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentity#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes identities from an identity pool. You can specify a list of 1-60 identities\n that you want to delete.

\n

You must use Amazon Web Services developer credentials to call this\n operation.

" + } + }, + "com.amazonaws.cognitoidentity#DeleteIdentitiesInput": { + "type": "structure", + "members": { + "IdentityIdsToDelete": { + "target": "com.amazonaws.cognitoidentity#IdentityIdList", + "traits": { + "smithy.api#documentation": "

A list of 1-60 identities that you want to delete.

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

Input to the DeleteIdentities action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentity#DeleteIdentitiesResponse": { + "type": "structure", + "members": { + "UnprocessedIdentityIds": { + "target": "com.amazonaws.cognitoidentity#UnprocessedIdentityIdList", + "traits": { + "smithy.api#documentation": "

An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and\n IdentityId.

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

Returned in response to a successful DeleteIdentities\n operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cognitoidentity#DeleteIdentityPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentity#DeleteIdentityPoolInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentity#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentity#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentity#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentity#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an identity pool. Once a pool is deleted, users will not be able to\n authenticate with the pool.

\n

You must use Amazon Web Services developer credentials to call this\n operation.

" + } + }, + "com.amazonaws.cognitoidentity#DeleteIdentityPoolInput": { + "type": "structure", + "members": { + "IdentityPoolId": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolId", + "traits": { + "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

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

Input to the DeleteIdentityPool action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentity#DescribeIdentity": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentity#DescribeIdentityInput" + }, + "output": { + "target": "com.amazonaws.cognitoidentity#IdentityDescription" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentity#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentity#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentity#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentity#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns metadata related to the given identity, including when the identity was\n created and any associated linked logins.

\n

You must use Amazon Web Services developer credentials to call this\n operation.

" + } + }, + "com.amazonaws.cognitoidentity#DescribeIdentityInput": { + "type": "structure", + "members": { + "IdentityId": { + "target": "com.amazonaws.cognitoidentity#IdentityId", + "traits": { + "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

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

Input to the DescribeIdentity action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentity#DescribeIdentityPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentity#DescribeIdentityPoolInput" + }, + "output": { + "target": "com.amazonaws.cognitoidentity#IdentityPool" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentity#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentity#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentity#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentity#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets details about a particular identity pool, including the pool name, ID\n description, creation date, and current number of users.

\n

You must use Amazon Web Services developer credentials to call this\n operation.

" + } + }, + "com.amazonaws.cognitoidentity#DescribeIdentityPoolInput": { + "type": "structure", + "members": { + "IdentityPoolId": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolId", + "traits": { + "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

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

Input to the DescribeIdentityPool action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentity#DeveloperProviderName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\w._-]+$" + } + }, + "com.amazonaws.cognitoidentity#DeveloperUserAlreadyRegisteredException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cognitoidentity#String", + "traits": { + "smithy.api#documentation": "

This developer user identifier is already registered with Cognito.

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

The provided developer user identifier is already registered with Cognito under a\n different identity ID.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cognitoidentity#DeveloperUserIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.cognitoidentity#DeveloperUserIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.cognitoidentity#DeveloperUserIdentifier" + } + }, + "com.amazonaws.cognitoidentity#ErrorCode": { + "type": "enum", + "members": { + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessDenied" + } + }, + "INTERNAL_SERVER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InternalServerError" + } + } + } + }, + "com.amazonaws.cognitoidentity#ExternalServiceException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cognitoidentity#String", + "traits": { + "smithy.api#documentation": "

The message returned by an ExternalServiceException

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

An exception thrown when a dependent service such as Facebook or Twitter is not\n responding

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cognitoidentity#GetCredentialsForIdentity": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentity#GetCredentialsForIdentityInput" + }, + "output": { + "target": "com.amazonaws.cognitoidentity#GetCredentialsForIdentityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentity#ExternalServiceException" + }, + { + "target": "com.amazonaws.cognitoidentity#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentity#InvalidIdentityPoolConfigurationException" + }, + { + "target": "com.amazonaws.cognitoidentity#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentity#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceConflictException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentity#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#auth": [], + "smithy.api#documentation": "

Returns credentials for the provided identity ID. Any provided logins will be\n validated against supported login providers. If the token is for\n cognito-identity.amazonaws.com, it will be passed through to Security Token Service with the appropriate role for the token.

\n

This is a public API. You do not need any credentials to call this API.

", + "smithy.api#optionalAuth": {} + } + }, + "com.amazonaws.cognitoidentity#GetCredentialsForIdentityInput": { + "type": "structure", + "members": { + "IdentityId": { + "target": "com.amazonaws.cognitoidentity#IdentityId", + "traits": { + "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

", + "smithy.api#required": {} + } + }, + "Logins": { + "target": "com.amazonaws.cognitoidentity#LoginsMap", + "traits": { + "smithy.api#documentation": "

A set of optional name-value pairs that map provider names to provider tokens. The\n name-value pair will follow the syntax \"provider_name\":\n \"provider_user_identifier\".

\n

Logins should not be specified when trying to get credentials for an unauthenticated\n identity.

\n

The Logins parameter is required when using identities associated with external\n identity providers such as Facebook. For examples of Logins maps, see the code\n examples in the External Identity\n Providers section of the Amazon Cognito Developer Guide.

" + } + }, + "CustomRoleArn": { + "target": "com.amazonaws.cognitoidentity#ARNString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were\n received in the token from the identity provider. For example, a SAML-based identity\n provider. This parameter is optional for identity providers that do not support role\n customization.

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

Input to the GetCredentialsForIdentity action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentity#GetCredentialsForIdentityResponse": { + "type": "structure", + "members": { + "IdentityId": { + "target": "com.amazonaws.cognitoidentity#IdentityId", + "traits": { + "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

" + } + }, + "Credentials": { + "target": "com.amazonaws.cognitoidentity#Credentials", + "traits": { + "smithy.api#documentation": "

Credentials for the provided identity ID.

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

Returned in response to a successful GetCredentialsForIdentity\n operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cognitoidentity#GetId": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentity#GetIdInput" + }, + "output": { + "target": "com.amazonaws.cognitoidentity#GetIdResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentity#ExternalServiceException" + }, + { + "target": "com.amazonaws.cognitoidentity#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentity#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentity#LimitExceededException" + }, + { + "target": "com.amazonaws.cognitoidentity#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceConflictException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentity#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#auth": [], + "smithy.api#documentation": "

Generates (or retrieves) IdentityID. Supplying multiple logins will create an\n implicit linked account.

\n

This is a public API. You do not need any credentials to call this API.

", + "smithy.api#optionalAuth": {} + } + }, + "com.amazonaws.cognitoidentity#GetIdInput": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.cognitoidentity#AccountId", + "traits": { + "smithy.api#documentation": "

A standard Amazon Web Services account ID (9+ digits).

" + } + }, + "IdentityPoolId": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolId", + "traits": { + "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

", + "smithy.api#required": {} + } + }, + "Logins": { + "target": "com.amazonaws.cognitoidentity#LoginsMap", + "traits": { + "smithy.api#documentation": "

A set of optional name-value pairs that map provider names to provider tokens. The\n available provider names for Logins are as follows:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to the GetId action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentity#GetIdResponse": { + "type": "structure", + "members": { + "IdentityId": { + "target": "com.amazonaws.cognitoidentity#IdentityId", + "traits": { + "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

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

Returned in response to a GetId request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cognitoidentity#GetIdentityPoolRoles": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentity#GetIdentityPoolRolesInput" + }, + "output": { + "target": "com.amazonaws.cognitoidentity#GetIdentityPoolRolesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentity#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentity#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentity#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceConflictException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentity#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the roles for an identity pool.

\n

You must use Amazon Web Services developer credentials to call this\n operation.

" + } + }, + "com.amazonaws.cognitoidentity#GetIdentityPoolRolesInput": { + "type": "structure", + "members": { + "IdentityPoolId": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolId", + "traits": { + "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

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

Input to the GetIdentityPoolRoles action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentity#GetIdentityPoolRolesResponse": { + "type": "structure", + "members": { + "IdentityPoolId": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolId", + "traits": { + "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

" + } + }, + "Roles": { + "target": "com.amazonaws.cognitoidentity#RolesMap", + "traits": { + "smithy.api#documentation": "

The map of roles associated with this pool. Currently only authenticated and\n unauthenticated roles are supported.

" + } + }, + "RoleMappings": { + "target": "com.amazonaws.cognitoidentity#RoleMappingMap", + "traits": { + "smithy.api#documentation": "

How users for a specific identity provider are to mapped to roles. This is a\n String-to-RoleMapping object map. The string identifies the identity\n provider, for example, graph.facebook.com or\n cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id.

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

Returned in response to a successful GetIdentityPoolRoles\n operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cognitoidentity#GetOpenIdToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentity#GetOpenIdTokenInput" + }, + "output": { + "target": "com.amazonaws.cognitoidentity#GetOpenIdTokenResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentity#ExternalServiceException" + }, + { + "target": "com.amazonaws.cognitoidentity#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentity#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentity#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceConflictException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentity#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#auth": [], + "smithy.api#documentation": "

Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by\n GetId. You can optionally add additional logins for the identity.\n Supplying multiple logins creates an implicit link.

\n

The OpenID token is valid for 10 minutes.

\n

This is a public API. You do not need any credentials to call this API.

", + "smithy.api#optionalAuth": {} + } + }, + "com.amazonaws.cognitoidentity#GetOpenIdTokenForDeveloperIdentity": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentity#GetOpenIdTokenForDeveloperIdentityInput" + }, + "output": { + "target": "com.amazonaws.cognitoidentity#GetOpenIdTokenForDeveloperIdentityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentity#DeveloperUserAlreadyRegisteredException" + }, + { + "target": "com.amazonaws.cognitoidentity#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentity#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentity#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceConflictException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentity#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Registers (or retrieves) a Cognito IdentityId and an OpenID Connect\n token for a user authenticated by your backend authentication process. Supplying multiple\n logins will create an implicit linked account. You can only specify one developer provider\n as part of the Logins map, which is linked to the identity pool. The developer\n provider is the \"domain\" by which Cognito will refer to your users.

\n

You can use GetOpenIdTokenForDeveloperIdentity to create a new identity\n and to link new logins (that is, user credentials issued by a public provider or developer\n provider) to an existing identity. When you want to create a new identity, the\n IdentityId should be null. When you want to associate a new login with an\n existing authenticated/unauthenticated identity, you can do so by providing the existing\n IdentityId. This API will create the identity in the specified\n IdentityPoolId.

\n

You must use Amazon Web Services developer credentials to call this\n operation.

" + } + }, + "com.amazonaws.cognitoidentity#GetOpenIdTokenForDeveloperIdentityInput": { + "type": "structure", + "members": { + "IdentityPoolId": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolId", + "traits": { + "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

", + "smithy.api#required": {} + } + }, + "IdentityId": { + "target": "com.amazonaws.cognitoidentity#IdentityId", + "traits": { + "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

" + } + }, + "Logins": { + "target": "com.amazonaws.cognitoidentity#LoginsMap", + "traits": { + "smithy.api#documentation": "

A set of optional name-value pairs that map provider names to provider tokens. Each\n name-value pair represents a user from a public provider or developer provider. If the user\n is from a developer provider, the name-value pair will follow the syntax\n \"developer_provider_name\": \"developer_user_identifier\". The developer\n provider is the \"domain\" by which Cognito will refer to your users; you provided this\n domain while creating/updating the identity pool. The developer user identifier is an\n identifier from your backend that uniquely identifies a user. When you create an identity\n pool, you can specify the supported logins.

", + "smithy.api#required": {} + } + }, + "PrincipalTags": { + "target": "com.amazonaws.cognitoidentity#PrincipalTags", + "traits": { + "smithy.api#documentation": "

Use this operation to configure attribute mappings for custom providers.

" + } + }, + "TokenDuration": { + "target": "com.amazonaws.cognitoidentity#TokenDuration", + "traits": { + "smithy.api#documentation": "

The expiration time of the token, in seconds. You can specify a custom expiration\n time for the token so that you can cache it. If you don't provide an expiration time, the\n token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary\n Amazon Web Services credentials, which are valid for a maximum of one hour. The maximum\n token duration you can set is 24 hours. You should take care in setting the expiration time\n for a token, as there are significant security implications: an attacker could use a leaked\n token to access your Amazon Web Services resources for the token's duration.

\n \n

Please provide for a small grace period, usually no more than 5 minutes, to\n account for clock skew.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Input to the GetOpenIdTokenForDeveloperIdentity action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentity#GetOpenIdTokenForDeveloperIdentityResponse": { + "type": "structure", + "members": { + "IdentityId": { + "target": "com.amazonaws.cognitoidentity#IdentityId", + "traits": { + "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

" + } + }, + "Token": { + "target": "com.amazonaws.cognitoidentity#OIDCToken", + "traits": { + "smithy.api#documentation": "

An OpenID token.

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

Returned in response to a successful GetOpenIdTokenForDeveloperIdentity\n request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cognitoidentity#GetOpenIdTokenInput": { + "type": "structure", + "members": { + "IdentityId": { + "target": "com.amazonaws.cognitoidentity#IdentityId", + "traits": { + "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

", + "smithy.api#required": {} + } + }, + "Logins": { + "target": "com.amazonaws.cognitoidentity#LoginsMap", + "traits": { + "smithy.api#documentation": "

A set of optional name-value pairs that map provider names to provider tokens. When\n using graph.facebook.com and www.amazon.com, supply the access_token returned from the\n provider's authflow. For accounts.google.com, an Amazon Cognito user pool provider, or any\n other OpenID Connect provider, always include the id_token.

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

Input to the GetOpenIdToken action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentity#GetOpenIdTokenResponse": { + "type": "structure", + "members": { + "IdentityId": { + "target": "com.amazonaws.cognitoidentity#IdentityId", + "traits": { + "smithy.api#documentation": "

A unique identifier in the format REGION:GUID. Note that the IdentityId returned may\n not match the one passed on input.

" + } + }, + "Token": { + "target": "com.amazonaws.cognitoidentity#OIDCToken", + "traits": { + "smithy.api#documentation": "

An OpenID token, valid for 10 minutes.

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

Returned in response to a successful GetOpenIdToken request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cognitoidentity#GetPrincipalTagAttributeMap": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentity#GetPrincipalTagAttributeMapInput" + }, + "output": { + "target": "com.amazonaws.cognitoidentity#GetPrincipalTagAttributeMapResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentity#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentity#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentity#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentity#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Use GetPrincipalTagAttributeMap to list all mappings between\n PrincipalTags and user attributes.

" + } + }, + "com.amazonaws.cognitoidentity#GetPrincipalTagAttributeMapInput": { + "type": "structure", + "members": { + "IdentityPoolId": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolId", + "traits": { + "smithy.api#documentation": "

You can use this operation to get the ID of the Identity Pool you setup attribute\n mappings for.

", + "smithy.api#required": {} + } + }, + "IdentityProviderName": { + "target": "com.amazonaws.cognitoidentity#IdentityProviderName", + "traits": { + "smithy.api#documentation": "

You can use this operation to get the provider name.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentity#GetPrincipalTagAttributeMapResponse": { + "type": "structure", + "members": { + "IdentityPoolId": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolId", + "traits": { + "smithy.api#documentation": "

You can use this operation to get the ID of the Identity Pool you setup attribute\n mappings for.

" + } + }, + "IdentityProviderName": { + "target": "com.amazonaws.cognitoidentity#IdentityProviderName", + "traits": { + "smithy.api#documentation": "

You can use this operation to get the provider name.

" + } + }, + "UseDefaults": { + "target": "com.amazonaws.cognitoidentity#UseDefaults", + "traits": { + "smithy.api#documentation": "

You can use this operation to list

" + } + }, + "PrincipalTags": { + "target": "com.amazonaws.cognitoidentity#PrincipalTags", + "traits": { + "smithy.api#documentation": "

You can use this operation to add principal tags. The\n PrincipalTagsoperation enables you to reference user attributes in your\n IAM permissions policy.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cognitoidentity#HideDisabled": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.cognitoidentity#IdentitiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.cognitoidentity#IdentityDescription" + } + }, + "com.amazonaws.cognitoidentity#IdentityDescription": { + "type": "structure", + "members": { + "IdentityId": { + "target": "com.amazonaws.cognitoidentity#IdentityId", + "traits": { + "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

" + } + }, + "Logins": { + "target": "com.amazonaws.cognitoidentity#LoginsList", + "traits": { + "smithy.api#documentation": "

The provider names.

" + } + }, + "CreationDate": { + "target": "com.amazonaws.cognitoidentity#DateType", + "traits": { + "smithy.api#documentation": "

Date on which the identity was created.

" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.cognitoidentity#DateType", + "traits": { + "smithy.api#documentation": "

Date on which the identity was last modified.

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

A description of the identity.

" + } + }, + "com.amazonaws.cognitoidentity#IdentityId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 55 + }, + "smithy.api#pattern": "^[\\w-]+:[0-9a-f-]+$" + } + }, + "com.amazonaws.cognitoidentity#IdentityIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.cognitoidentity#IdentityId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60 + } + } + }, + "com.amazonaws.cognitoidentity#IdentityPool": { + "type": "structure", + "members": { + "IdentityPoolId": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolId", + "traits": { + "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

", + "smithy.api#required": {} + } + }, + "IdentityPoolName": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolName", + "traits": { + "smithy.api#documentation": "

A string that you provide.

", + "smithy.api#required": {} + } + }, + "AllowUnauthenticatedIdentities": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolUnauthenticated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

TRUE if the identity pool supports unauthenticated logins.

", + "smithy.api#required": {} + } + }, + "AllowClassicFlow": { + "target": "com.amazonaws.cognitoidentity#ClassicFlow", + "traits": { + "smithy.api#documentation": "

Enables or disables the Basic (Classic) authentication flow. For more information, see\n Identity Pools (Federated Identities) Authentication Flow in the\n Amazon Cognito Developer Guide.

" + } + }, + "SupportedLoginProviders": { + "target": "com.amazonaws.cognitoidentity#IdentityProviders", + "traits": { + "smithy.api#documentation": "

Optional key:value pairs mapping provider names to provider app IDs.

" + } + }, + "DeveloperProviderName": { + "target": "com.amazonaws.cognitoidentity#DeveloperProviderName", + "traits": { + "smithy.api#documentation": "

The \"domain\" by which Cognito will refer to your users.

" + } + }, + "OpenIdConnectProviderARNs": { + "target": "com.amazonaws.cognitoidentity#OIDCProviderList", + "traits": { + "smithy.api#documentation": "

The ARNs of the OpenID Connect providers.

" + } + }, + "CognitoIdentityProviders": { + "target": "com.amazonaws.cognitoidentity#CognitoIdentityProviderList", + "traits": { + "smithy.api#documentation": "

A list representing an Amazon Cognito user pool and its client ID.

" + } + }, + "SamlProviderARNs": { + "target": "com.amazonaws.cognitoidentity#SAMLProviderList", + "traits": { + "smithy.api#documentation": "

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity\n pool.

" + } + }, + "IdentityPoolTags": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolTagsType", + "traits": { + "smithy.api#documentation": "

The tags that are assigned to the identity pool. A tag is a label that you can apply to\n identity pools to categorize and manage them in different ways, such as by purpose, owner,\n environment, or other criteria.

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

An object representing an Amazon Cognito identity pool.

" + } + }, + "com.amazonaws.cognitoidentity#IdentityPoolId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 55 + }, + "smithy.api#pattern": "^[\\w-]+:[0-9a-f-]+$" + } + }, + "com.amazonaws.cognitoidentity#IdentityPoolName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\w\\s+=,.@-]+$" + } + }, + "com.amazonaws.cognitoidentity#IdentityPoolShortDescription": { + "type": "structure", + "members": { + "IdentityPoolId": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolId", + "traits": { + "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

" + } + }, + "IdentityPoolName": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolName", + "traits": { + "smithy.api#documentation": "

A string that you provide.

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

A description of the identity pool.

" + } + }, + "com.amazonaws.cognitoidentity#IdentityPoolTagsListType": { + "type": "list", + "member": { + "target": "com.amazonaws.cognitoidentity#TagKeysType" + } + }, + "com.amazonaws.cognitoidentity#IdentityPoolTagsType": { + "type": "map", + "key": { + "target": "com.amazonaws.cognitoidentity#TagKeysType" + }, + "value": { + "target": "com.amazonaws.cognitoidentity#TagValueType" + } + }, + "com.amazonaws.cognitoidentity#IdentityPoolUnauthenticated": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.cognitoidentity#IdentityPoolsList": { + "type": "list", + "member": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolShortDescription" + } + }, + "com.amazonaws.cognitoidentity#IdentityProviderId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\w.;_/-]+$" + } + }, + "com.amazonaws.cognitoidentity#IdentityProviderName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.cognitoidentity#IdentityProviderToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.cognitoidentity#IdentityProviders": { + "type": "map", + "key": { + "target": "com.amazonaws.cognitoidentity#IdentityProviderName" + }, + "value": { + "target": "com.amazonaws.cognitoidentity#IdentityProviderId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.cognitoidentity#InternalErrorException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cognitoidentity#String", + "traits": { + "smithy.api#documentation": "

The message returned by an InternalErrorException.

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

Thrown when the service encounters an error during processing the request.

", + "smithy.api#error": "server" + } + }, + "com.amazonaws.cognitoidentity#InvalidIdentityPoolConfigurationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cognitoidentity#String", + "traits": { + "smithy.api#documentation": "

The message returned for an InvalidIdentityPoolConfigurationException\n

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

If you provided authentication information in the request, the identity pool has no\n authenticated role configured, or STS returned an error response to the\n request to assume the authenticated role from the identity pool. If you provided no\n authentication information in the request, the identity pool has no unauthenticated role\n configured, or STS returned an error response to the request to assume the\n unauthenticated role from the identity pool.

\n

Your role trust policy must grant AssumeRoleWithWebIdentity permissions to cognito-identity.amazonaws.com.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cognitoidentity#InvalidParameterException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cognitoidentity#String", + "traits": { + "smithy.api#documentation": "

The message returned by an InvalidParameterException.

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

Thrown for missing or bad input parameter(s).

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cognitoidentity#LimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cognitoidentity#String", + "traits": { + "smithy.api#documentation": "

The message returned by a LimitExceededException.

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

Thrown when the total number of user pools has exceeded a preset limit.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cognitoidentity#ListIdentities": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentity#ListIdentitiesInput" + }, + "output": { + "target": "com.amazonaws.cognitoidentity#ListIdentitiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentity#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentity#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentity#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentity#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the identities in an identity pool.

\n

You must use Amazon Web Services developer credentials to call this\n operation.

" + } + }, + "com.amazonaws.cognitoidentity#ListIdentitiesInput": { + "type": "structure", + "members": { + "IdentityPoolId": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolId", + "traits": { + "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.cognitoidentity#QueryLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of identities to return.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cognitoidentity#PaginationKey", + "traits": { + "smithy.api#documentation": "

A pagination token.

" + } + }, + "HideDisabled": { + "target": "com.amazonaws.cognitoidentity#HideDisabled", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

An optional boolean parameter that allows you to hide disabled identities. If\n omitted, the ListIdentities API will include disabled identities in the response.

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

Input to the ListIdentities action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentity#ListIdentitiesResponse": { + "type": "structure", + "members": { + "IdentityPoolId": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolId", + "traits": { + "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

" + } + }, + "Identities": { + "target": "com.amazonaws.cognitoidentity#IdentitiesList", + "traits": { + "smithy.api#documentation": "

An object containing a set of identities and associated mappings.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cognitoidentity#PaginationKey", + "traits": { + "smithy.api#documentation": "

A pagination token.

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

The response to a ListIdentities request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cognitoidentity#ListIdentityPools": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentity#ListIdentityPoolsInput" + }, + "output": { + "target": "com.amazonaws.cognitoidentity#ListIdentityPoolsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentity#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentity#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentity#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentity#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all of the Cognito identity pools registered for your account.

\n

You must use Amazon Web Services developer credentials to call this\n operation.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IdentityPools", + "pageSize": "MaxResults" + }, + "smithy.test#smokeTests": [ + { + "id": "ListIdentityPoolsSuccess", + "params": { + "MaxResults": 10 + }, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] + } + }, + "com.amazonaws.cognitoidentity#ListIdentityPoolsInput": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.cognitoidentity#QueryLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of identities to return.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cognitoidentity#PaginationKey", + "traits": { + "smithy.api#documentation": "

A pagination token.

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

Input to the ListIdentityPools action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentity#ListIdentityPoolsResponse": { + "type": "structure", + "members": { + "IdentityPools": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolsList", + "traits": { + "smithy.api#documentation": "

The identity pools returned by the ListIdentityPools action.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cognitoidentity#PaginationKey", + "traits": { + "smithy.api#documentation": "

A pagination token.

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

The result of a successful ListIdentityPools action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cognitoidentity#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentity#ListTagsForResourceInput" + }, + "output": { + "target": "com.amazonaws.cognitoidentity#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentity#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentity#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentity#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentity#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags that are assigned to an Amazon Cognito identity pool.

\n

A tag is a label that you can apply to identity pools to categorize and manage them in\n different ways, such as by purpose, owner, environment, or other criteria.

\n

You can use this action up to 10 times per second, per account.

" + } + }, + "com.amazonaws.cognitoidentity#ListTagsForResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.cognitoidentity#ARNString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the identity pool that the tags are assigned\n to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentity#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolTagsType", + "traits": { + "smithy.api#documentation": "

The tags that are assigned to the identity pool.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cognitoidentity#LoginsList": { + "type": "list", + "member": { + "target": "com.amazonaws.cognitoidentity#IdentityProviderName" + } + }, + "com.amazonaws.cognitoidentity#LoginsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.cognitoidentity#IdentityProviderName" + }, + "value": { + "target": "com.amazonaws.cognitoidentity#IdentityProviderToken" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.cognitoidentity#LookupDeveloperIdentity": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentity#LookupDeveloperIdentityInput" + }, + "output": { + "target": "com.amazonaws.cognitoidentity#LookupDeveloperIdentityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentity#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentity#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentity#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceConflictException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentity#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the IdentityID associated with a\n DeveloperUserIdentifier or the list of DeveloperUserIdentifier\n values associated with an IdentityId for an existing identity. Either\n IdentityID or DeveloperUserIdentifier must not be null. If you\n supply only one of these values, the other value will be searched in the database and\n returned as a part of the response. If you supply both,\n DeveloperUserIdentifier will be matched against IdentityID. If\n the values are verified against the database, the response returns both values and is the\n same as the request. Otherwise, a ResourceConflictException is\n thrown.

\n

\n LookupDeveloperIdentity is intended for low-throughput control plane\n operations: for example, to enable customer service to locate an identity ID by username.\n If you are using it for higher-volume operations such as user authentication, your requests\n are likely to be throttled. GetOpenIdTokenForDeveloperIdentity is a\n better option for higher-volume operations for user authentication.

\n

You must use Amazon Web Services developer credentials to call this\n operation.

" + } + }, + "com.amazonaws.cognitoidentity#LookupDeveloperIdentityInput": { + "type": "structure", + "members": { + "IdentityPoolId": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolId", + "traits": { + "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

", + "smithy.api#required": {} + } + }, + "IdentityId": { + "target": "com.amazonaws.cognitoidentity#IdentityId", + "traits": { + "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

" + } + }, + "DeveloperUserIdentifier": { + "target": "com.amazonaws.cognitoidentity#DeveloperUserIdentifier", + "traits": { + "smithy.api#documentation": "

A unique ID used by your backend authentication process to identify a user.\n Typically, a developer identity provider would issue many developer user identifiers, in\n keeping with the number of users.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.cognitoidentity#QueryLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of identities to return.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cognitoidentity#PaginationKey", + "traits": { + "smithy.api#documentation": "

A pagination token. The first call you make will have NextToken set to\n null. After that the service will return NextToken values as needed. For\n example, let's say you make a request with MaxResults set to 10, and there are\n 20 matches in the database. The service will return a pagination token as a part of the\n response. This token can be used to call the API again and get results starting from the\n 11th match.

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

Input to the LookupDeveloperIdentityInput action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentity#LookupDeveloperIdentityResponse": { + "type": "structure", + "members": { + "IdentityId": { + "target": "com.amazonaws.cognitoidentity#IdentityId", + "traits": { + "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

" + } + }, + "DeveloperUserIdentifierList": { + "target": "com.amazonaws.cognitoidentity#DeveloperUserIdentifierList", + "traits": { + "smithy.api#documentation": "

This is the list of developer user identifiers associated with an identity ID.\n Cognito supports the association of multiple developer user identifiers with an identity\n ID.

" + } + }, + "NextToken": { + "target": "com.amazonaws.cognitoidentity#PaginationKey", + "traits": { + "smithy.api#documentation": "

A pagination token. The first call you make will have NextToken set to\n null. After that the service will return NextToken values as needed. For\n example, let's say you make a request with MaxResults set to 10, and there are\n 20 matches in the database. The service will return a pagination token as a part of the\n response. This token can be used to call the API again and get results starting from the\n 11th match.

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

Returned in response to a successful LookupDeveloperIdentity\n action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cognitoidentity#MappingRule": { + "type": "structure", + "members": { + "Claim": { + "target": "com.amazonaws.cognitoidentity#ClaimName", + "traits": { + "smithy.api#documentation": "

The claim name that must be present in the token, for example, \"isAdmin\" or\n \"paid\".

", + "smithy.api#required": {} + } + }, + "MatchType": { + "target": "com.amazonaws.cognitoidentity#MappingRuleMatchType", + "traits": { + "smithy.api#documentation": "

The match condition that specifies how closely the claim value in the IdP token must\n match Value.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.cognitoidentity#ClaimValue", + "traits": { + "smithy.api#documentation": "

A brief string that the claim must match, for example, \"paid\" or \"yes\".

", + "smithy.api#required": {} + } + }, + "RoleARN": { + "target": "com.amazonaws.cognitoidentity#ARNString", + "traits": { + "smithy.api#documentation": "

The role ARN.

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

A rule that maps a claim name, a claim value, and a match type to a role\n ARN.

" + } + }, + "com.amazonaws.cognitoidentity#MappingRuleMatchType": { + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Equals" + } + }, + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Contains" + } + }, + "STARTS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StartsWith" + } + }, + "NOT_EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotEqual" + } + } + } + }, + "com.amazonaws.cognitoidentity#MappingRulesList": { + "type": "list", + "member": { + "target": "com.amazonaws.cognitoidentity#MappingRule" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 400 + } + } + }, + "com.amazonaws.cognitoidentity#MergeDeveloperIdentities": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentity#MergeDeveloperIdentitiesInput" + }, + "output": { + "target": "com.amazonaws.cognitoidentity#MergeDeveloperIdentitiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentity#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentity#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentity#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceConflictException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentity#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Merges two users having different IdentityIds, existing in the same\n identity pool, and identified by the same developer provider. You can use this action to\n request that discrete users be merged and identified as a single user in the Cognito\n environment. Cognito associates the given source user (SourceUserIdentifier)\n with the IdentityId of the DestinationUserIdentifier. Only\n developer-authenticated users can be merged. If the users to be merged are associated with\n the same public provider, but as two different users, an exception will be\n thrown.

\n

The number of linked logins is limited to 20. So, the number of linked logins for the\n source user, SourceUserIdentifier, and the destination user,\n DestinationUserIdentifier, together should not be larger than 20.\n Otherwise, an exception will be thrown.

\n

You must use Amazon Web Services developer credentials to call this\n operation.

" + } + }, + "com.amazonaws.cognitoidentity#MergeDeveloperIdentitiesInput": { + "type": "structure", + "members": { + "SourceUserIdentifier": { + "target": "com.amazonaws.cognitoidentity#DeveloperUserIdentifier", + "traits": { + "smithy.api#documentation": "

User identifier for the source user. The value should be a\n DeveloperUserIdentifier.

", + "smithy.api#required": {} + } + }, + "DestinationUserIdentifier": { + "target": "com.amazonaws.cognitoidentity#DeveloperUserIdentifier", + "traits": { + "smithy.api#documentation": "

User identifier for the destination user. The value should be a\n DeveloperUserIdentifier.

", + "smithy.api#required": {} + } + }, + "DeveloperProviderName": { + "target": "com.amazonaws.cognitoidentity#DeveloperProviderName", + "traits": { + "smithy.api#documentation": "

The \"domain\" by which Cognito will refer to your users. This is a (pseudo) domain\n name that you provide while creating an identity pool. This name acts as a placeholder that\n allows your backend and the Cognito service to communicate about the developer provider.\n For the DeveloperProviderName, you can use letters as well as period (.),\n underscore (_), and dash (-).

", + "smithy.api#required": {} + } + }, + "IdentityPoolId": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolId", + "traits": { + "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

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

Input to the MergeDeveloperIdentities action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentity#MergeDeveloperIdentitiesResponse": { + "type": "structure", + "members": { + "IdentityId": { + "target": "com.amazonaws.cognitoidentity#IdentityId", + "traits": { + "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

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

Returned in response to a successful MergeDeveloperIdentities\n action.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cognitoidentity#NotAuthorizedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cognitoidentity#String", + "traits": { + "smithy.api#documentation": "

The message returned by a NotAuthorizedException

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

Thrown when a user is not authorized to access the requested resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.cognitoidentity#OIDCProviderList": { + "type": "list", + "member": { + "target": "com.amazonaws.cognitoidentity#ARNString" + } + }, + "com.amazonaws.cognitoidentity#OIDCToken": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.cognitoidentity#PaginationKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 65535 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.cognitoidentity#PrincipalTagID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.cognitoidentity#PrincipalTagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.cognitoidentity#PrincipalTags": { + "type": "map", + "key": { + "target": "com.amazonaws.cognitoidentity#PrincipalTagID" + }, + "value": { + "target": "com.amazonaws.cognitoidentity#PrincipalTagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.cognitoidentity#QueryLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 60 + } + } + }, + "com.amazonaws.cognitoidentity#ResourceConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cognitoidentity#String", + "traits": { + "smithy.api#documentation": "

The message returned by a ResourceConflictException.

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

Thrown when a user tries to use a login which is already linked to another\n account.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.cognitoidentity#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cognitoidentity#String", + "traits": { + "smithy.api#documentation": "

The message returned by a ResourceNotFoundException.

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

Thrown when the requested resource (for example, a dataset or record) does not\n exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.cognitoidentity#RoleMapping": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.cognitoidentity#RoleMappingType", + "traits": { + "smithy.api#documentation": "

The role mapping type. Token will use cognito:roles and\n cognito:preferred_role claims from the Cognito identity provider token to\n map groups to roles. Rules will attempt to match claims from the token to map to a\n role.

", + "smithy.api#required": {} + } + }, + "AmbiguousRoleResolution": { + "target": "com.amazonaws.cognitoidentity#AmbiguousRoleResolutionType", + "traits": { + "smithy.api#documentation": "

If you specify Token or Rules as the Type,\n AmbiguousRoleResolution is required.

\n

Specifies the action to be taken if either no rules match the claim value for the\n Rules type, or there is no cognito:preferred_role claim and\n there are multiple cognito:roles matches for the Token\n type.

" + } + }, + "RulesConfiguration": { + "target": "com.amazonaws.cognitoidentity#RulesConfigurationType", + "traits": { + "smithy.api#documentation": "

The rules to be used for mapping users to roles.

\n

If you specify Rules as the role mapping type, RulesConfiguration is\n required.

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

A role mapping.

" + } + }, + "com.amazonaws.cognitoidentity#RoleMappingMap": { + "type": "map", + "key": { + "target": "com.amazonaws.cognitoidentity#IdentityProviderName" + }, + "value": { + "target": "com.amazonaws.cognitoidentity#RoleMapping" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.cognitoidentity#RoleMappingType": { + "type": "enum", + "members": { + "TOKEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Token" + } + }, + "RULES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Rules" + } + } + } + }, + "com.amazonaws.cognitoidentity#RoleType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(un)?authenticated$" + } + }, + "com.amazonaws.cognitoidentity#RolesMap": { + "type": "map", + "key": { + "target": "com.amazonaws.cognitoidentity#RoleType" + }, + "value": { + "target": "com.amazonaws.cognitoidentity#ARNString" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.cognitoidentity#RulesConfigurationType": { + "type": "structure", + "members": { + "Rules": { + "target": "com.amazonaws.cognitoidentity#MappingRulesList", + "traits": { + "smithy.api#documentation": "

An array of rules. You can specify up to 25 rules per identity provider.

\n

Rules are evaluated in order. The first one to match specifies the role.

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

A container for rules.

" + } + }, + "com.amazonaws.cognitoidentity#SAMLProviderList": { + "type": "list", + "member": { + "target": "com.amazonaws.cognitoidentity#ARNString" + } + }, + "com.amazonaws.cognitoidentity#SecretKeyString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.cognitoidentity#SessionTokenString": { + "type": "string" + }, + "com.amazonaws.cognitoidentity#SetIdentityPoolRoles": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentity#SetIdentityPoolRolesInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentity#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.cognitoidentity#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentity#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentity#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceConflictException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentity#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.

\n

You must use Amazon Web Services developer credentials to call this\n operation.

" + } + }, + "com.amazonaws.cognitoidentity#SetIdentityPoolRolesInput": { + "type": "structure", + "members": { + "IdentityPoolId": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolId", + "traits": { + "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

", + "smithy.api#required": {} + } + }, + "Roles": { + "target": "com.amazonaws.cognitoidentity#RolesMap", + "traits": { + "smithy.api#documentation": "

The map of roles associated with this pool. For a given role, the key will be either\n \"authenticated\" or \"unauthenticated\" and the value will be the Role ARN.

", + "smithy.api#required": {} + } + }, + "RoleMappings": { + "target": "com.amazonaws.cognitoidentity#RoleMappingMap", + "traits": { + "smithy.api#documentation": "

How users for a specific identity provider are to mapped to roles. This is a string\n to RoleMapping object map. The string identifies the identity provider,\n for example, graph.facebook.com or\n cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id.

\n

Up to 25 rules can be specified per identity provider.

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

Input to the SetIdentityPoolRoles action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentity#SetPrincipalTagAttributeMap": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentity#SetPrincipalTagAttributeMapInput" + }, + "output": { + "target": "com.amazonaws.cognitoidentity#SetPrincipalTagAttributeMapResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentity#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentity#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentity#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentity#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

You can use this operation to use default (username and clientID) attribute or custom\n attribute mappings.

" + } + }, + "com.amazonaws.cognitoidentity#SetPrincipalTagAttributeMapInput": { + "type": "structure", + "members": { + "IdentityPoolId": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolId", + "traits": { + "smithy.api#documentation": "

The ID of the Identity Pool you want to set attribute mappings for.

", + "smithy.api#required": {} + } + }, + "IdentityProviderName": { + "target": "com.amazonaws.cognitoidentity#IdentityProviderName", + "traits": { + "smithy.api#documentation": "

The provider name you want to use for attribute mappings.

", + "smithy.api#required": {} + } + }, + "UseDefaults": { + "target": "com.amazonaws.cognitoidentity#UseDefaults", + "traits": { + "smithy.api#documentation": "

You can use this operation to use default (username and clientID) attribute\n mappings.

" + } + }, + "PrincipalTags": { + "target": "com.amazonaws.cognitoidentity#PrincipalTags", + "traits": { + "smithy.api#documentation": "

You can use this operation to add principal tags.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentity#SetPrincipalTagAttributeMapResponse": { + "type": "structure", + "members": { + "IdentityPoolId": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolId", + "traits": { + "smithy.api#documentation": "

The ID of the Identity Pool you want to set attribute mappings for.

" + } + }, + "IdentityProviderName": { + "target": "com.amazonaws.cognitoidentity#IdentityProviderName", + "traits": { + "smithy.api#documentation": "

The provider name you want to use for attribute mappings.

" + } + }, + "UseDefaults": { + "target": "com.amazonaws.cognitoidentity#UseDefaults", + "traits": { + "smithy.api#documentation": "

You can use this operation to select default (username and clientID) attribute\n mappings.

" + } + }, + "PrincipalTags": { + "target": "com.amazonaws.cognitoidentity#PrincipalTags", + "traits": { + "smithy.api#documentation": "

You can use this operation to add principal tags. The\n PrincipalTagsoperation enables you to reference user attributes in your\n IAM permissions policy.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cognitoidentity#String": { + "type": "string" + }, + "com.amazonaws.cognitoidentity#TagKeysType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.cognitoidentity#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentity#TagResourceInput" + }, + "output": { + "target": "com.amazonaws.cognitoidentity#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentity#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentity#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentity#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentity#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Assigns a set of tags to the specified Amazon Cognito identity pool. A tag is a label\n that you can use to categorize and manage identity pools in different ways, such as by\n purpose, owner, environment, or other criteria.

\n

Each tag consists of a key and value, both of which you define. A key is a general\n category for more specific values. For example, if you have two versions of an identity\n pool, one for testing and another for production, you might assign an\n Environment tag key to both identity pools. The value of this key might be\n Test for one identity pool and Production for the\n other.

\n

Tags are useful for cost tracking and access control. You can activate your tags so that\n they appear on the Billing and Cost Management console, where you can track the costs\n associated with your identity pools. In an IAM policy, you can constrain\n permissions for identity pools based on specific tags or tag values.

\n

You can use this action up to 5 times per second, per account. An identity pool can have\n as many as 50 tags.

" + } + }, + "com.amazonaws.cognitoidentity#TagResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.cognitoidentity#ARNString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the identity pool.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolTagsType", + "traits": { + "smithy.api#documentation": "

The tags to assign to the identity pool.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentity#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cognitoidentity#TagValueType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.cognitoidentity#TokenDuration": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 86400 + } + } + }, + "com.amazonaws.cognitoidentity#TooManyRequestsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cognitoidentity#String", + "traits": { + "smithy.api#documentation": "

Message returned by a TooManyRequestsException

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

Thrown when a request is throttled.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.cognitoidentity#UnlinkDeveloperIdentity": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentity#UnlinkDeveloperIdentityInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentity#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentity#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentity#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceConflictException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentity#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Unlinks a DeveloperUserIdentifier from an existing identity. Unlinked\n developer users will be considered new identities next time they are seen. If, for a given\n Cognito identity, you remove all federated identities as well as the developer user\n identifier, the Cognito identity becomes inaccessible.

\n

You must use Amazon Web Services developer credentials to call this\n operation.

" + } + }, + "com.amazonaws.cognitoidentity#UnlinkDeveloperIdentityInput": { + "type": "structure", + "members": { + "IdentityId": { + "target": "com.amazonaws.cognitoidentity#IdentityId", + "traits": { + "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

", + "smithy.api#required": {} + } + }, + "IdentityPoolId": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolId", + "traits": { + "smithy.api#documentation": "

An identity pool ID in the format REGION:GUID.

", + "smithy.api#required": {} + } + }, + "DeveloperProviderName": { + "target": "com.amazonaws.cognitoidentity#DeveloperProviderName", + "traits": { + "smithy.api#documentation": "

The \"domain\" by which Cognito will refer to your users.

", + "smithy.api#required": {} + } + }, + "DeveloperUserIdentifier": { + "target": "com.amazonaws.cognitoidentity#DeveloperUserIdentifier", + "traits": { + "smithy.api#documentation": "

A unique ID used by your backend authentication process to identify a user.

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

Input to the UnlinkDeveloperIdentity action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentity#UnlinkIdentity": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentity#UnlinkIdentityInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentity#ExternalServiceException" + }, + { + "target": "com.amazonaws.cognitoidentity#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentity#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentity#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceConflictException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentity#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#auth": [], + "smithy.api#documentation": "

Unlinks a federated identity from an existing account. Unlinked logins will be\n considered new identities next time they are seen. Removing the last linked login will make\n this identity inaccessible.

\n

This is a public API. You do not need any credentials to call this API.

", + "smithy.api#optionalAuth": {} + } + }, + "com.amazonaws.cognitoidentity#UnlinkIdentityInput": { + "type": "structure", + "members": { + "IdentityId": { + "target": "com.amazonaws.cognitoidentity#IdentityId", + "traits": { + "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

", + "smithy.api#required": {} + } + }, + "Logins": { + "target": "com.amazonaws.cognitoidentity#LoginsMap", + "traits": { + "smithy.api#documentation": "

A set of optional name-value pairs that map provider names to provider\n tokens.

", + "smithy.api#required": {} + } + }, + "LoginsToRemove": { + "target": "com.amazonaws.cognitoidentity#LoginsList", + "traits": { + "smithy.api#documentation": "

Provider names to unlink from this identity.

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

Input to the UnlinkIdentity action.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentity#UnprocessedIdentityId": { + "type": "structure", + "members": { + "IdentityId": { + "target": "com.amazonaws.cognitoidentity#IdentityId", + "traits": { + "smithy.api#documentation": "

A unique identifier in the format REGION:GUID.

" + } + }, + "ErrorCode": { + "target": "com.amazonaws.cognitoidentity#ErrorCode", + "traits": { + "smithy.api#documentation": "

The error code indicating the type of error that occurred.

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

An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and\n IdentityId.

" + } + }, + "com.amazonaws.cognitoidentity#UnprocessedIdentityIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.cognitoidentity#UnprocessedIdentityId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 60 + } + } + }, + "com.amazonaws.cognitoidentity#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentity#UntagResourceInput" + }, + "output": { + "target": "com.amazonaws.cognitoidentity#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentity#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentity#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentity#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentity#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified tags from the specified Amazon Cognito identity pool. You can use\n this action up to 5 times per second, per account

" + } + }, + "com.amazonaws.cognitoidentity#UntagResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.cognitoidentity#ARNString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the identity pool.

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.cognitoidentity#IdentityPoolTagsListType", + "traits": { + "smithy.api#documentation": "

The keys of the tags to remove from the user pool.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cognitoidentity#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cognitoidentity#UpdateIdentityPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.cognitoidentity#IdentityPool" + }, + "output": { + "target": "com.amazonaws.cognitoidentity#IdentityPool" + }, + "errors": [ + { + "target": "com.amazonaws.cognitoidentity#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.cognitoidentity#InternalErrorException" + }, + { + "target": "com.amazonaws.cognitoidentity#InvalidParameterException" + }, + { + "target": "com.amazonaws.cognitoidentity#LimitExceededException" + }, + { + "target": "com.amazonaws.cognitoidentity#NotAuthorizedException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceConflictException" + }, + { + "target": "com.amazonaws.cognitoidentity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cognitoidentity#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the configuration of an identity pool.

\n \n

If you don't provide a value for a parameter, Amazon Cognito sets it to its default value. \n

\n \n

You must use Amazon Web Services developer credentials to call this\n operation.

" + } + }, + "com.amazonaws.cognitoidentity#UseDefaults": { + "type": "boolean" + } + } +} diff --git a/codegen/aws-models/dynamodb.json b/codegen/aws-models/dynamodb.json new file mode 100644 index 0000000..c1ba160 --- /dev/null +++ b/codegen/aws-models/dynamodb.json @@ -0,0 +1,30822 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + }, + { + "id": "RuleSetAwsBuiltIn.AWS::Auth::AccountIdEndpointMode", + "namespace": "*" + }, + { + "id": "RuleSetAwsBuiltIn.AWS::Auth::AccountId", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.dynamodb#ApproximateCreationDateTimePrecision": { + "type": "enum", + "members": { + "MILLISECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MILLISECOND" + } + }, + "MICROSECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MICROSECOND" + } + } + } + }, + "com.amazonaws.dynamodb#ArchivalReason": { + "type": "string" + }, + "com.amazonaws.dynamodb#ArchivalSummary": { + "type": "structure", + "members": { + "ArchivalDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

The date and time when table archival was initiated by DynamoDB, in UNIX epoch time\n format.

" + } + }, + "ArchivalReason": { + "target": "com.amazonaws.dynamodb#ArchivalReason", + "traits": { + "smithy.api#documentation": "

The reason DynamoDB archived the table. Currently, the only possible value is:

\n " + } + }, + "ArchivalBackupArn": { + "target": "com.amazonaws.dynamodb#BackupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the backup the table was archived to, when\n applicable in the archival reason. If you wish to restore this backup to the same table\n name, you will need to delete the original table.

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

Contains details of a table archival operation.

" + } + }, + "com.amazonaws.dynamodb#AttributeAction": { + "type": "enum", + "members": { + "ADD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADD" + } + }, + "PUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUT" + } + }, + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + } + } + }, + "com.amazonaws.dynamodb#AttributeDefinition": { + "type": "structure", + "members": { + "AttributeName": { + "target": "com.amazonaws.dynamodb#KeySchemaAttributeName", + "traits": { + "smithy.api#documentation": "

A name for the attribute.

", + "smithy.api#required": {} + } + }, + "AttributeType": { + "target": "com.amazonaws.dynamodb#ScalarAttributeType", + "traits": { + "smithy.api#documentation": "

The data type for the attribute, where:

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

Represents an attribute for describing the schema for the table and indexes.

" + } + }, + "com.amazonaws.dynamodb#AttributeDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#AttributeDefinition" + } + }, + "com.amazonaws.dynamodb#AttributeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#AttributeName" + }, + "value": { + "target": "com.amazonaws.dynamodb#AttributeValue" + } + }, + "com.amazonaws.dynamodb#AttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 65535 + } + } + }, + "com.amazonaws.dynamodb#AttributeNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#AttributeName" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.dynamodb#AttributeUpdates": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#AttributeName" + }, + "value": { + "target": "com.amazonaws.dynamodb#AttributeValueUpdate" + } + }, + "com.amazonaws.dynamodb#AttributeValue": { + "type": "union", + "members": { + "S": { + "target": "com.amazonaws.dynamodb#StringAttributeValue", + "traits": { + "smithy.api#documentation": "

An attribute of type String. For example:

\n

\n \"S\": \"Hello\"\n

" + } + }, + "N": { + "target": "com.amazonaws.dynamodb#NumberAttributeValue", + "traits": { + "smithy.api#documentation": "

An attribute of type Number. For example:

\n

\n \"N\": \"123.45\"\n

\n

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility\n across languages and libraries. However, DynamoDB treats them as number type attributes\n for mathematical operations.

" + } + }, + "B": { + "target": "com.amazonaws.dynamodb#BinaryAttributeValue", + "traits": { + "smithy.api#documentation": "

An attribute of type Binary. For example:

\n

\n \"B\": \"dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk\"\n

" + } + }, + "SS": { + "target": "com.amazonaws.dynamodb#StringSetAttributeValue", + "traits": { + "smithy.api#documentation": "

An attribute of type String Set. For example:

\n

\n \"SS\": [\"Giraffe\", \"Hippo\" ,\"Zebra\"]\n

" + } + }, + "NS": { + "target": "com.amazonaws.dynamodb#NumberSetAttributeValue", + "traits": { + "smithy.api#documentation": "

An attribute of type Number Set. For example:

\n

\n \"NS\": [\"42.2\", \"-19\", \"7.5\", \"3.14\"]\n

\n

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility\n across languages and libraries. However, DynamoDB treats them as number type attributes\n for mathematical operations.

" + } + }, + "BS": { + "target": "com.amazonaws.dynamodb#BinarySetAttributeValue", + "traits": { + "smithy.api#documentation": "

An attribute of type Binary Set. For example:

\n

\n \"BS\": [\"U3Vubnk=\", \"UmFpbnk=\", \"U25vd3k=\"]\n

" + } + }, + "M": { + "target": "com.amazonaws.dynamodb#MapAttributeValue", + "traits": { + "smithy.api#documentation": "

An attribute of type Map. For example:

\n

\n \"M\": {\"Name\": {\"S\": \"Joe\"}, \"Age\": {\"N\": \"35\"}}\n

" + } + }, + "L": { + "target": "com.amazonaws.dynamodb#ListAttributeValue", + "traits": { + "smithy.api#documentation": "

An attribute of type List. For example:

\n

\n \"L\": [ {\"S\": \"Cookies\"} , {\"S\": \"Coffee\"}, {\"N\": \"3.14159\"}]\n

" + } + }, + "NULL": { + "target": "com.amazonaws.dynamodb#NullAttributeValue", + "traits": { + "smithy.api#documentation": "

An attribute of type Null. For example:

\n

\n \"NULL\": true\n

" + } + }, + "BOOL": { + "target": "com.amazonaws.dynamodb#BooleanAttributeValue", + "traits": { + "smithy.api#documentation": "

An attribute of type Boolean. For example:

\n

\n \"BOOL\": true\n

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

Represents the data for an attribute.

\n

Each attribute value is described as a name-value pair. The name is the data type, and\n the value is the data itself.

\n

For more information, see Data Types in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "com.amazonaws.dynamodb#AttributeValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#AttributeValue" + } + }, + "com.amazonaws.dynamodb#AttributeValueUpdate": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.dynamodb#AttributeValue", + "traits": { + "smithy.api#documentation": "

Represents the data for an attribute.

\n

Each attribute value is described as a name-value pair. The name is the data type, and\n the value is the data itself.

\n

For more information, see Data Types in the Amazon DynamoDB Developer Guide.\n

" + } + }, + "Action": { + "target": "com.amazonaws.dynamodb#AttributeAction", + "traits": { + "smithy.api#documentation": "

Specifies how to perform the update. Valid values are PUT (default),\n DELETE, and ADD. The behavior depends on whether the\n specified primary key already exists in the table.

\n

\n If an item with the specified Key is found in\n the table:\n

\n \n

\n If no item with the specified Key is\n found:\n

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

For the UpdateItem operation, represents the attributes to be modified,\n the action to perform on each, and the new value for each.

\n \n

You cannot use UpdateItem to update any primary key attributes.\n Instead, you will need to delete the item, and then use PutItem to\n create a new item with new attributes.

\n \n

Attribute values cannot be null; string and binary type attributes must have lengths\n greater than zero; and set type attributes must not be empty. Requests with empty values\n will be rejected with a ValidationException exception.

" + } + }, + "com.amazonaws.dynamodb#AutoScalingPolicyDescription": { + "type": "structure", + "members": { + "PolicyName": { + "target": "com.amazonaws.dynamodb#AutoScalingPolicyName", + "traits": { + "smithy.api#documentation": "

The name of the scaling policy.

" + } + }, + "TargetTrackingScalingPolicyConfiguration": { + "target": "com.amazonaws.dynamodb#AutoScalingTargetTrackingScalingPolicyConfigurationDescription", + "traits": { + "smithy.api#documentation": "

Represents a target tracking scaling policy configuration.

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

Represents the properties of the scaling policy.

" + } + }, + "com.amazonaws.dynamodb#AutoScalingPolicyDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#AutoScalingPolicyDescription" + } + }, + "com.amazonaws.dynamodb#AutoScalingPolicyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^\\p{Print}+$" + } + }, + "com.amazonaws.dynamodb#AutoScalingPolicyUpdate": { + "type": "structure", + "members": { + "PolicyName": { + "target": "com.amazonaws.dynamodb#AutoScalingPolicyName", + "traits": { + "smithy.api#documentation": "

The name of the scaling policy.

" + } + }, + "TargetTrackingScalingPolicyConfiguration": { + "target": "com.amazonaws.dynamodb#AutoScalingTargetTrackingScalingPolicyConfigurationUpdate", + "traits": { + "smithy.api#documentation": "

Represents a target tracking scaling policy configuration.

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

Represents the auto scaling policy to be modified.

" + } + }, + "com.amazonaws.dynamodb#AutoScalingRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.dynamodb#AutoScalingSettingsDescription": { + "type": "structure", + "members": { + "MinimumUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The minimum capacity units that a global table or global secondary index should be\n scaled down to.

" + } + }, + "MaximumUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum capacity units that a global table or global secondary index should be\n scaled up to.

" + } + }, + "AutoScalingDisabled": { + "target": "com.amazonaws.dynamodb#BooleanObject", + "traits": { + "smithy.api#documentation": "

Disabled auto scaling for this global table or global secondary index.

" + } + }, + "AutoScalingRoleArn": { + "target": "com.amazonaws.dynamodb#String", + "traits": { + "smithy.api#documentation": "

Role ARN used for configuring the auto scaling policy.

" + } + }, + "ScalingPolicies": { + "target": "com.amazonaws.dynamodb#AutoScalingPolicyDescriptionList", + "traits": { + "smithy.api#documentation": "

Information about the scaling policies.

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

Represents the auto scaling settings for a global table or global secondary\n index.

" + } + }, + "com.amazonaws.dynamodb#AutoScalingSettingsUpdate": { + "type": "structure", + "members": { + "MinimumUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The minimum capacity units that a global table or global secondary index should be\n scaled down to.

" + } + }, + "MaximumUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum capacity units that a global table or global secondary index should be\n scaled up to.

" + } + }, + "AutoScalingDisabled": { + "target": "com.amazonaws.dynamodb#BooleanObject", + "traits": { + "smithy.api#documentation": "

Disabled auto scaling for this global table or global secondary index.

" + } + }, + "AutoScalingRoleArn": { + "target": "com.amazonaws.dynamodb#AutoScalingRoleArn", + "traits": { + "smithy.api#documentation": "

Role ARN used for configuring auto scaling policy.

" + } + }, + "ScalingPolicyUpdate": { + "target": "com.amazonaws.dynamodb#AutoScalingPolicyUpdate", + "traits": { + "smithy.api#documentation": "

The scaling policy to apply for scaling target global table or global secondary index\n capacity units.

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

Represents the auto scaling settings to be modified for a global table or global\n secondary index.

" + } + }, + "com.amazonaws.dynamodb#AutoScalingTargetTrackingScalingPolicyConfigurationDescription": { + "type": "structure", + "members": { + "DisableScaleIn": { + "target": "com.amazonaws.dynamodb#BooleanObject", + "traits": { + "smithy.api#documentation": "

Indicates whether scale in by the target tracking policy is disabled. If the value is\n true, scale in is disabled and the target tracking policy won't remove capacity from the\n scalable resource. Otherwise, scale in is enabled and the target tracking policy can\n remove capacity from the scalable resource. The default value is false.

" + } + }, + "ScaleInCooldown": { + "target": "com.amazonaws.dynamodb#IntegerObject", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, after a scale in activity completes before another\n scale in activity can start. The cooldown period is used to block subsequent scale in\n requests until it has expired. You should scale in conservatively to protect your\n application's availability. However, if another alarm triggers a scale out policy during\n the cooldown period after a scale-in, application auto scaling scales out your scalable\n target immediately.

" + } + }, + "ScaleOutCooldown": { + "target": "com.amazonaws.dynamodb#IntegerObject", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, after a scale out activity completes before another\n scale out activity can start. While the cooldown period is in effect, the capacity that\n has been added by the previous scale out event that initiated the cooldown is calculated\n as part of the desired capacity for the next scale out. You should continuously (but not\n excessively) scale out.

" + } + }, + "TargetValue": { + "target": "com.amazonaws.dynamodb#DoubleObject", + "traits": { + "smithy.api#documentation": "

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10)\n or 2e-360 to 2e360 (Base 2).

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

Represents the properties of a target tracking scaling policy.

" + } + }, + "com.amazonaws.dynamodb#AutoScalingTargetTrackingScalingPolicyConfigurationUpdate": { + "type": "structure", + "members": { + "DisableScaleIn": { + "target": "com.amazonaws.dynamodb#BooleanObject", + "traits": { + "smithy.api#documentation": "

Indicates whether scale in by the target tracking policy is disabled. If the value is\n true, scale in is disabled and the target tracking policy won't remove capacity from the\n scalable resource. Otherwise, scale in is enabled and the target tracking policy can\n remove capacity from the scalable resource. The default value is false.

" + } + }, + "ScaleInCooldown": { + "target": "com.amazonaws.dynamodb#IntegerObject", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, after a scale in activity completes before another\n scale in activity can start. The cooldown period is used to block subsequent scale in\n requests until it has expired. You should scale in conservatively to protect your\n application's availability. However, if another alarm triggers a scale out policy during\n the cooldown period after a scale-in, application auto scaling scales out your scalable\n target immediately.

" + } + }, + "ScaleOutCooldown": { + "target": "com.amazonaws.dynamodb#IntegerObject", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, after a scale out activity completes before another\n scale out activity can start. While the cooldown period is in effect, the capacity that\n has been added by the previous scale out event that initiated the cooldown is calculated\n as part of the desired capacity for the next scale out. You should continuously (but not\n excessively) scale out.

" + } + }, + "TargetValue": { + "target": "com.amazonaws.dynamodb#DoubleObject", + "traits": { + "smithy.api#documentation": "

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10)\n or 2e-360 to 2e360 (Base 2).

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

Represents the settings of a target tracking scaling policy that will be\n modified.

" + } + }, + "com.amazonaws.dynamodb#AvailabilityErrorMessage": { + "type": "string" + }, + "com.amazonaws.dynamodb#Backfilling": { + "type": "boolean" + }, + "com.amazonaws.dynamodb#BackupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 37, + "max": 1024 + } + } + }, + "com.amazonaws.dynamodb#BackupCreationDateTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#BackupDescription": { + "type": "structure", + "members": { + "BackupDetails": { + "target": "com.amazonaws.dynamodb#BackupDetails", + "traits": { + "smithy.api#documentation": "

Contains the details of the backup created for the table.

" + } + }, + "SourceTableDetails": { + "target": "com.amazonaws.dynamodb#SourceTableDetails", + "traits": { + "smithy.api#documentation": "

Contains the details of the table when the backup was created.

" + } + }, + "SourceTableFeatureDetails": { + "target": "com.amazonaws.dynamodb#SourceTableFeatureDetails", + "traits": { + "smithy.api#documentation": "

Contains the details of the features enabled on the table when the backup was created.\n For example, LSIs, GSIs, streams, TTL.

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

Contains the description of the backup created for the table.

" + } + }, + "com.amazonaws.dynamodb#BackupDetails": { + "type": "structure", + "members": { + "BackupArn": { + "target": "com.amazonaws.dynamodb#BackupArn", + "traits": { + "smithy.api#documentation": "

ARN associated with the backup.

", + "smithy.api#required": {} + } + }, + "BackupName": { + "target": "com.amazonaws.dynamodb#BackupName", + "traits": { + "smithy.api#documentation": "

Name of the requested backup.

", + "smithy.api#required": {} + } + }, + "BackupSizeBytes": { + "target": "com.amazonaws.dynamodb#BackupSizeBytes", + "traits": { + "smithy.api#documentation": "

Size of the backup in bytes. DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.

" + } + }, + "BackupStatus": { + "target": "com.amazonaws.dynamodb#BackupStatus", + "traits": { + "smithy.api#documentation": "

Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

", + "smithy.api#required": {} + } + }, + "BackupType": { + "target": "com.amazonaws.dynamodb#BackupType", + "traits": { + "smithy.api#documentation": "

BackupType:

\n ", + "smithy.api#required": {} + } + }, + "BackupCreationDateTime": { + "target": "com.amazonaws.dynamodb#BackupCreationDateTime", + "traits": { + "smithy.api#documentation": "

Time at which the backup was created. This is the request time of the backup.

", + "smithy.api#required": {} + } + }, + "BackupExpiryDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

Time at which the automatic on-demand backup created by DynamoDB will\n expire. This SYSTEM on-demand backup expires automatically 35 days after\n its creation.

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

Contains the details of the backup created for the table.

" + } + }, + "com.amazonaws.dynamodb#BackupInUseException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

There is another ongoing conflicting backup control plane operation on the table.\n The backup is either being created, deleted or restored to a table.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#BackupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" + } + }, + "com.amazonaws.dynamodb#BackupNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Backup not found for the given BackupARN.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#BackupSizeBytes": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.dynamodb#BackupStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + } + } + }, + "com.amazonaws.dynamodb#BackupSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#BackupSummary" + } + }, + "com.amazonaws.dynamodb#BackupSummary": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

Name of the table.

" + } + }, + "TableId": { + "target": "com.amazonaws.dynamodb#TableId", + "traits": { + "smithy.api#documentation": "

Unique identifier for the table.

" + } + }, + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

ARN associated with the table.

" + } + }, + "BackupArn": { + "target": "com.amazonaws.dynamodb#BackupArn", + "traits": { + "smithy.api#documentation": "

ARN associated with the backup.

" + } + }, + "BackupName": { + "target": "com.amazonaws.dynamodb#BackupName", + "traits": { + "smithy.api#documentation": "

Name of the specified backup.

" + } + }, + "BackupCreationDateTime": { + "target": "com.amazonaws.dynamodb#BackupCreationDateTime", + "traits": { + "smithy.api#documentation": "

Time at which the backup was created.

" + } + }, + "BackupExpiryDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

Time at which the automatic on-demand backup created by DynamoDB will\n expire. This SYSTEM on-demand backup expires automatically 35 days after\n its creation.

" + } + }, + "BackupStatus": { + "target": "com.amazonaws.dynamodb#BackupStatus", + "traits": { + "smithy.api#documentation": "

Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

" + } + }, + "BackupType": { + "target": "com.amazonaws.dynamodb#BackupType", + "traits": { + "smithy.api#documentation": "

BackupType:

\n " + } + }, + "BackupSizeBytes": { + "target": "com.amazonaws.dynamodb#BackupSizeBytes", + "traits": { + "smithy.api#documentation": "

Size of the backup in bytes.

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

Contains details for the backup.

" + } + }, + "com.amazonaws.dynamodb#BackupType": { + "type": "enum", + "members": { + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER" + } + }, + "SYSTEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYSTEM" + } + }, + "AWS_BACKUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_BACKUP" + } + } + } + }, + "com.amazonaws.dynamodb#BackupTypeFilter": { + "type": "enum", + "members": { + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER" + } + }, + "SYSTEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYSTEM" + } + }, + "AWS_BACKUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_BACKUP" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + } + } + }, + "com.amazonaws.dynamodb#BackupsInputLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.dynamodb#BatchExecuteStatement": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#BatchExecuteStatementInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#BatchExecuteStatementOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This operation allows you to perform batch reads or writes on data stored in DynamoDB,\n using PartiQL. Each read statement in a BatchExecuteStatement must specify\n an equality condition on all key attributes. This enforces that each SELECT\n statement in a batch returns at most a single item. For more information, see Running batch operations with PartiQL for DynamoDB .

\n \n

The entire batch must consist of either read statements or write statements, you\n cannot mix both in one batch.

\n \n \n

A HTTP 200 response does not mean that all statements in the BatchExecuteStatement\n succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each\n statement.

\n " + } + }, + "com.amazonaws.dynamodb#BatchExecuteStatementInput": { + "type": "structure", + "members": { + "Statements": { + "target": "com.amazonaws.dynamodb#PartiQLBatchRequest", + "traits": { + "smithy.api#documentation": "

The list of PartiQL statements representing the batch to run.

", + "smithy.api#required": {} + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#BatchExecuteStatementOutput": { + "type": "structure", + "members": { + "Responses": { + "target": "com.amazonaws.dynamodb#PartiQLBatchResponse", + "traits": { + "smithy.api#documentation": "

The response to each PartiQL statement in the batch. The values of the list are\n ordered according to the ordering of the request statements.

" + } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityMultiple", + "traits": { + "smithy.api#documentation": "

The capacity units consumed by the entire operation. The values of the list are\n ordered according to the ordering of the statements.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#BatchGetItem": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#BatchGetItemInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#BatchGetItemOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

The BatchGetItem operation returns the attributes of one or more items\n from one or more tables. You identify requested items by primary key.

\n

A single operation can retrieve up to 16 MB of data, which can contain as many as 100\n items. BatchGetItem returns a partial result if the response size limit is\n exceeded, the table's provisioned throughput is exceeded, more than 1MB per partition is\n requested, or an internal processing failure occurs. If a partial result is returned,\n the operation returns a value for UnprocessedKeys. You can use this value\n to retry the operation starting with the next item to get.

\n \n

If you request more than 100 items, BatchGetItem returns a\n ValidationException with the message \"Too many items requested for\n the BatchGetItem call.\"

\n \n

For example, if you ask to retrieve 100 items, but each individual item is 300 KB in\n size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns\n an appropriate UnprocessedKeys value so you can get the next page of\n results. If desired, your application can include its own logic to assemble the pages of\n results into one dataset.

\n

If none of the items can be processed due to insufficient\n provisioned throughput on all of the tables in the request, then\n BatchGetItem returns a\n ProvisionedThroughputExceededException. If at least\n one of the items is successfully processed, then\n BatchGetItem completes successfully, while returning the keys of the\n unread items in UnprocessedKeys.

\n \n

If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, we strongly recommend that you use an exponential\n backoff algorithm. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.

\n

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.

\n \n

By default, BatchGetItem performs eventually consistent reads on every\n table in the request. If you want strongly consistent reads instead, you can set\n ConsistentRead to true for any or all tables.

\n

In order to minimize response latency, BatchGetItem may retrieve items in\n parallel.

\n

When designing your application, keep in mind that DynamoDB does not return items in\n any particular order. To help parse the response by item, include the primary key values\n for the items in your request in the ProjectionExpression parameter.

\n

If a requested item does not exist, it is not returned in the result. Requests for\n nonexistent items consume the minimum read capacity units according to the type of read.\n For more information, see Working with Tables in the Amazon DynamoDB Developer\n Guide.

\n \n

\n BatchGetItem will result in a ValidationException if the\n same key is specified multiple times.

\n ", + "smithy.api#examples": [ + { + "title": "To retrieve multiple items from a table", + "documentation": "This example reads multiple items from the Music table using a batch of three GetItem requests. Only the AlbumTitle attribute is returned.", + "input": { + "RequestItems": { + "Music": { + "Keys": [ + { + "Artist": { + "S": "No One You Know" + }, + "SongTitle": { + "S": "Call Me Today" + } + }, + { + "Artist": { + "S": "Acme Band" + }, + "SongTitle": { + "S": "Happy Day" + } + }, + { + "Artist": { + "S": "No One You Know" + }, + "SongTitle": { + "S": "Scared of My Shadow" + } + } + ], + "ProjectionExpression": "AlbumTitle" + } + } + }, + "output": { + "Responses": { + "Music": [ + { + "AlbumTitle": { + "S": "Somewhat Famous" + } + }, + { + "AlbumTitle": { + "S": "Blue Sky Blues" + } + }, + { + "AlbumTitle": { + "S": "Louder Than Ever" + } + } + ] + } + } + } + ], + "smithy.rules#operationContextParams": { + "ResourceArnList": { + "path": "keys(RequestItems)" + } + } + } + }, + "com.amazonaws.dynamodb#BatchGetItemInput": { + "type": "structure", + "members": { + "RequestItems": { + "target": "com.amazonaws.dynamodb#BatchGetRequestMap", + "traits": { + "smithy.api#documentation": "

A map of one or more table names or table ARNs and, for each table, a map that\n describes one or more items to retrieve from that table. Each table name or ARN can be\n used only once per BatchGetItem request.

\n

Each element in the map of items to retrieve consists of the following:

\n ", + "smithy.api#required": {} + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a BatchGetItem operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#BatchGetItemOutput": { + "type": "structure", + "members": { + "Responses": { + "target": "com.amazonaws.dynamodb#BatchGetResponseMap", + "traits": { + "smithy.api#documentation": "

A map of table name or table ARN to a list of items. Each object in\n Responses consists of a table name or ARN, along with a map of\n attribute data consisting of the data type and attribute value.

" + } + }, + "UnprocessedKeys": { + "target": "com.amazonaws.dynamodb#BatchGetRequestMap", + "traits": { + "smithy.api#documentation": "

A map of tables and their respective keys that were not processed with the current\n response. The UnprocessedKeys value is in the same form as\n RequestItems, so the value can be provided directly to a subsequent\n BatchGetItem operation. For more information, see\n RequestItems in the Request Parameters section.

\n

Each element consists of:

\n \n

If there are no unprocessed keys remaining, the response contains an empty\n UnprocessedKeys map.

" + } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityMultiple", + "traits": { + "smithy.api#documentation": "

The read capacity units consumed by the entire BatchGetItem\n operation.

\n

Each element consists of:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a BatchGetItem operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#BatchGetRequestMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#TableArn" + }, + "value": { + "target": "com.amazonaws.dynamodb#KeysAndAttributes" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.dynamodb#BatchGetResponseMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#TableArn" + }, + "value": { + "target": "com.amazonaws.dynamodb#ItemList" + } + }, + "com.amazonaws.dynamodb#BatchStatementError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.dynamodb#BatchStatementErrorCodeEnum", + "traits": { + "smithy.api#documentation": "

The error code associated with the failed PartiQL batch statement.

" + } + }, + "Message": { + "target": "com.amazonaws.dynamodb#String", + "traits": { + "smithy.api#documentation": "

The error message associated with the PartiQL batch response.

" + } + }, + "Item": { + "target": "com.amazonaws.dynamodb#AttributeMap", + "traits": { + "smithy.api#documentation": "

The item which caused the condition check to fail. This will be set if\n ReturnValuesOnConditionCheckFailure is specified as ALL_OLD.

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

An error associated with a statement in a PartiQL batch that was run.

" + } + }, + "com.amazonaws.dynamodb#BatchStatementErrorCodeEnum": { + "type": "enum", + "members": { + "ConditionalCheckFailed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ConditionalCheckFailed" + } + }, + "ItemCollectionSizeLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ItemCollectionSizeLimitExceeded" + } + }, + "RequestLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RequestLimitExceeded" + } + }, + "ValidationError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ValidationError" + } + }, + "ProvisionedThroughputExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ProvisionedThroughputExceeded" + } + }, + "TransactionConflict": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TransactionConflict" + } + }, + "ThrottlingError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ThrottlingError" + } + }, + "InternalServerError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InternalServerError" + } + }, + "ResourceNotFound": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceNotFound" + } + }, + "AccessDenied": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessDenied" + } + }, + "DuplicateItem": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DuplicateItem" + } + } + } + }, + "com.amazonaws.dynamodb#BatchStatementRequest": { + "type": "structure", + "members": { + "Statement": { + "target": "com.amazonaws.dynamodb#PartiQLStatement", + "traits": { + "smithy.api#documentation": "

A valid PartiQL statement.

", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.dynamodb#PreparedStatementParameters", + "traits": { + "smithy.api#documentation": "

The parameters associated with a PartiQL statement in the batch request.

" + } + }, + "ConsistentRead": { + "target": "com.amazonaws.dynamodb#ConsistentRead", + "traits": { + "smithy.api#documentation": "

The read consistency of the PartiQL batch request.

" + } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "

An optional parameter that returns the item attributes for a PartiQL batch request\n operation that failed a condition check.

\n

There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

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

A PartiQL batch statement request.

" + } + }, + "com.amazonaws.dynamodb#BatchStatementResponse": { + "type": "structure", + "members": { + "Error": { + "target": "com.amazonaws.dynamodb#BatchStatementError", + "traits": { + "smithy.api#documentation": "

The error associated with a failed PartiQL batch statement.

" + } + }, + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The table name associated with a failed PartiQL batch statement.

" + } + }, + "Item": { + "target": "com.amazonaws.dynamodb#AttributeMap", + "traits": { + "smithy.api#documentation": "

A DynamoDB item associated with a BatchStatementResponse

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

A PartiQL batch statement response..

" + } + }, + "com.amazonaws.dynamodb#BatchWriteItem": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#BatchWriteItemInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#BatchWriteItemOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ItemCollectionSizeLimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ReplicatedWriteConflictException" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

The BatchWriteItem operation puts or deletes multiple items in one or\n more tables. A single call to BatchWriteItem can transmit up to 16MB of\n data over the network, consisting of up to 25 item put or delete operations. While\n individual items can be up to 400 KB once stored, it's important to note that an item's\n representation might be greater than 400KB while being sent in DynamoDB's JSON format\n for the API call. For more details on this distinction, see Naming Rules and Data Types.

\n \n

\n BatchWriteItem cannot update items. If you perform a\n BatchWriteItem operation on an existing item, that item's values\n will be overwritten by the operation and it will appear like it was updated. To\n update items, we recommend you use the UpdateItem action.

\n \n

The individual PutItem and DeleteItem operations specified\n in BatchWriteItem are atomic; however BatchWriteItem as a\n whole is not. If any requested operations fail because the table's provisioned\n throughput is exceeded or an internal processing failure occurs, the failed operations\n are returned in the UnprocessedItems response parameter. You can\n investigate and optionally resend the requests. Typically, you would call\n BatchWriteItem in a loop. Each iteration would check for unprocessed\n items and submit a new BatchWriteItem request with those unprocessed items\n until all items have been processed.

\n

If BatchWriteItem cannot process any items due to throttling (for\n example, insufficient provisioned throughput on the tables in the request, or\n partition-level or account-level limits), it returns a\n ProvisionedThroughputExceededException or a\n ThrottlingException. Both indicate that the request was throttled;\n check the ThrottlingReason field in the returned exception for details.

\n \n

If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, we strongly recommend that you use an exponential\n backoff algorithm. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.

\n

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.

\n \n

With BatchWriteItem, you can efficiently write or delete large amounts of\n data, such as from Amazon EMR, or copy data from another database into DynamoDB. In\n order to improve performance with these large-scale operations,\n BatchWriteItem does not behave in the same way as individual\n PutItem and DeleteItem calls would. For example, you\n cannot specify conditions on individual put and delete requests, and\n BatchWriteItem does not return deleted items in the response.

\n

If you use a programming language that supports concurrency, you can use threads to\n write items in parallel. Your application must include the necessary logic to manage the\n threads. With languages that don't support threading, you must update or delete the\n specified items one at a time. In both situations, BatchWriteItem performs\n the specified put and delete operations in parallel, giving you the power of the thread\n pool approach without having to introduce complexity into your application.

\n

Parallel processing reduces latency, but each specified put and delete request\n consumes the same number of write capacity units whether it is processed in parallel or\n not. Delete operations on nonexistent items consume one write capacity unit.

\n

If one or more of the following is true, DynamoDB rejects the entire batch write\n operation:

\n ", + "smithy.api#examples": [ + { + "title": "To add multiple items to a table", + "documentation": "This example adds three new items to the Music table using a batch of three PutItem requests.", + "input": { + "RequestItems": { + "Music": [ + { + "PutRequest": { + "Item": { + "AlbumTitle": { + "S": "Somewhat Famous" + }, + "SongTitle": { + "S": "Call Me Today" + }, + "Artist": { + "S": "No One You Know" + } + } + } + }, + { + "PutRequest": { + "Item": { + "AlbumTitle": { + "S": "Songs About Life" + }, + "SongTitle": { + "S": "Happy Day" + }, + "Artist": { + "S": "Acme Band" + } + } + } + }, + { + "PutRequest": { + "Item": { + "AlbumTitle": { + "S": "Blue Sky Blues" + }, + "SongTitle": { + "S": "Scared of My Shadow" + }, + "Artist": { + "S": "No One You Know" + } + } + } + } + ] + } + }, + "output": {} + } + ], + "smithy.rules#operationContextParams": { + "ResourceArnList": { + "path": "keys(RequestItems)" + } + } + } + }, + "com.amazonaws.dynamodb#BatchWriteItemInput": { + "type": "structure", + "members": { + "RequestItems": { + "target": "com.amazonaws.dynamodb#BatchWriteItemRequestMap", + "traits": { + "smithy.api#documentation": "

A map of one or more table names or table ARNs and, for each table, a list of\n operations to be performed (DeleteRequest or PutRequest). Each\n element in the map consists of the following:

\n ", + "smithy.api#required": {} + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + }, + "ReturnItemCollectionMetrics": { + "target": "com.amazonaws.dynamodb#ReturnItemCollectionMetrics", + "traits": { + "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to SIZE,\n the response includes statistics about item collections, if any, that were modified\n during the operation are returned in the response. If set to NONE (the\n default), no statistics are returned.

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

Represents the input of a BatchWriteItem operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#BatchWriteItemOutput": { + "type": "structure", + "members": { + "UnprocessedItems": { + "target": "com.amazonaws.dynamodb#BatchWriteItemRequestMap", + "traits": { + "smithy.api#documentation": "

A map of tables and requests against those tables that were not processed. The\n UnprocessedItems value is in the same form as\n RequestItems, so you can provide this value directly to a subsequent\n BatchWriteItem operation. For more information, see\n RequestItems in the Request Parameters section.

\n

Each UnprocessedItems entry consists of a table name or table ARN\n and, for that table, a list of operations to perform (DeleteRequest or\n PutRequest).

\n \n

If there are no unprocessed items remaining, the response contains an empty\n UnprocessedItems map.

" + } + }, + "ItemCollectionMetrics": { + "target": "com.amazonaws.dynamodb#ItemCollectionMetricsPerTable", + "traits": { + "smithy.api#documentation": "

A list of tables that were processed by BatchWriteItem and, for each\n table, information about any item collections that were affected by individual\n DeleteItem or PutItem operations.

\n

Each entry consists of the following subelements:

\n " + } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityMultiple", + "traits": { + "smithy.api#documentation": "

The capacity units consumed by the entire BatchWriteItem\n operation.

\n

Each element consists of:

\n \n

If the table has vector indexes, each element also includes a\n VectorIndexes field with VectorWriteRequestBytes consumed\n for each affected vector index.

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

Represents the output of a BatchWriteItem operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#BatchWriteItemRequestMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#TableArn" + }, + "value": { + "target": "com.amazonaws.dynamodb#WriteRequests" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.dynamodb#BilledSizeBytes": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.dynamodb#BillingMode": { + "type": "enum", + "members": { + "PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROVISIONED" + } + }, + "PAY_PER_REQUEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAY_PER_REQUEST" + } + } + } + }, + "com.amazonaws.dynamodb#BillingModeSummary": { + "type": "structure", + "members": { + "BillingMode": { + "target": "com.amazonaws.dynamodb#BillingMode", + "traits": { + "smithy.api#documentation": "

Controls how you are charged for read and write throughput and how you manage\n capacity. This setting can be changed later.

\n " + } + }, + "LastUpdateToPayPerRequestDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

Represents the time when PAY_PER_REQUEST was last set as the read/write\n capacity mode.

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

Contains the details for the read/write capacity mode. This page talks about\n PROVISIONED and PAY_PER_REQUEST billing modes. For more\n information about these modes, see Read/write capacity mode.

\n \n

You may need to switch to on-demand mode at least once in order to return a\n BillingModeSummary response.

\n " + } + }, + "com.amazonaws.dynamodb#BinaryAttributeValue": { + "type": "blob" + }, + "com.amazonaws.dynamodb#BinarySetAttributeValue": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#BinaryAttributeValue" + } + }, + "com.amazonaws.dynamodb#BooleanAttributeValue": { + "type": "boolean" + }, + "com.amazonaws.dynamodb#BooleanObject": { + "type": "boolean" + }, + "com.amazonaws.dynamodb#CancellationReason": { + "type": "structure", + "members": { + "Item": { + "target": "com.amazonaws.dynamodb#AttributeMap", + "traits": { + "smithy.api#documentation": "

Item in the request which caused the transaction to get cancelled.

" + } + }, + "Code": { + "target": "com.amazonaws.dynamodb#Code", + "traits": { + "smithy.api#documentation": "

Status code for the result of the cancelled transaction.

" + } + }, + "Message": { + "target": "com.amazonaws.dynamodb#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Cancellation reason message description.

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

An ordered list of errors for each item in the request which caused the transaction to\n get cancelled. The values of the list are ordered according to the ordering of the\n TransactWriteItems request parameter. If no error occurred for the\n associated item an error with a Null code and Null message will be present.

" + } + }, + "com.amazonaws.dynamodb#CancellationReasonList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#CancellationReason" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.dynamodb#Capacity": { + "type": "structure", + "members": { + "ReadCapacityUnits": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityUnits", + "traits": { + "smithy.api#documentation": "

The total number of read capacity units consumed on a table or an index.

" + } + }, + "WriteCapacityUnits": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityUnits", + "traits": { + "smithy.api#documentation": "

The total number of write capacity units consumed on a table or an index.

" + } + }, + "CapacityUnits": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityUnits", + "traits": { + "smithy.api#documentation": "

The total number of capacity units consumed on a table or an index.

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

Represents the amount of provisioned throughput capacity consumed on a table or an\n index.

" + } + }, + "com.amazonaws.dynamodb#ClientRequestToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 36 + } + } + }, + "com.amazonaws.dynamodb#ClientToken": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[^\\$]+$" + } + }, + "com.amazonaws.dynamodb#CloudWatchLogGroupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.dynamodb#Code": { + "type": "string" + }, + "com.amazonaws.dynamodb#ComparisonOperator": { + "type": "enum", + "members": { + "EQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQ" + } + }, + "NE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NE" + } + }, + "IN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN" + } + }, + "LE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LE" + } + }, + "LT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LT" + } + }, + "GE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GE" + } + }, + "GT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GT" + } + }, + "BETWEEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BETWEEN" + } + }, + "NOT_NULL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_NULL" + } + }, + "NULL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NULL" + } + }, + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS" + } + }, + "NOT_CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_CONTAINS" + } + }, + "BEGINS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEGINS_WITH" + } + } + } + }, + "com.amazonaws.dynamodb#Condition": { + "type": "structure", + "members": { + "AttributeValueList": { + "target": "com.amazonaws.dynamodb#AttributeValueList", + "traits": { + "smithy.api#documentation": "

One or more values to evaluate against the supplied attribute. The number of values in\n the list depends on the ComparisonOperator being used.

\n

For type Number, value comparisons are numeric.

\n

String value comparisons for greater than, equals, or less than are based on ASCII\n character code values. For example, a is greater than A, and\n a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

\n

For Binary, DynamoDB treats each byte of the binary data as unsigned when it\n compares binary values.

" + } + }, + "ComparisonOperator": { + "target": "com.amazonaws.dynamodb#ComparisonOperator", + "traits": { + "smithy.api#documentation": "

A comparator for evaluating attributes. For example, equals, greater than, less than,\n etc.

\n

The following comparison operators are available:

\n

\n EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS |\n BEGINS_WITH | IN | BETWEEN\n

\n

The following are descriptions of each comparison operator.

\n \n

For usage examples of AttributeValueList and\n ComparisonOperator, see Legacy\n Conditional Parameters in the Amazon DynamoDB Developer\n Guide.

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

Represents the selection criteria for a Query or Scan\n operation:

\n " + } + }, + "com.amazonaws.dynamodb#ConditionCheck": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

The primary key of the item to be checked. Each element consists of an attribute name\n and a value for that attribute.

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

Name of the table for the check item request. You can also provide the Amazon Resource Name (ARN) of\n the table in this parameter.

", + "smithy.api#required": {} + } + }, + "ConditionExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", + "traits": { + "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional update to succeed. For\n more information, see Condition expressions in the Amazon DynamoDB Developer\n Guide.

", + "smithy.api#required": {} + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. For more\n information, see Expression attribute names in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "traits": { + "smithy.api#documentation": "

One or more values that can be substituted in an expression. For more information, see\n Condition expressions in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the\n ConditionCheck condition fails. For\n ReturnValuesOnConditionCheckFailure, the valid values are: NONE and\n ALL_OLD.

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

Represents a request to perform a check that an item exists or to check the condition\n of specific attributes of the item.

" + } + }, + "com.amazonaws.dynamodb#ConditionExpression": { + "type": "string" + }, + "com.amazonaws.dynamodb#ConditionalCheckFailedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The conditional request failed.

" + } + }, + "Item": { + "target": "com.amazonaws.dynamodb#AttributeMap", + "traits": { + "smithy.api#documentation": "

Item which caused the ConditionalCheckFailedException.

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

A condition specified in the operation failed to be evaluated.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ConditionalOperator": { + "type": "enum", + "members": { + "AND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AND" + } + }, + "OR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OR" + } + } + } + }, + "com.amazonaws.dynamodb#ConfirmRemoveSelfResourceAccess": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.dynamodb#ConsistentRead": { + "type": "boolean" + }, + "com.amazonaws.dynamodb#ConsumedCapacity": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table that was affected by the operation. If you had specified the\n Amazon Resource Name (ARN) of a table in the input, you'll see the table ARN in the response.

" + } + }, + "CapacityUnits": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityUnits", + "traits": { + "smithy.api#documentation": "

The total number of capacity units consumed by the operation.

" + } + }, + "ReadCapacityUnits": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityUnits", + "traits": { + "smithy.api#documentation": "

The total number of read capacity units consumed by the operation.

" + } + }, + "WriteCapacityUnits": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityUnits", + "traits": { + "smithy.api#documentation": "

The total number of write capacity units consumed by the operation.

" + } + }, + "Table": { + "target": "com.amazonaws.dynamodb#Capacity", + "traits": { + "smithy.api#documentation": "

The amount of throughput consumed on the table affected by the operation.

" + } + }, + "LocalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#SecondaryIndexesCapacityMap", + "traits": { + "smithy.api#documentation": "

The amount of throughput consumed on each local index affected by the\n operation.

" + } + }, + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#SecondaryIndexesCapacityMap", + "traits": { + "smithy.api#documentation": "

The amount of throughput consumed on each global index affected by the\n operation.

" + } + }, + "VectorIndexes": { + "target": "com.amazonaws.dynamodb#VectorIndexesCapacityMap", + "traits": { + "smithy.api#documentation": "

The amount of throughput consumed on each vector index affected by the operation.\n Each entry contains VectorWriteRequestBytes (for write operations) or\n VectorSearchRequestBytes (for search operations).

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

The capacity units consumed by an operation. The data returned includes the total\n provisioned throughput consumed, along with statistics for the table and any indexes\n involved in the operation. ConsumedCapacity is only returned if the request\n asked for it. For more information, see Provisioned capacity mode in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "com.amazonaws.dynamodb#ConsumedCapacityMultiple": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ConsumedCapacity" + } + }, + "com.amazonaws.dynamodb#ConsumedCapacityUnits": { + "type": "double" + }, + "com.amazonaws.dynamodb#ContinuousBackupsDescription": { + "type": "structure", + "members": { + "ContinuousBackupsStatus": { + "target": "com.amazonaws.dynamodb#ContinuousBackupsStatus", + "traits": { + "smithy.api#documentation": "

\n ContinuousBackupsStatus can be one of the following states: ENABLED,\n DISABLED

", + "smithy.api#required": {} + } + }, + "PointInTimeRecoveryDescription": { + "target": "com.amazonaws.dynamodb#PointInTimeRecoveryDescription", + "traits": { + "smithy.api#documentation": "

The description of the point in time recovery settings applied to the table.

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

Represents the continuous backups and point in time recovery settings on the\n table.

" + } + }, + "com.amazonaws.dynamodb#ContinuousBackupsStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.dynamodb#ContinuousBackupsUnavailableException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Backups have not yet been enabled for this table.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ContributorInsightsAction": { + "type": "enum", + "members": { + "ENABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLE" + } + }, + "DISABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLE" + } + } + } + }, + "com.amazonaws.dynamodb#ContributorInsightsMode": { + "type": "enum", + "members": { + "ACCESSED_AND_THROTTLED_KEYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCESSED_AND_THROTTLED_KEYS" + } + }, + "THROTTLED_KEYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THROTTLED_KEYS" + } + } + } + }, + "com.amazonaws.dynamodb#ContributorInsightsRule": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9\\-\\_\\.]{0,126}[A-Za-z0-9]$" + } + }, + "com.amazonaws.dynamodb#ContributorInsightsRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ContributorInsightsRule" + } + }, + "com.amazonaws.dynamodb#ContributorInsightsStatus": { + "type": "enum", + "members": { + "ENABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLING" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLING" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.dynamodb#ContributorInsightsSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ContributorInsightsSummary" + } + }, + "com.amazonaws.dynamodb#ContributorInsightsSummary": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

Name of the table associated with the summary.

" + } + }, + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

Name of the index associated with the summary, if any.

" + } + }, + "ContributorInsightsStatus": { + "target": "com.amazonaws.dynamodb#ContributorInsightsStatus", + "traits": { + "smithy.api#documentation": "

Describes the current status for contributor insights for the given table and index,\n if applicable.

" + } + }, + "ContributorInsightsMode": { + "target": "com.amazonaws.dynamodb#ContributorInsightsMode", + "traits": { + "smithy.api#documentation": "

Indicates the current mode of CloudWatch Contributor Insights, specifying whether it\n tracks all access and throttled events or throttled events only for the DynamoDB\n table or index.

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

Represents a Contributor Insights summary entry.

" + } + }, + "com.amazonaws.dynamodb#CreateBackup": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#CreateBackupInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#CreateBackupOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#BackupInUseException" + }, + { + "target": "com.amazonaws.dynamodb#ContinuousBackupsUnavailableException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#TableInUseException" + }, + { + "target": "com.amazonaws.dynamodb#TableNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Creates a backup for an existing table.

\n

Each time you create an on-demand backup, the entire table data is backed up. There\n is no limit to the number of on-demand backups that can be taken.

\n

When you create an on-demand backup, a time marker of the request is cataloged, and\n the backup is created asynchronously, by applying all changes until the time of the\n request to the last full table snapshot. Backup requests are processed instantaneously\n and become available for restore within minutes.

\n

You can call CreateBackup at a maximum rate of 50 times per\n second.

\n

All backups in DynamoDB work without consuming any provisioned throughput on the\n table.

\n

If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to\n contain all data committed to the table up to 14:24:00, and data committed after\n 14:26:00 will not be. The backup might contain data modifications made between 14:24:00\n and 14:26:00. On-demand backup does not support causal consistency.

\n

Along with data, the following are also included on the backups:

\n " + } + }, + "com.amazonaws.dynamodb#CreateBackupInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this\n parameter.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "BackupName": { + "target": "com.amazonaws.dynamodb#BackupName", + "traits": { + "smithy.api#documentation": "

Specified name for the backup.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#CreateBackupOutput": { + "type": "structure", + "members": { + "BackupDetails": { + "target": "com.amazonaws.dynamodb#BackupDetails", + "traits": { + "smithy.api#documentation": "

Contains the details of the backup created for the table.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#CreateGlobalSecondaryIndexAction": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index to be created.

", + "smithy.api#required": {} + } + }, + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", + "traits": { + "smithy.api#documentation": "

The key schema for the global secondary index.\n Global secondary index supports up to 4 partition and up to 4 sort keys.

", + "smithy.api#required": {} + } + }, + "Projection": { + "target": "com.amazonaws.dynamodb#Projection", + "traits": { + "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into an index. These\n are in addition to the primary key attributes and index key attributes, which are\n automatically projected.

", + "smithy.api#required": {} + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "traits": { + "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary\n index.

\n

For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "

The maximum number of read and write units for the global secondary index being\n created. If you use this parameter, you must specify MaxReadRequestUnits,\n MaxWriteRequestUnits, or both. You must use either OnDemand\n Throughput or ProvisionedThroughput based on your table's\n capacity mode.

" + } + }, + "WarmThroughput": { + "target": "com.amazonaws.dynamodb#WarmThroughput", + "traits": { + "smithy.api#documentation": "

Represents the warm throughput value (in read units per second and write units per\n second) when creating a secondary index.

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

Represents a new global secondary index to be added to an existing table.

" + } + }, + "com.amazonaws.dynamodb#CreateGlobalTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#CreateGlobalTableInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#CreateGlobalTableOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#GlobalTableAlreadyExistsException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#TableNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Creates a global table from an existing table. A global table creates a replication\n relationship between two or more DynamoDB tables with the same table name in the\n provided Regions.

\n \n

This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

\n

To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

\n \n

If you want to add a new replica table to a global table, each of the following\n conditions must be true:

\n \n

If global secondary indexes are specified, then the following conditions must also be\n met:

\n \n

If local secondary indexes are specified, then the following conditions must also be\n met:

\n \n \n

Write capacity settings should be set consistently across your replica tables and\n secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the\n write capacity settings for all of your global tables replicas and indexes.

\n

If you prefer to manage write capacity settings manually, you should provision\n equal replicated write capacity units to your replica tables. You should also\n provision equal replicated write capacity units to matching secondary indexes across\n your global table.

\n " + } + }, + "com.amazonaws.dynamodb#CreateGlobalTableInput": { + "type": "structure", + "members": { + "GlobalTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The global table name.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "ReplicationGroup": { + "target": "com.amazonaws.dynamodb#ReplicaList", + "traits": { + "smithy.api#documentation": "

The Regions where the global table needs to be created.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#CreateGlobalTableOutput": { + "type": "structure", + "members": { + "GlobalTableDescription": { + "target": "com.amazonaws.dynamodb#GlobalTableDescription", + "traits": { + "smithy.api#documentation": "

Contains the details of the global table.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#CreateGlobalTableWitnessGroupMemberAction": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region name to be added as a witness Region for the MRSC global\n table. The witness must be in a different Region than the replicas and within the same\n Region set:

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

Specifies the action to add a new witness Region to a MRSC global table. A MRSC global\n table can be configured with either three replicas, or with two replicas and one\n witness.

" + } + }, + "com.amazonaws.dynamodb#CreateReplicaAction": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

The Region of the replica to be added.

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

Represents a replica to be added.

" + } + }, + "com.amazonaws.dynamodb#CreateReplicationGroupMemberAction": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

The Region where the new replica will be created.

", + "smithy.api#required": {} + } + }, + "KMSMasterKeyId": { + "target": "com.amazonaws.dynamodb#KMSMasterKeyId", + "traits": { + "smithy.api#documentation": "

The KMS key that should be used for KMS encryption in\n the new replica. To specify a key, use its key ID, Amazon Resource Name (ARN), alias\n name, or alias ARN. Note that you should only provide this parameter if the key is\n different from the default DynamoDB KMS key\n alias/aws/dynamodb.

" + } + }, + "ProvisionedThroughputOverride": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputOverride", + "traits": { + "smithy.api#documentation": "

Replica-specific provisioned throughput. If not specified, uses the source table's\n provisioned throughput settings.

" + } + }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughputOverride", + "traits": { + "smithy.api#documentation": "

The maximum on-demand throughput settings for the specified replica table being\n created. You can only modify MaxReadRequestUnits, because you can't modify\n MaxWriteRequestUnits for individual replica tables.

" + } + }, + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

Replica-specific global secondary index settings.

" + } + }, + "TableClassOverride": { + "target": "com.amazonaws.dynamodb#TableClass", + "traits": { + "smithy.api#documentation": "

Replica-specific table class. If not specified, uses the source table's table\n class.

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

Represents a replica to be created.

" + } + }, + "com.amazonaws.dynamodb#CreateTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#CreateTableInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#CreateTableOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

The CreateTable operation adds a new table to your account. In an Amazon Web Services account, table names must be unique within each Region. That is, you can\n have two tables with same name if you create the tables in different Regions.

\n

\n CreateTable is an asynchronous operation. Upon receiving a\n CreateTable request, DynamoDB immediately returns a response with a\n TableStatus of CREATING. After the table is created,\n DynamoDB sets the TableStatus to ACTIVE. You can perform read\n and write operations only on an ACTIVE table.

\n

You can optionally define secondary indexes on the new table, as part of the\n CreateTable operation. If you want to create multiple tables with\n secondary indexes on them, you must create the tables sequentially. Only one table with\n secondary indexes can be in the CREATING state at any given time.

\n

You can use the DescribeTable action to check the table status.

" + } + }, + "com.amazonaws.dynamodb#CreateTableInput": { + "type": "structure", + "members": { + "AttributeDefinitions": { + "target": "com.amazonaws.dynamodb#AttributeDefinitions", + "traits": { + "smithy.api#documentation": "

An array of attributes that describe the key schema for the table and indexes.

" + } + }, + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table to create. You can also provide the Amazon Resource Name (ARN) of the table in\n this parameter.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", + "traits": { + "smithy.api#documentation": "

Specifies the attributes that make up the primary key for a table or an index. The\n attributes in KeySchema must also be defined in the\n AttributeDefinitions array. For more information, see Data\n Model in the Amazon DynamoDB Developer Guide.

\n

Each KeySchemaElement in the array is composed of:

\n \n \n

The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from the DynamoDB usage\n of an internal hash function to evenly distribute data items across partitions,\n based on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key\n value.

\n \n

For a simple primary key (partition key), you must provide exactly one element with a\n KeyType of HASH.

\n

For a composite primary key (partition key and sort key), you must provide exactly two\n elements, in this order: The first element must have a KeyType of\n HASH, and the second element must have a KeyType of\n RANGE.

\n

For more information, see Working with Tables in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "LocalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#LocalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

One or more local secondary indexes (the maximum is 5) to be created on the table.\n Each index is scoped to a given partition key value. There is a 10 GB size limit per\n partition key value; otherwise, the size of a local secondary index is\n unconstrained.

\n

Each local secondary index in the array includes the following:

\n " + } + }, + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

One or more global secondary indexes (the maximum is 20) to be created on the table.\n Each global secondary index in the array includes the following:

\n " + } + }, + "BillingMode": { + "target": "com.amazonaws.dynamodb#BillingMode", + "traits": { + "smithy.api#documentation": "

Controls how you are charged for read and write throughput and how you manage\n capacity. This setting can be changed later.

\n " + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "traits": { + "smithy.api#documentation": "

Represents the provisioned throughput settings for a specified table or index. The\n settings can be modified using the UpdateTable operation.

\n

If you set BillingMode as PROVISIONED, you must specify this property.\n If you set BillingMode as PAY_PER_REQUEST, you cannot specify this\n property.

\n

For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "StreamSpecification": { + "target": "com.amazonaws.dynamodb#StreamSpecification", + "traits": { + "smithy.api#documentation": "

The settings for DynamoDB Streams on the table. These settings consist of:

\n " + } + }, + "SSESpecification": { + "target": "com.amazonaws.dynamodb#SSESpecification", + "traits": { + "smithy.api#documentation": "

Represents the settings used to enable server-side encryption.

" + } + }, + "Tags": { + "target": "com.amazonaws.dynamodb#TagList", + "traits": { + "smithy.api#documentation": "

A list of key-value pairs to label the table. For more information, see Tagging\n for DynamoDB.

" + } + }, + "TableClass": { + "target": "com.amazonaws.dynamodb#TableClass", + "traits": { + "smithy.api#documentation": "

The table class of the new table. Valid values are STANDARD and\n STANDARD_INFREQUENT_ACCESS.

" + } + }, + "DeletionProtectionEnabled": { + "target": "com.amazonaws.dynamodb#DeletionProtectionEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether deletion protection is to be enabled (true) or disabled (false) on\n the table.

" + } + }, + "WarmThroughput": { + "target": "com.amazonaws.dynamodb#WarmThroughput", + "traits": { + "smithy.api#documentation": "

Represents the warm throughput (in read units per second and write units per second)\n for creating a table.

" + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.dynamodb#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

An Amazon Web Services resource-based policy document in JSON format that will be\n attached to the table.

\n

When you attach a resource-based policy while creating a table, the policy application\n is strongly consistent.

\n

The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this\n limit. For a full list of all considerations that apply for resource-based policies, see\n Resource-based\n policy considerations.

\n \n

You need to specify the CreateTable and\n PutResourcePolicy\n IAM actions for authorizing a user to create a table with a\n resource-based policy.

\n " + } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "

Sets the maximum number of read and write units for the specified table in on-demand\n capacity mode. If you use this parameter, you must specify\n MaxReadRequestUnits, MaxWriteRequestUnits, or both.

" + } + }, + "GlobalTableSourceArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source table used for the creation\n of a multi-account global table.

" + } + }, + "GlobalTableSettingsReplicationMode": { + "target": "com.amazonaws.dynamodb#GlobalTableSettingsReplicationMode", + "traits": { + "smithy.api#documentation": "

Controls the settings synchronization mode for the global table. For multi-account global tables,\n this parameter is required and the only supported value is ENABLED. For same-account global tables,\n this parameter is set to ENABLED_WITH_OVERRIDES.\n

" + } + }, + "VectorIndexes": { + "target": "com.amazonaws.dynamodb#VectorIndexList", + "traits": { + "smithy.api#documentation": "

One or more vector indexes to be created on the table. Each vector index enables\n similarity search on a vector attribute. Each element in the list consists of:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a CreateTable operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#CreateTableOutput": { + "type": "structure", + "members": { + "TableDescription": { + "target": "com.amazonaws.dynamodb#TableDescription", + "traits": { + "smithy.api#documentation": "

Represents the properties of the table.

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

Represents the output of a CreateTable operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#CreateVectorIndexAction": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the vector index. Must be unique within the table.

", + "smithy.api#required": {} + } + }, + "VectorAttribute": { + "target": "com.amazonaws.dynamodb#VectorAttributeDefinition", + "traits": { + "smithy.api#documentation": "

The attribute that contains vector embeddings. If multiple vector indexes\n reference the same attribute, they must all use the same number of\n dimensions.

", + "smithy.api#required": {} + } + }, + "SearchSchema": { + "target": "com.amazonaws.dynamodb#SearchSchema", + "traits": { + "smithy.api#documentation": "

The partition key and inline filter attribute definitions for the vector\n index.

" + } + }, + "Projection": { + "target": "com.amazonaws.dynamodb#Projection", + "traits": { + "smithy.api#documentation": "

Specifies attributes that are copied (projected) from the table into the vector\n index.

", + "smithy.api#required": {} + } + }, + "Dimensions": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The number of dimensions in each vector.

", + "smithy.api#required": {} + } + }, + "DistanceFunction": { + "target": "com.amazonaws.dynamodb#VectorDistanceFunction", + "traits": { + "smithy.api#documentation": "

The distance function used to calculate similarity. Valid values:\n COSINE, EUCLIDEAN, DOT_PRODUCT.

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

A new vector index to be added to a table.

" + } + }, + "com.amazonaws.dynamodb#CsvDelimiter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#pattern": "^[,;:|\\t ]$" + } + }, + "com.amazonaws.dynamodb#CsvHeader": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 65536 + }, + "smithy.api#pattern": "^[\\x20-\\x21\\x23-\\x2B\\x2D-\\x7E]*$" + } + }, + "com.amazonaws.dynamodb#CsvHeaderList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#CsvHeader" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.dynamodb#CsvOptions": { + "type": "structure", + "members": { + "Delimiter": { + "target": "com.amazonaws.dynamodb#CsvDelimiter", + "traits": { + "smithy.api#documentation": "

The delimiter used for separating items in the CSV file being imported.

" + } + }, + "HeaderList": { + "target": "com.amazonaws.dynamodb#CsvHeaderList", + "traits": { + "smithy.api#documentation": "

List of the headers used to specify a common header for all source CSV files being\n imported. If this field is specified then the first line of each CSV file is treated as\n data instead of the header. If this field is not specified the the first line of each\n CSV file is treated as the header.

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

Processing options for the CSV file being imported.

" + } + }, + "com.amazonaws.dynamodb#Date": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#Delete": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

The primary key of the item to be deleted. Each element consists of an attribute name\n and a value for that attribute.

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

Name of the table in which the item to be deleted resides. You can also provide the\n Amazon Resource Name (ARN) of the table in this parameter.

", + "smithy.api#required": {} + } + }, + "ConditionExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", + "traits": { + "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional delete to\n succeed.

" + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression.

" + } + }, + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "traits": { + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

" + } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the\n Delete condition fails. For\n ReturnValuesOnConditionCheckFailure, the valid values are: NONE and\n ALL_OLD.

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

Represents a request to perform a DeleteItem operation.

" + } + }, + "com.amazonaws.dynamodb#DeleteBackup": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DeleteBackupInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DeleteBackupOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#BackupInUseException" + }, + { + "target": "com.amazonaws.dynamodb#BackupNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Deletes an existing backup of a table.

\n

You can call DeleteBackup at a maximum rate of 10 times per\n second.

" + } + }, + "com.amazonaws.dynamodb#DeleteBackupInput": { + "type": "structure", + "members": { + "BackupArn": { + "target": "com.amazonaws.dynamodb#BackupArn", + "traits": { + "smithy.api#documentation": "

The ARN associated with the backup.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DeleteBackupOutput": { + "type": "structure", + "members": { + "BackupDescription": { + "target": "com.amazonaws.dynamodb#BackupDescription", + "traits": { + "smithy.api#documentation": "

Contains the description of the backup created for the table.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DeleteGlobalSecondaryIndexAction": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index to be deleted.

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

Represents a global secondary index to be deleted from an existing table.

" + } + }, + "com.amazonaws.dynamodb#DeleteGlobalTableWitnessGroupMemberAction": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

The witness Region name to be removed from the MRSC global table.

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

Specifies the action to remove a witness Region from a MRSC global table. You cannot\n delete a single witness from a MRSC global table - you must delete both a replica and\n the witness together. The deletion of both a witness and replica converts the remaining\n replica to a single-Region DynamoDB table.

" + } + }, + "com.amazonaws.dynamodb#DeleteItem": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DeleteItemInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DeleteItemOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#ConditionalCheckFailedException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ItemCollectionSizeLimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ReplicatedWriteConflictException" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" + }, + { + "target": "com.amazonaws.dynamodb#TransactionConflictException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Deletes a single item in a table by primary key. You can perform a conditional delete\n operation that deletes the item if it exists, or if it has an expected attribute\n value.

\n

In addition to deleting an item, you can also return the item's attribute values in\n the same operation, using the ReturnValues parameter.

\n

Unless you specify conditions, the DeleteItem is an idempotent operation;\n running it multiple times on the same item or attribute does not\n result in an error response.

\n

Conditional deletes are useful for deleting items only if specific conditions are met.\n If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not\n deleted.

", + "smithy.api#examples": [ + { + "title": "To delete an item", + "documentation": "This example deletes an item from the Music table.", + "input": { + "TableName": "Music", + "Key": { + "Artist": { + "S": "No One You Know" + }, + "SongTitle": { + "S": "Scared of My Shadow" + } + } + }, + "output": { + "ConsumedCapacity": { + "CapacityUnits": 1, + "TableName": "Music" + } + } + } + ] + } + }, + "com.amazonaws.dynamodb#DeleteItemInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table from which to delete the item. You can also provide the\n Amazon Resource Name (ARN) of the table in this parameter.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "Key": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

A map of attribute names to AttributeValue objects, representing the\n primary key of the item to delete.

\n

For the primary key, you must provide all of the key attributes. For example, with a\n simple primary key, you only need to provide a value for the partition key. For a\n composite primary key, you must provide values for both the partition key and the sort\n key.

", + "smithy.api#required": {} + } + }, + "Expected": { + "target": "com.amazonaws.dynamodb#ExpectedAttributeMap", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more\n information, see Expected in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ConditionalOperator": { + "target": "com.amazonaws.dynamodb#ConditionalOperator", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more\n information, see ConditionalOperator in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ReturnValues": { + "target": "com.amazonaws.dynamodb#ReturnValue", + "traits": { + "smithy.api#documentation": "

Use ReturnValues if you want to get the item attributes as they appeared\n before they were deleted. For DeleteItem, the valid values are:

\n \n

There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

\n \n

The ReturnValues parameter is used by several DynamoDB operations;\n however, DeleteItem does not recognize any values other than\n NONE or ALL_OLD.

\n " + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + }, + "ReturnItemCollectionMetrics": { + "target": "com.amazonaws.dynamodb#ReturnItemCollectionMetrics", + "traits": { + "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to SIZE,\n the response includes statistics about item collections, if any, that were modified\n during the operation are returned in the response. If set to NONE (the\n default), no statistics are returned.

" + } + }, + "ConditionExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", + "traits": { + "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional DeleteItem\n to succeed.

\n

An expression can contain any of the following:

\n \n

For more information about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.

\n \n

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "traits": { + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as\n follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},\n \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "

An optional parameter that returns the item attributes for a DeleteItem\n operation that failed a condition check.

\n

There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

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

Represents the input of a DeleteItem operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DeleteItemOutput": { + "type": "structure", + "members": { + "Attributes": { + "target": "com.amazonaws.dynamodb#AttributeMap", + "traits": { + "smithy.api#documentation": "

A map of attribute names to AttributeValue objects, representing the item\n as it appeared before the DeleteItem operation. This map appears in the\n response only if ReturnValues was specified as ALL_OLD in the\n request.

" + } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacity", + "traits": { + "smithy.api#documentation": "

The capacity units consumed by the DeleteItem operation. The data\n returned includes the total provisioned throughput consumed, along with statistics for\n the table and any indexes involved in the operation. ConsumedCapacity is\n only returned if the ReturnConsumedCapacity parameter was specified. For\n more information, see Provisioned capacity mode in the Amazon DynamoDB Developer\n Guide.

\n

If the table has vector indexes, the response includes a\n VectorIndexes field with VectorWriteRequestBytes consumed\n for each affected vector index.

" + } + }, + "ItemCollectionMetrics": { + "target": "com.amazonaws.dynamodb#ItemCollectionMetrics", + "traits": { + "smithy.api#documentation": "

Information about item collections, if any, that were affected by the\n DeleteItem operation. ItemCollectionMetrics is only\n returned if the ReturnItemCollectionMetrics parameter was specified. If the\n table does not have any local secondary indexes, this information is not returned in the\n response.

\n

Each ItemCollectionMetrics element consists of:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a DeleteItem operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DeleteReplicaAction": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

The Region of the replica to be removed.

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

Represents a replica to be removed.

" + } + }, + "com.amazonaws.dynamodb#DeleteReplicationGroupMemberAction": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

The Region where the replica exists.

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

Represents a replica to be deleted.

" + } + }, + "com.amazonaws.dynamodb#DeleteRequest": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

A map of attribute name to attribute values, representing the primary key of the item\n to delete. All of the table's primary key attributes must be specified, and their data\n types must match those of the table's key schema.

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

Represents a request to perform a DeleteItem operation on an item.

" + } + }, + "com.amazonaws.dynamodb#DeleteResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DeleteResourcePolicyInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DeleteResourcePolicyOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#PolicyNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Deletes the resource-based policy attached to the resource, which can be a table or\n stream.

\n

\n DeleteResourcePolicy is an idempotent operation; running it multiple\n times on the same resource doesn't result in an error response,\n unless you specify an ExpectedRevisionId, which will then return a\n PolicyNotFoundException.

\n \n

To make sure that you don't inadvertently lock yourself out of your own resources,\n the root principal in your Amazon Web Services account can perform\n DeleteResourcePolicy requests, even if your resource-based policy\n explicitly denies the root principal's access.

\n \n \n

\n DeleteResourcePolicy is an asynchronous operation. If you issue a\n GetResourcePolicy request immediately after running the\n DeleteResourcePolicy request, DynamoDB might still return\n the deleted policy. This is because the policy for your resource might not have been\n deleted yet. Wait for a few seconds, and then try the GetResourcePolicy\n request again.

\n " + } + }, + "com.amazonaws.dynamodb#DeleteResourcePolicyInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.dynamodb#ResourceArnString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the DynamoDB resource from which the policy will be\n removed. The resources you can specify include tables and streams. If you remove the\n policy of a table, it will also remove the permissions for the table's indexes defined\n in that policy document. This is because index permissions are defined in the table's\n policy.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "ExpectedRevisionId": { + "target": "com.amazonaws.dynamodb#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "

A string value that you can use to conditionally delete your policy. When you provide\n an expected revision ID, if the revision ID of the existing policy on the resource\n doesn't match or if there's no policy attached to the resource, the request will fail\n and return a PolicyNotFoundException.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DeleteResourcePolicyOutput": { + "type": "structure", + "members": { + "RevisionId": { + "target": "com.amazonaws.dynamodb#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "

A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.

\n

This value will be empty if you make a request against a resource without a\n policy.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DeleteTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DeleteTableInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DeleteTableOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

The DeleteTable operation deletes a table and all of its items. After a\n DeleteTable request, the specified table is in the\n DELETING state until DynamoDB completes the deletion. If the table is\n in the ACTIVE state, you can delete it. If a table is in\n CREATING or UPDATING states, then DynamoDB returns a\n ResourceInUseException. If the specified table does not exist, DynamoDB\n returns a ResourceNotFoundException. If table is already in the\n DELETING state, no error is returned.

\n \n

DynamoDB might continue to accept data read and write operations, such as\n GetItem and PutItem, on a table in the\n DELETING state until the table deletion is complete. For the full\n list of table states, see TableStatus.

\n \n

When you delete a table, any indexes on that table are also deleted.

\n

If you have DynamoDB Streams enabled on the table, then the corresponding stream on\n that table goes into the DISABLED state, and the stream is automatically\n deleted after 24 hours.

\n

Use the DescribeTable action to check the status of the table.

", + "smithy.api#examples": [ + { + "title": "To delete a table", + "documentation": "This example deletes the Music table.", + "input": { + "TableName": "Music" + }, + "output": { + "TableDescription": { + "TableStatus": "DELETING", + "TableSizeBytes": 0, + "ItemCount": 0, + "TableName": "Music", + "ProvisionedThroughput": { + "NumberOfDecreasesToday": 1, + "WriteCapacityUnits": 5, + "ReadCapacityUnits": 5 + } + } + } + } + ] + } + }, + "com.amazonaws.dynamodb#DeleteTableInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table to delete. You can also provide the Amazon Resource Name (ARN) of the table in\n this parameter.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DeleteTable operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DeleteTableOutput": { + "type": "structure", + "members": { + "TableDescription": { + "target": "com.amazonaws.dynamodb#TableDescription", + "traits": { + "smithy.api#documentation": "

Represents the properties of a table.

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

Represents the output of a DeleteTable operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DeleteVectorIndexAction": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the vector index to delete.

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

A vector index to be removed from a table.

" + } + }, + "com.amazonaws.dynamodb#DeletionProtectionEnabled": { + "type": "boolean" + }, + "com.amazonaws.dynamodb#DescribeBackup": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeBackupInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeBackupOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#BackupNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Describes an existing backup of a table.

\n

You can call DescribeBackup at a maximum rate of 10 times per\n second.

" + } + }, + "com.amazonaws.dynamodb#DescribeBackupInput": { + "type": "structure", + "members": { + "BackupArn": { + "target": "com.amazonaws.dynamodb#BackupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the backup.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DescribeBackupOutput": { + "type": "structure", + "members": { + "BackupDescription": { + "target": "com.amazonaws.dynamodb#BackupDescription", + "traits": { + "smithy.api#documentation": "

Contains the description of the backup created for the table.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DescribeContinuousBackups": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeContinuousBackupsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeContinuousBackupsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#TableNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Checks the status of continuous backups and point in time recovery on the specified\n table. Continuous backups are ENABLED on all tables at table creation. If\n point in time recovery is enabled, PointInTimeRecoveryStatus will be set to\n ENABLED.

\n

After continuous backups and point in time recovery are enabled, you can restore to\n any point in time within EarliestRestorableDateTime and\n LatestRestorableDateTime.

\n

\n LatestRestorableDateTime is typically 5 minutes before the current time.\n You can restore your table to any point in time in the last 35 days. You can set the\n recovery period to any value between 1 and 35 days.

\n

You can call DescribeContinuousBackups at a maximum rate of 10 times per\n second.

" + } + }, + "com.amazonaws.dynamodb#DescribeContinuousBackupsInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

Name of the table for which the customer wants to check the continuous backups and\n point in time recovery settings.

\n

You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DescribeContinuousBackupsOutput": { + "type": "structure", + "members": { + "ContinuousBackupsDescription": { + "target": "com.amazonaws.dynamodb#ContinuousBackupsDescription", + "traits": { + "smithy.api#documentation": "

Represents the continuous backups and point in time recovery settings on the\n table.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DescribeContributorInsights": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeContributorInsightsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeContributorInsightsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about contributor insights for a given table or global secondary\n index.

", + "smithy.waiters#waitable": { + "ContributorInsightsEnabled": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ContributorInsightsStatus", + "expected": "ENABLED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ContributorInsightsStatus", + "expected": "FAILED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 20 + } + } + } + }, + "com.amazonaws.dynamodb#DescribeContributorInsightsInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in\n this parameter.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index to describe, if applicable.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DescribeContributorInsightsOutput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table being described.

" + } + }, + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index being described.

" + } + }, + "ContributorInsightsRuleList": { + "target": "com.amazonaws.dynamodb#ContributorInsightsRuleList", + "traits": { + "smithy.api#documentation": "

List of names of the associated contributor insights rules.

" + } + }, + "ContributorInsightsStatus": { + "target": "com.amazonaws.dynamodb#ContributorInsightsStatus", + "traits": { + "smithy.api#documentation": "

Current status of contributor insights.

" + } + }, + "LastUpdateDateTime": { + "target": "com.amazonaws.dynamodb#LastUpdateDateTime", + "traits": { + "smithy.api#documentation": "

Timestamp of the last time the status was changed.

" + } + }, + "FailureException": { + "target": "com.amazonaws.dynamodb#FailureException", + "traits": { + "smithy.api#documentation": "

Returns information about the last failure that was encountered.

\n

The most common exceptions for a FAILED status are:

\n " + } + }, + "ContributorInsightsMode": { + "target": "com.amazonaws.dynamodb#ContributorInsightsMode", + "traits": { + "smithy.api#documentation": "

The mode of CloudWatch Contributor Insights for DynamoDB that determines\n which events are emitted. Can be set to track all access and throttled events or throttled\n events only.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DescribeEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeEndpointsResponse" + }, + "traits": { + "smithy.api#documentation": "

Returns the regional endpoint information. For more information on policy permissions,\n please see Internetwork traffic privacy.

" + } + }, + "com.amazonaws.dynamodb#DescribeEndpointsRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DescribeEndpointsResponse": { + "type": "structure", + "members": { + "Endpoints": { + "target": "com.amazonaws.dynamodb#Endpoints", + "traits": { + "smithy.api#documentation": "

List of endpoints.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DescribeExport": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeExportInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeExportOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#ExportNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes an existing table export.

", + "smithy.waiters#waitable": { + "ExportCompleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ExportDescription.ExportStatus", + "expected": "COMPLETED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ExportDescription.ExportStatus", + "expected": "FAILED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 20 + } + } + } + }, + "com.amazonaws.dynamodb#DescribeExportInput": { + "type": "structure", + "members": { + "ExportArn": { + "target": "com.amazonaws.dynamodb#ExportArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the export.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DescribeExportOutput": { + "type": "structure", + "members": { + "ExportDescription": { + "target": "com.amazonaws.dynamodb#ExportDescription", + "traits": { + "smithy.api#documentation": "

Represents the properties of the export.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DescribeGlobalTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeGlobalTableInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeGlobalTableOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#GlobalTableNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Returns information about the specified global table.

\n \n

This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

\n

To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

\n " + } + }, + "com.amazonaws.dynamodb#DescribeGlobalTableInput": { + "type": "structure", + "members": { + "GlobalTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the global table.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DescribeGlobalTableOutput": { + "type": "structure", + "members": { + "GlobalTableDescription": { + "target": "com.amazonaws.dynamodb#GlobalTableDescription", + "traits": { + "smithy.api#documentation": "

Contains the details of the global table.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DescribeGlobalTableSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeGlobalTableSettingsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeGlobalTableSettingsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#GlobalTableNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Describes Region-specific settings for a global table.

\n \n

This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

\n

To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

\n " + } + }, + "com.amazonaws.dynamodb#DescribeGlobalTableSettingsInput": { + "type": "structure", + "members": { + "GlobalTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the global table to describe.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DescribeGlobalTableSettingsOutput": { + "type": "structure", + "members": { + "GlobalTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the global table.

" + } + }, + "ReplicaSettings": { + "target": "com.amazonaws.dynamodb#ReplicaSettingsDescriptionList", + "traits": { + "smithy.api#documentation": "

The Region-specific settings for the global table.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DescribeImport": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeImportInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeImportOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#ImportNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Represents the properties of the import.

", + "smithy.waiters#waitable": { + "ImportCompleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ImportTableDescription.ImportStatus", + "expected": "COMPLETED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ImportTableDescription.ImportStatus", + "expected": "FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ImportTableDescription.ImportStatus", + "expected": "CANCELLED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 20 + } + } + } + }, + "com.amazonaws.dynamodb#DescribeImportInput": { + "type": "structure", + "members": { + "ImportArn": { + "target": "com.amazonaws.dynamodb#ImportArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the table you're importing to.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DescribeImportOutput": { + "type": "structure", + "members": { + "ImportTableDescription": { + "target": "com.amazonaws.dynamodb#ImportTableDescription", + "traits": { + "smithy.api#documentation": "

Represents the properties of the table created for the import, and parameters of the\n import. The import parameters include import status, how many items were processed, and\n how many errors were encountered.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DescribeKinesisStreamingDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeKinesisStreamingDestinationInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeKinesisStreamingDestinationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Returns information about the status of Kinesis streaming.

", + "smithy.waiters#waitable": { + "KinesisStreamingDestinationActive": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "KinesisDataStreamDestinations[].DestinationStatus", + "expected": "ACTIVE", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "length(KinesisDataStreamDestinations) > `0` && length(KinesisDataStreamDestinations[?DestinationStatus == 'DISABLED' || DestinationStatus == 'ENABLE_FAILED']) == length(KinesisDataStreamDestinations)", + "expected": "true", + "comparator": "booleanEquals" + } + } + } + ], + "minDelay": 20 + } + } + } + }, + "com.amazonaws.dynamodb#DescribeKinesisStreamingDestinationInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table being described. You can also provide the Amazon Resource Name (ARN) of the table\n in this parameter.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DescribeKinesisStreamingDestinationOutput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table being described.

" + } + }, + "KinesisDataStreamDestinations": { + "target": "com.amazonaws.dynamodb#KinesisDataStreamDestinations", + "traits": { + "smithy.api#documentation": "

The list of replica structures for the table being described.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DescribeLimits": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeLimitsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeLimitsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Returns the current provisioned-capacity quotas for your Amazon Web Services account in\n a Region, both for the Region as a whole and for any one DynamoDB table that you create\n there.

\n

When you establish an Amazon Web Services account, the account has initial quotas on\n the maximum read capacity units and write capacity units that you can provision across\n all of your DynamoDB tables in a given Region. Also, there are per-table\n quotas that apply when you create a table there. For more information, see Service,\n Account, and Table Quotas page in the Amazon DynamoDB\n Developer Guide.

\n

Although you can increase these quotas by filing a case at Amazon Web Services Support Center, obtaining the\n increase is not instantaneous. The DescribeLimits action lets you write\n code to compare the capacity you are currently using to those quotas imposed by your\n account so that you have enough time to apply for an increase before you hit a\n quota.

\n

For example, you could use one of the Amazon Web Services SDKs to do the\n following:

\n
    \n
  1. \n

    Call DescribeLimits for a particular Region to obtain your\n current account quotas on provisioned capacity there.

    \n
    2. \n
  2. \n

    Create a variable to hold the aggregate read capacity units provisioned for\n all your tables in that Region, and one to hold the aggregate write capacity\n units. Zero them both.

    \n
    3. \n
  3. \n

    Call ListTables to obtain a list of all your DynamoDB\n tables.

    \n
    4. \n
  4. \n

    For each table name listed by ListTables, do the\n following:

    \n
      \n
    • \n

      Call DescribeTable with the table name.

      \n
      • \n
    • \n

      Use the data returned by DescribeTable to add the read\n capacity units and write capacity units provisioned for the table itself\n to your variables.

      \n
      • \n
    • \n

      If the table has one or more global secondary indexes (GSIs), loop\n over these GSIs and add their provisioned capacity values to your\n variables as well.

      \n
      • \n
    \n
    5. \n
  5. \n

    Report the account quotas for that Region returned by\n DescribeLimits, along with the total current provisioned\n capacity levels you have calculated.

    \n
    6. \n
\n

This will let you see whether you are getting close to your account-level\n quotas.

\n

The per-table quotas apply only when you are creating a new table. They restrict the\n sum of the provisioned capacity of the new table itself and all its global secondary\n indexes.

\n

For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned\n capacity extremely rapidly, but the only quota that applies is that the aggregate\n provisioned capacity over all your tables and GSIs cannot exceed either of the\n per-account quotas.

\n \n

\n DescribeLimits should only be called periodically. You can expect\n throttling errors if you call it more than once in a minute.

\n \n

The DescribeLimits Request element has no content.

", + "smithy.api#examples": [ + { + "title": "To determine capacity limits per table and account, in the current AWS region", + "documentation": "The following example returns the maximum read and write capacity units per table, and for the AWS account, in the current AWS region.", + "output": { + "TableMaxWriteCapacityUnits": 10000, + "TableMaxReadCapacityUnits": 10000, + "AccountMaxReadCapacityUnits": 20000, + "AccountMaxWriteCapacityUnits": 20000 + } + } + ] + } + }, + "com.amazonaws.dynamodb#DescribeLimitsInput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Represents the input of a DescribeLimits operation. Has no\n content.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DescribeLimitsOutput": { + "type": "structure", + "members": { + "AccountMaxReadCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum total read capacity units that your account allows you to provision across\n all of your tables in this Region.

" + } + }, + "AccountMaxWriteCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum total write capacity units that your account allows you to provision\n across all of your tables in this Region.

" + } + }, + "TableMaxReadCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum read capacity units that your account allows you to provision for a new\n table that you are creating in this Region, including the read capacity units\n provisioned for its global secondary indexes (GSIs).

" + } + }, + "TableMaxWriteCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum write capacity units that your account allows you to provision for a new\n table that you are creating in this Region, including the write capacity units\n provisioned for its global secondary indexes (GSIs).

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

Represents the output of a DescribeLimits operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DescribeTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeTableInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeTableOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Returns information about the table, including the current status of the table, when\n it was created, the primary key schema, and any indexes on the table.

\n \n

If you issue a DescribeTable request immediately after a\n CreateTable request, DynamoDB might return a\n ResourceNotFoundException. This is because\n DescribeTable uses an eventually consistent query, and the metadata\n for your table might not be available at that moment. Wait for a few seconds, and\n then try the DescribeTable request again.

\n ", + "smithy.waiters#waitable": { + "TableExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Table.TableStatus", + "expected": "ACTIVE", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "errorType": "ResourceNotFoundException" + } + } + ], + "minDelay": 20 + }, + "TableNotExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "errorType": "ResourceNotFoundException" + } + } + ], + "minDelay": 20 + } + } + } + }, + "com.amazonaws.dynamodb#DescribeTableInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in\n this parameter.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the input of a DescribeTable operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DescribeTableOutput": { + "type": "structure", + "members": { + "Table": { + "target": "com.amazonaws.dynamodb#TableDescription", + "traits": { + "smithy.api#documentation": "

The properties of the table.

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

Represents the output of a DescribeTable operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DescribeTableReplicaAutoScaling": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeTableReplicaAutoScalingInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeTableReplicaAutoScalingOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes auto scaling settings across replicas of the global table at once.

" + } + }, + "com.amazonaws.dynamodb#DescribeTableReplicaAutoScalingInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this\n parameter.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DescribeTableReplicaAutoScalingOutput": { + "type": "structure", + "members": { + "TableAutoScalingDescription": { + "target": "com.amazonaws.dynamodb#TableAutoScalingDescription", + "traits": { + "smithy.api#documentation": "

Represents the auto scaling properties of the table.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DescribeTimeToLive": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeTimeToLiveInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeTimeToLiveOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Gives a description of the Time to Live (TTL) status on the specified table.

" + } + }, + "com.amazonaws.dynamodb#DescribeTimeToLiveInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table to be described. You can also provide the Amazon Resource Name (ARN) of the table\n in this parameter.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#DescribeTimeToLiveOutput": { + "type": "structure", + "members": { + "TimeToLiveDescription": { + "target": "com.amazonaws.dynamodb#TimeToLiveDescription", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#DestinationStatus": { + "type": "enum", + "members": { + "ENABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DISABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLING" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "ENABLE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLE_FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } + } + }, + "com.amazonaws.dynamodb#DisableKinesisStreamingDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#KinesisStreamingDestinationInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#KinesisStreamingDestinationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Stops replication from the DynamoDB table to the Kinesis data stream. This\n is done without deleting either of the resources.

" + } + }, + "com.amazonaws.dynamodb#DoubleObject": { + "type": "double" + }, + "com.amazonaws.dynamodb#DuplicateItemException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

There was an attempt to insert an item with the same primary key as an item that\n already exists in the DynamoDB table.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#DynamoDB_20120810": { + "type": "service", + "version": "2012-08-10", + "operations": [ + { + "target": "com.amazonaws.dynamodb#BatchExecuteStatement" + }, + { + "target": "com.amazonaws.dynamodb#BatchGetItem" + }, + { + "target": "com.amazonaws.dynamodb#BatchWriteItem" + }, + { + "target": "com.amazonaws.dynamodb#CreateBackup" + }, + { + "target": "com.amazonaws.dynamodb#CreateGlobalTable" + }, + { + "target": "com.amazonaws.dynamodb#CreateTable" + }, + { + "target": "com.amazonaws.dynamodb#DeleteBackup" + }, + { + "target": "com.amazonaws.dynamodb#DeleteItem" + }, + { + "target": "com.amazonaws.dynamodb#DeleteResourcePolicy" + }, + { + "target": "com.amazonaws.dynamodb#DeleteTable" + }, + { + "target": "com.amazonaws.dynamodb#DescribeBackup" + }, + { + "target": "com.amazonaws.dynamodb#DescribeContinuousBackups" + }, + { + "target": "com.amazonaws.dynamodb#DescribeContributorInsights" + }, + { + "target": "com.amazonaws.dynamodb#DescribeEndpoints" + }, + { + "target": "com.amazonaws.dynamodb#DescribeExport" + }, + { + "target": "com.amazonaws.dynamodb#DescribeGlobalTable" + }, + { + "target": "com.amazonaws.dynamodb#DescribeGlobalTableSettings" + }, + { + "target": "com.amazonaws.dynamodb#DescribeImport" + }, + { + "target": "com.amazonaws.dynamodb#DescribeKinesisStreamingDestination" + }, + { + "target": "com.amazonaws.dynamodb#DescribeLimits" + }, + { + "target": "com.amazonaws.dynamodb#DescribeTable" + }, + { + "target": "com.amazonaws.dynamodb#DescribeTableReplicaAutoScaling" + }, + { + "target": "com.amazonaws.dynamodb#DescribeTimeToLive" + }, + { + "target": "com.amazonaws.dynamodb#DisableKinesisStreamingDestination" + }, + { + "target": "com.amazonaws.dynamodb#EnableKinesisStreamingDestination" + }, + { + "target": "com.amazonaws.dynamodb#ExecuteStatement" + }, + { + "target": "com.amazonaws.dynamodb#ExecuteTransaction" + }, + { + "target": "com.amazonaws.dynamodb#ExportTableToPointInTime" + }, + { + "target": "com.amazonaws.dynamodb#GetItem" + }, + { + "target": "com.amazonaws.dynamodb#GetResourcePolicy" + }, + { + "target": "com.amazonaws.dynamodb#ImportTable" + }, + { + "target": "com.amazonaws.dynamodb#ListBackups" + }, + { + "target": "com.amazonaws.dynamodb#ListContributorInsights" + }, + { + "target": "com.amazonaws.dynamodb#ListExports" + }, + { + "target": "com.amazonaws.dynamodb#ListGlobalTables" + }, + { + "target": "com.amazonaws.dynamodb#ListImports" + }, + { + "target": "com.amazonaws.dynamodb#ListTables" + }, + { + "target": "com.amazonaws.dynamodb#ListTagsOfResource" + }, + { + "target": "com.amazonaws.dynamodb#PutItem" + }, + { + "target": "com.amazonaws.dynamodb#PutResourcePolicy" + }, + { + "target": "com.amazonaws.dynamodb#Query" + }, + { + "target": "com.amazonaws.dynamodb#RestoreTableFromBackup" + }, + { + "target": "com.amazonaws.dynamodb#RestoreTableToPointInTime" + }, + { + "target": "com.amazonaws.dynamodb#Scan" + }, + { + "target": "com.amazonaws.dynamodb#SearchVectors" + }, + { + "target": "com.amazonaws.dynamodb#TagResource" + }, + { + "target": "com.amazonaws.dynamodb#TransactGetItems" + }, + { + "target": "com.amazonaws.dynamodb#TransactWriteItems" + }, + { + "target": "com.amazonaws.dynamodb#UntagResource" + }, + { + "target": "com.amazonaws.dynamodb#UpdateContinuousBackups" + }, + { + "target": "com.amazonaws.dynamodb#UpdateContributorInsights" + }, + { + "target": "com.amazonaws.dynamodb#UpdateGlobalTable" + }, + { + "target": "com.amazonaws.dynamodb#UpdateGlobalTableSettings" + }, + { + "target": "com.amazonaws.dynamodb#UpdateItem" + }, + { + "target": "com.amazonaws.dynamodb#UpdateKinesisStreamingDestination" + }, + { + "target": "com.amazonaws.dynamodb#UpdateTable" + }, + { + "target": "com.amazonaws.dynamodb#UpdateTableReplicaAutoScaling" + }, + { + "target": "com.amazonaws.dynamodb#UpdateTimeToLive" + } + ], + "traits": { + "aws.api#clientEndpointDiscovery": { + "operation": "com.amazonaws.dynamodb#DescribeEndpoints", + "error": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + "aws.api#service": { + "sdkId": "DynamoDB", + "arnNamespace": "dynamodb", + "cloudFormationName": "DynamoDB", + "cloudTrailEventSource": "dynamodb.amazonaws.com", + "endpointPrefix": "dynamodb" + }, + "aws.auth#sigv4": { + "name": "dynamodb" + }, + "aws.protocols#awsJson1_0": {}, + "smithy.api#documentation": "Amazon DynamoDB\n

Amazon DynamoDB is a fully managed NoSQL database service that provides fast\n and predictable performance with seamless scalability. DynamoDB lets you\n offload the administrative burdens of operating and scaling a distributed database, so\n that you don't have to worry about hardware provisioning, setup and configuration,\n replication, software patching, or cluster scaling.

\n

With DynamoDB, you can create database tables that can store and retrieve\n any amount of data, and serve any level of request traffic. You can scale up or scale\n down your tables' throughput capacity without downtime or performance degradation, and\n use the Amazon Web Services Management Console to monitor resource utilization and performance\n metrics.

\n

DynamoDB automatically spreads the data and traffic for your tables over\n a sufficient number of servers to handle your throughput and storage requirements, while\n maintaining consistent and fast performance. All of your data is stored on solid state\n disks (SSDs) and automatically replicated across multiple Availability Zones in an\n Amazon Web Services Region, providing built-in high availability and data\n durability.

", + "smithy.api#suppress": [ + "RuleSetAwsBuiltIn.AWS::Auth::AccountId" + ], + "smithy.api#title": "Amazon DynamoDB", + "smithy.api#xmlNamespace": { + "uri": "http://dynamodb.amazonaws.com/doc/2012-08-10/" + }, + "smithy.rules#endpointBdd": { + "version": "1.1", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "string" + }, + "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" + }, + "AccountId": { + "builtIn": "AWS::Auth::AccountId", + "required": false, + "documentation": "The AWS AccountId used for the request.", + "type": "string" + }, + "AccountIdEndpointMode": { + "builtIn": "AWS::Auth::AccountIdEndpointMode", + "required": false, + "documentation": "The AccountId Endpoint Mode.", + "type": "string" + }, + "ResourceArn": { + "required": false, + "documentation": "ResourceArn containing arn of resource", + "type": "string" + }, + "ResourceArnList": { + "required": false, + "documentation": "ResourceArnList containing list of resource arns", + "type": "stringArray" + }, + "IsSearchOperation": { + "required": false, + "documentation": "Set to true for SearchVectors to route to the Search FQDN", + "type": "boolean" + } + }, + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + }, + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "local" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "parsedEndpoint" + }, + { + "fn": "stringEquals", + "argv": [ + "dynamodb.{Region}.{PartitionResult#dualStackDnsSuffix}", + { + "fn": "getAttr", + "argv": [ + { + "ref": "parsedEndpoint" + }, + "authority" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + }, + true + ] + }, + { + "fn": "stringEquals", + "argv": [ + "search-dynamodb.{Region}.{PartitionResult#dualStackDnsSuffix}", + { + "fn": "getAttr", + "argv": [ + { + "ref": "parsedEndpoint" + }, + "authority" + ] + } + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "AccountIdEndpointMode" + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "AccountIdEndpointMode" + }, + "disabled" + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "ResourceArn" + } + ] + }, + { + "fn": "aws.parseArn", + "argv": [ + { + "ref": "ResourceArn" + } + ], + "assign": "ParsedArn_ssa_2" + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "ParsedArn_ssa_2" + }, + "region" + ] + }, + { + "ref": "Region" + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "ParsedArn_ssa_2" + }, + "service" + ] + }, + "dynamodb" + ] + }, + { + "fn": "isValidHostLabel", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "ParsedArn_ssa_2" + }, + "region" + ] + }, + false + ] + }, + { + "fn": "isValidHostLabel", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "ParsedArn_ssa_2" + }, + "accountId" + ] + }, + false + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "ResourceArnList" + } + ] + }, + { + "fn": "getAttr", + "argv": [ + { + "ref": "ResourceArnList" + }, + "[0]" + ], + "assign": "FirstArn" + }, + { + "fn": "aws.parseArn", + "argv": [ + { + "ref": "FirstArn" + } + ], + "assign": "ParsedArn_ssa_1" + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "ParsedArn_ssa_1" + }, + "region" + ] + }, + { + "ref": "Region" + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "ParsedArn_ssa_1" + }, + "service" + ] + }, + "dynamodb" + ] + }, + { + "fn": "isValidHostLabel", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "ParsedArn_ssa_1" + }, + "accountId" + ] + }, + false + ] + }, + { + "fn": "isValidHostLabel", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "ParsedArn_ssa_1" + }, + "region" + ] + }, + false + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "AccountId" + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "AccountIdEndpointMode" + }, + "required" + ] + }, + { + "fn": "isValidHostLabel", + "argv": [ + { + "ref": "AccountId" + }, + false + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "coalesce", + "argv": [ + { + "ref": "IsSearchOperation" + }, + false + ] + }, + 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": [], + "error": "Endpoint override is not supported for dual-stack endpoints. Please enable dual-stack functionality by enabling the configuration. For more details, see: https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "{Endpoint}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "Invalid Configuration: FIPS and local endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "error": "Invalid Configuration: Dualstack and local endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "http://localhost:8000", + "properties": { + "authSchemes": [ + { + "signingRegion": "us-east-1", + "name": "sigv4", + "signingName": "dynamodb" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "Invalid Configuration: AccountIdEndpointMode is required and FIPS is enabled, but FIPS account endpoints are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "https://search-dynamodb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://dynamodb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "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://search-dynamodb.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://dynamodb.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://search-dynamodb-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://dynamodb-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{ParsedArn_ssa_2#accountId}.search-ddb.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "metricValues": [ + "O" + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{ParsedArn_ssa_2#accountId}.ddb.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "metricValues": [ + "O" + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{ParsedArn_ssa_1#accountId}.search-ddb.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "metricValues": [ + "O" + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{ParsedArn_ssa_1#accountId}.ddb.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "metricValues": [ + "O" + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{AccountId}.search-ddb.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "metricValues": [ + "O" + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{AccountId}.ddb.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "metricValues": [ + "O" + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "Credentials-sourced account ID parameter is invalid", + "type": "error" + }, + { + "conditions": [], + "error": "AccountIdEndpointMode is required but no AccountID was provided or able to be loaded", + "type": "error" + }, + { + "conditions": [], + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "https://search-dynamodb.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://dynamodb.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{ParsedArn_ssa_2#accountId}.search-ddb.{Region}.{PartitionResult#dnsSuffix}", + "properties": { + "metricValues": [ + "O" + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{ParsedArn_ssa_2#accountId}.ddb.{Region}.{PartitionResult#dnsSuffix}", + "properties": { + "metricValues": [ + "O" + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{ParsedArn_ssa_1#accountId}.search-ddb.{Region}.{PartitionResult#dnsSuffix}", + "properties": { + "metricValues": [ + "O" + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{ParsedArn_ssa_1#accountId}.ddb.{Region}.{PartitionResult#dnsSuffix}", + "properties": { + "metricValues": [ + "O" + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{AccountId}.search-ddb.{Region}.{PartitionResult#dnsSuffix}", + "properties": { + "metricValues": [ + "O" + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{AccountId}.ddb.{Region}.{PartitionResult#dnsSuffix}", + "properties": { + "metricValues": [ + "O" + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "root": 2, + "nodeCount": 82, + "nodes": "/////wAAAAH/////AAAAAAAAAAYAAAADAAAAAQAAAAQF9eEjAAAAAgX14QEAAAAFAAAAAwX14QIF9eEEAAAAAQAAAE0AAAAHAAAAAgAAAD0AAAAIAAAAAwAAACIAAAAJAAAABAAAAAoF9eEjAAAABQX14QcAAAALAAAACwAAAAwAAABFAAAADAAAAA4AAAANAAAAHAX14RkAAABFAAAADQAAACEAAAAPAAAADgAAABAAAAAVAAAADwAAABEAAAAVAAAAEAAAABIAAAAVAAAAEQAAABMAAAAVAAAAEgAAABQAAAAVAAAAEwAAACAAAAAVAAAAFAAAABYAAAAcAAAAFQAAABcAAAAcAAAAFgAAABgAAAAcAAAAFwAAABkAAAAcAAAAGAAAABoAAAAcAAAAGQAAABsAAAAcAAAAGgAAAB8AAAAcAAAAGwAAAB0AAAAhAAAAHQAAAB4F9eEXAAAAHwX14SEF9eEiAAAAHwX14R8F9eEgAAAAHwX14R0F9eEeAAAAHAX14RgAAABFAAAABAAAACMF9eEjAAAABQX14QYAAAAkAAAACQAAACUF9eEcAAAACwAAACYAAAA8AAAADAAAACgAAAAnAAAAHAX14RkAAAA8AAAADQAAADsAAAApAAAADgAAACoAAAAvAAAADwAAACsAAAAvAAAAEAAAACwAAAAvAAAAEQAAAC0AAAAvAAAAEgAAAC4AAAAvAAAAEwAAADoAAAAvAAAAFAAAADAAAAA2AAAAFQAAADEAAAA2AAAAFgAAADIAAAA2AAAAFwAAADMAAAA2AAAAGAAAADQAAAA2AAAAGQAAADUAAAA2AAAAGgAAADkAAAA2AAAAGwAAADcAAAA7AAAAHQAAADgF9eEXAAAAHwX14RUF9eEWAAAAHwX14RMF9eEUAAAAHwX14REF9eESAAAAHAX14RgAAAA8AAAAHwX14RoF9eEbAAAAAwAAAEYAAAA+AAAABAAAAD8F9eEjAAAABQX14QUAAABAAAAABgAAAEEF9eEQAAAACwAAAEIAAABDAAAAHAX14QgAAABDAAAAHgAAAEUAAABEAAAAHwX14Q4F9eEPAAAAHwX14QwF9eENAAAABAAAAEcF9eEjAAAABQX14QUAAABIAAAABgAAAEkF9eELAAAACQAAAEoF9eELAAAACwAAAEsAAABMAAAAHAX14QgAAABMAAAAHwX14QkF9eEKAAAAAgX14QEAAABOAAAAAwX14QIAAABPAAAABAAAAFAF9eEEAAAABwAAAFEF9eEEAAAACAX14QMAAABSAAAACgX14QMF9eEE" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "string" + }, + "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" + }, + "AccountId": { + "builtIn": "AWS::Auth::AccountId", + "required": false, + "documentation": "The AWS AccountId used for the request.", + "type": "string" + }, + "AccountIdEndpointMode": { + "builtIn": "AWS::Auth::AccountIdEndpointMode", + "required": false, + "documentation": "The AccountId Endpoint Mode.", + "type": "string" + }, + "ResourceArn": { + "required": false, + "documentation": "ResourceArn containing arn of resource", + "type": "string" + }, + "ResourceArnList": { + "required": false, + "documentation": "ResourceArnList containing list of resource arns", + "type": "stringArray" + }, + "IsSearchOperation": { + "required": false, + "documentation": "Set to true for SearchVectors to route to the Search FQDN", + "type": "boolean" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + }, + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "parsedEndpoint" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "parsedEndpoint" + }, + "authority" + ] + }, + "dynamodb.{Region}.{PartitionResult#dualStackDnsSuffix}" + ] + } + ], + "error": "Endpoint override is not supported for dual-stack endpoints. Please enable dual-stack functionality by enabling the configuration. For more details, see: https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html", + "type": "error" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "parsedEndpoint" + }, + "authority" + ] + }, + "search-dynamodb.{Region}.{PartitionResult#dualStackDnsSuffix}" + ] + } + ], + "error": "Endpoint override is not supported for dual-stack endpoints. Please enable dual-stack functionality by enabling the configuration. For more details, see: https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "{Endpoint}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "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": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "{Endpoint}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "local" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and local endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and local endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "http://localhost:8000", + "properties": { + "authSchemes": [ + { + "signingRegion": "us-east-1", + "name": "sigv4", + "signingName": "dynamodb" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "AccountIdEndpointMode" + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "AccountIdEndpointMode" + }, + "required" + ] + } + ], + "rules": [ + { + "conditions": [], + "error": "Invalid Configuration: AccountIdEndpointMode is required and FIPS is enabled, but FIPS account endpoints are not supported", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "IsSearchOperation" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "IsSearchOperation" + }, + true + ] + } + ], + "endpoint": { + "url": "https://search-dynamodb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://dynamodb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "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 + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "AccountIdEndpointMode" + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "AccountIdEndpointMode" + }, + "required" + ] + } + ], + "rules": [ + { + "conditions": [], + "error": "Invalid Configuration: AccountIdEndpointMode is required and FIPS is enabled, but FIPS account endpoints are not supported", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "IsSearchOperation" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "IsSearchOperation" + }, + true + ] + } + ], + "endpoint": { + "url": "https://search-dynamodb.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://dynamodb.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "AccountIdEndpointMode" + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "AccountIdEndpointMode" + }, + "required" + ] + } + ], + "rules": [ + { + "conditions": [], + "error": "Invalid Configuration: AccountIdEndpointMode is required and FIPS is enabled, but FIPS account endpoints are not supported", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "IsSearchOperation" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "IsSearchOperation" + }, + true + ] + } + ], + "endpoint": { + "url": "https://search-dynamodb-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://dynamodb-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "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": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "AccountIdEndpointMode" + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "AccountIdEndpointMode" + }, + "disabled" + ] + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "ResourceArn" + } + ] + }, + { + "fn": "aws.parseArn", + "argv": [ + { + "ref": "ResourceArn" + } + ], + "assign": "ParsedArn" + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "ParsedArn" + }, + "service" + ] + }, + "dynamodb" + ] + }, + { + "fn": "isValidHostLabel", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "ParsedArn" + }, + "region" + ] + }, + false + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "ParsedArn" + }, + "region" + ] + }, + "{Region}" + ] + }, + { + "fn": "isValidHostLabel", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "ParsedArn" + }, + "accountId" + ] + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "IsSearchOperation" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "IsSearchOperation" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{ParsedArn#accountId}.search-ddb.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "metricValues": [ + "O" + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{ParsedArn#accountId}.ddb.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "metricValues": [ + "O" + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "AccountIdEndpointMode" + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "AccountIdEndpointMode" + }, + "disabled" + ] + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "ResourceArnList" + } + ] + }, + { + "fn": "getAttr", + "argv": [ + { + "ref": "ResourceArnList" + }, + "[0]" + ], + "assign": "FirstArn" + }, + { + "fn": "aws.parseArn", + "argv": [ + { + "ref": "FirstArn" + } + ], + "assign": "ParsedArn" + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "ParsedArn" + }, + "service" + ] + }, + "dynamodb" + ] + }, + { + "fn": "isValidHostLabel", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "ParsedArn" + }, + "region" + ] + }, + false + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "ParsedArn" + }, + "region" + ] + }, + "{Region}" + ] + }, + { + "fn": "isValidHostLabel", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "ParsedArn" + }, + "accountId" + ] + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "IsSearchOperation" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "IsSearchOperation" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{ParsedArn#accountId}.search-ddb.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "metricValues": [ + "O" + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{ParsedArn#accountId}.ddb.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "metricValues": [ + "O" + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "AccountIdEndpointMode" + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "AccountIdEndpointMode" + }, + "disabled" + ] + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "AccountId" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isValidHostLabel", + "argv": [ + { + "ref": "AccountId" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "IsSearchOperation" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "IsSearchOperation" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{AccountId}.search-ddb.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "metricValues": [ + "O" + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{AccountId}.ddb.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "metricValues": [ + "O" + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Credentials-sourced account ID parameter is invalid", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "AccountIdEndpointMode" + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "AccountIdEndpointMode" + }, + "required" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "not", + "argv": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + } + ], + "rules": [ + { + "conditions": [], + "error": "AccountIdEndpointMode is required but no AccountID was provided or able to be loaded", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: AccountIdEndpointMode is required and FIPS is enabled, but FIPS account endpoints are not supported", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "IsSearchOperation" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "IsSearchOperation" + }, + true + ] + } + ], + "endpoint": { + "url": "https://search-dynamodb.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://dynamodb.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "AccountIdEndpointMode" + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "AccountIdEndpointMode" + }, + "disabled" + ] + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "ResourceArn" + } + ] + }, + { + "fn": "aws.parseArn", + "argv": [ + { + "ref": "ResourceArn" + } + ], + "assign": "ParsedArn" + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "ParsedArn" + }, + "service" + ] + }, + "dynamodb" + ] + }, + { + "fn": "isValidHostLabel", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "ParsedArn" + }, + "region" + ] + }, + false + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "ParsedArn" + }, + "region" + ] + }, + "{Region}" + ] + }, + { + "fn": "isValidHostLabel", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "ParsedArn" + }, + "accountId" + ] + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "IsSearchOperation" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "IsSearchOperation" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{ParsedArn#accountId}.search-ddb.{Region}.{PartitionResult#dnsSuffix}", + "properties": { + "metricValues": [ + "O" + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{ParsedArn#accountId}.ddb.{Region}.{PartitionResult#dnsSuffix}", + "properties": { + "metricValues": [ + "O" + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "AccountIdEndpointMode" + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "AccountIdEndpointMode" + }, + "disabled" + ] + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "ResourceArnList" + } + ] + }, + { + "fn": "getAttr", + "argv": [ + { + "ref": "ResourceArnList" + }, + "[0]" + ], + "assign": "FirstArn" + }, + { + "fn": "aws.parseArn", + "argv": [ + { + "ref": "FirstArn" + } + ], + "assign": "ParsedArn" + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "ParsedArn" + }, + "service" + ] + }, + "dynamodb" + ] + }, + { + "fn": "isValidHostLabel", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "ParsedArn" + }, + "region" + ] + }, + false + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "ParsedArn" + }, + "region" + ] + }, + "{Region}" + ] + }, + { + "fn": "isValidHostLabel", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "ParsedArn" + }, + "accountId" + ] + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "IsSearchOperation" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "IsSearchOperation" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{ParsedArn#accountId}.search-ddb.{Region}.{PartitionResult#dnsSuffix}", + "properties": { + "metricValues": [ + "O" + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{ParsedArn#accountId}.ddb.{Region}.{PartitionResult#dnsSuffix}", + "properties": { + "metricValues": [ + "O" + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "AccountIdEndpointMode" + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "AccountIdEndpointMode" + }, + "disabled" + ] + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "AccountId" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isValidHostLabel", + "argv": [ + { + "ref": "AccountId" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "IsSearchOperation" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "IsSearchOperation" + }, + true + ] + } + ], + "endpoint": { + "url": "https://{AccountId}.search-ddb.{Region}.{PartitionResult#dnsSuffix}", + "properties": { + "metricValues": [ + "O" + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://{AccountId}.ddb.{Region}.{PartitionResult#dnsSuffix}", + "properties": { + "metricValues": [ + "O" + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Credentials-sourced account ID parameter is invalid", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "AccountIdEndpointMode" + } + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "ref": "AccountIdEndpointMode" + }, + "required" + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "not", + "argv": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + } + ], + "rules": [ + { + "conditions": [], + "error": "AccountIdEndpointMode is required but no AccountID was provided or able to be loaded", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: AccountIdEndpointMode is required and FIPS is enabled, but FIPS account endpoints are not supported", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "IsSearchOperation" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "IsSearchOperation" + }, + true + ] + } + ], + "endpoint": { + "url": "https://search-dynamodb.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://dynamodb.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region local with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "Region": "local", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-west-2:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-west-2:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, ResourceArnList=[arn:aws:s3:us-east-1:333333333333:stream/testStream], AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "ResourceArnList": [ + "arn:aws:s3:us-east-1:333333333333:stream/testStream" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=, AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:s3:us-west-2:222222222222:stream/testStream" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=, AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-west-2:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-west-2:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, ResourceArnList=[arn:aws:s3:us-east-1:333333333333:stream/testStream], AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "ResourceArnList": [ + "arn:aws:s3:us-east-1:333333333333:stream/testStream" + ], + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=, AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:s3:us-west-2:222222222222:stream/testStream" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=, AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-west-2:333333333333:table/table_name], AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-west-2:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, ResourceArnList=[arn:aws:s3:us-east-1:333333333333:stream/testStream], AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "ResourceArnList": [ + "arn:aws:s3:us-east-1:333333333333:stream/testStream" + ], + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=, AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:s3:us-west-2:222222222222:stream/testStream" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=, AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=local}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=local}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=local}", + "expect": { + "error": "Invalid Configuration: Dualstack and local endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-west-2:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-west-2:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, ResourceArnList=[arn:aws:s3:us-east-1:333333333333:stream/testStream], AccountIdEndpointMode=preferred, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "ResourceArnList": [ + "arn:aws:s3:us-east-1:333333333333:stream/testStream" + ], + "AccountIdEndpointMode": "preferred", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=, AccountIdEndpointMode=preferred, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "", + "AccountIdEndpointMode": "preferred", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=local}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=local}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=local}", + "expect": { + "error": "Invalid Configuration: Dualstack and local endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, AccountIdEndpointMode=preferred, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:s3:us-west-2:222222222222:stream/testStream" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "AccountIdEndpointMode": "preferred", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=, AccountIdEndpointMode=preferred, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "", + "AccountIdEndpointMode": "preferred", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=local}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=local}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=local}", + "expect": { + "error": "Invalid Configuration: Dualstack and local endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountIdEndpointMode=preferred, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "preferred", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=disabled, Region=local}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "disabled", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=disabled, Region=local}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "disabled", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=disabled, Region=local}", + "expect": { + "error": "Invalid Configuration: Dualstack and local endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "disabled", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=disabled, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "disabled", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-west-2:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-west-2:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, ResourceArnList=[arn:aws:s3:us-east-1:333333333333:stream/testStream], AccountIdEndpointMode=disabled, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "ResourceArnList": [ + "arn:aws:s3:us-east-1:333333333333:stream/testStream" + ], + "AccountIdEndpointMode": "disabled", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=, AccountIdEndpointMode=disabled, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "", + "AccountIdEndpointMode": "disabled", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=local}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=local}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=local}", + "expect": { + "error": "Invalid Configuration: Dualstack and local endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, AccountIdEndpointMode=disabled, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:s3:us-west-2:222222222222:stream/testStream" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "AccountIdEndpointMode": "disabled", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=, AccountIdEndpointMode=disabled, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "", + "AccountIdEndpointMode": "disabled", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=local}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=local}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=local}", + "expect": { + "error": "Invalid Configuration: Dualstack and local endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountIdEndpointMode=disabled, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "disabled", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=required, Region=local}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=required, Region=local}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=required, Region=local}", + "expect": { + "error": "Invalid Configuration: Dualstack and local endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=required, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-west-2:333333333333:table/table_name], AccountIdEndpointMode=required, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-west-2:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, ResourceArnList=[arn:aws:s3:us-east-1:333333333333:stream/testStream], AccountIdEndpointMode=required, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "ResourceArnList": [ + "arn:aws:s3:us-east-1:333333333333:stream/testStream" + ], + "AccountIdEndpointMode": "required", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=, AccountIdEndpointMode=required, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "", + "AccountIdEndpointMode": "required", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=local}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=local}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=local}", + "expect": { + "error": "Invalid Configuration: Dualstack and local endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, AccountIdEndpointMode=required, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, AccountIdEndpointMode=required, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:s3:us-west-2:222222222222:stream/testStream" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "AccountIdEndpointMode": "required", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=, AccountIdEndpointMode=required, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "", + "AccountIdEndpointMode": "required", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=local}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=local}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=local}", + "expect": { + "error": "Invalid Configuration: Dualstack and local endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountIdEndpointMode=required, Region=local}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "required", + "Region": "local" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-east-1}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://111111111111.ddb.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-east-1}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://111111111111.ddb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-east-1}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://333333333333.ddb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-east-1}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://222222222222.ddb.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-east-1}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://333333333333.ddb.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-east-1}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://333333333333.ddb.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-west-2:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-east-1}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://111111111111.ddb.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-west-2:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, ResourceArnList=[arn:aws:s3:us-east-1:333333333333:stream/testStream], AccountIdEndpointMode=preferred, Region=us-east-1}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://111111111111.ddb.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "ResourceArnList": [ + "arn:aws:s3:us-east-1:333333333333:stream/testStream" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=, AccountIdEndpointMode=preferred, Region=us-east-1}", + "expect": { + "error": "Credentials-sourced account ID parameter is invalid" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-east-1}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://222222222222.ddb.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-east-1}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://222222222222.ddb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, AccountIdEndpointMode=preferred, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:s3:us-west-2:222222222222:stream/testStream" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=, AccountIdEndpointMode=preferred, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-east-1}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://333333333333.ddb.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-east-1}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://333333333333.ddb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-east-1}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://222222222222.ddb.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountIdEndpointMode=preferred, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=required, Region=us-east-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required and FIPS is enabled, but FIPS account endpoints are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=required, Region=us-east-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required and FIPS is enabled, but FIPS account endpoints are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=required, Region=us-east-1}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://111111111111.ddb.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=required, Region=us-east-1}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://111111111111.ddb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=us-east-1}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://333333333333.ddb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=us-east-1}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://222222222222.ddb.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=us-east-1}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://333333333333.ddb.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=us-east-1}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://333333333333.ddb.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-west-2:333333333333:table/table_name], AccountIdEndpointMode=required, Region=us-east-1}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://111111111111.ddb.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-west-2:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, ResourceArnList=[arn:aws:s3:us-east-1:333333333333:stream/testStream], AccountIdEndpointMode=required, Region=us-east-1}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://111111111111.ddb.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "ResourceArnList": [ + "arn:aws:s3:us-east-1:333333333333:stream/testStream" + ], + "AccountIdEndpointMode": "required", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=, AccountIdEndpointMode=required, Region=us-east-1}", + "expect": { + "error": "Credentials-sourced account ID parameter is invalid" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "", + "AccountIdEndpointMode": "required", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=us-east-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required and FIPS is enabled, but FIPS account endpoints are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=us-east-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required and FIPS is enabled, but FIPS account endpoints are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=us-east-1}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://222222222222.ddb.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=us-east-1}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://222222222222.ddb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, AccountIdEndpointMode=required, Region=us-east-1}", + "expect": { + "error": "AccountIdEndpointMode is required but no AccountID was provided or able to be loaded" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, AccountIdEndpointMode=required, Region=us-east-1}", + "expect": { + "error": "AccountIdEndpointMode is required but no AccountID was provided or able to be loaded" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:s3:us-west-2:222222222222:stream/testStream" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "AccountIdEndpointMode": "required", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=, AccountIdEndpointMode=required, Region=us-east-1}", + "expect": { + "error": "AccountIdEndpointMode is required but no AccountID was provided or able to be loaded" + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "", + "AccountIdEndpointMode": "required", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=us-east-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required and FIPS is enabled, but FIPS account endpoints are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=us-east-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required and FIPS is enabled, but FIPS account endpoints are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=us-east-1}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://333333333333.ddb.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=us-east-1}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://333333333333.ddb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=us-east-1}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://222222222222.ddb.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountIdEndpointMode=required, Region=us-east-1}", + "expect": { + "error": "AccountIdEndpointMode is required but no AccountID was provided or able to be loaded" + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "required", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=required, Region=cn-north-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required and FIPS is enabled, but FIPS account endpoints are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=required, Region=cn-north-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required and FIPS is enabled, but FIPS account endpoints are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=required, Region=cn-north-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=required, Region=cn-north-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=cn-north-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=cn-north-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=cn-north-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=cn-north-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-west-2:333333333333:table/table_name], AccountIdEndpointMode=required, Region=cn-north-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-west-2:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, ResourceArnList=[arn:aws:s3:us-east-1:333333333333:stream/testStream], AccountIdEndpointMode=required, Region=cn-north-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "ResourceArnList": [ + "arn:aws:s3:us-east-1:333333333333:stream/testStream" + ], + "AccountIdEndpointMode": "required", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=, AccountIdEndpointMode=required, Region=cn-north-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "", + "AccountIdEndpointMode": "required", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=cn-north-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required and FIPS is enabled, but FIPS account endpoints are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=cn-north-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required and FIPS is enabled, but FIPS account endpoints are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=cn-north-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=cn-north-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, AccountIdEndpointMode=required, Region=cn-north-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, AccountIdEndpointMode=required, Region=cn-north-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:s3:us-west-2:222222222222:stream/testStream" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "AccountIdEndpointMode": "required", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=, AccountIdEndpointMode=required, Region=cn-north-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "", + "AccountIdEndpointMode": "required", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=cn-north-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required and FIPS is enabled, but FIPS account endpoints are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=cn-north-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required and FIPS is enabled, but FIPS account endpoints are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=cn-north-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=cn-north-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=required, Region=cn-north-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "required", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountIdEndpointMode=required, Region=cn-north-1}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "required", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=disabled, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=disabled, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=disabled, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=disabled, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-west-2:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-west-2:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, ResourceArnList=[arn:aws:s3:us-east-1:333333333333:stream/testStream], AccountIdEndpointMode=disabled, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "ResourceArnList": [ + "arn:aws:s3:us-east-1:333333333333:stream/testStream" + ], + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=, AccountIdEndpointMode=disabled, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, AccountIdEndpointMode=disabled, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:s3:us-west-2:222222222222:stream/testStream" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=, AccountIdEndpointMode=disabled, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=disabled, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountIdEndpointMode=disabled, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=cn-north-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=cn-north-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=cn-north-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=cn-north-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=cn-north-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=cn-north-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=cn-north-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=cn-north-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-west-2:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=cn-north-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-west-2:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, ResourceArnList=[arn:aws:s3:us-east-1:333333333333:stream/testStream], AccountIdEndpointMode=preferred, Region=cn-north-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "ResourceArnList": [ + "arn:aws:s3:us-east-1:333333333333:stream/testStream" + ], + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=, AccountIdEndpointMode=preferred, Region=cn-north-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "", + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=cn-north-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=cn-north-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=cn-north-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=cn-north-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=cn-north-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, AccountIdEndpointMode=preferred, Region=cn-north-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:s3:us-west-2:222222222222:stream/testStream" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=, AccountIdEndpointMode=preferred, Region=cn-north-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "", + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=cn-north-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=cn-north-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=cn-north-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=cn-north-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=cn-north-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountIdEndpointMode=preferred, Region=cn-north-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-iso-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-iso-east-1.api.aws.ic.gov" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-iso-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-iso-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-iso-east-1.api.aws.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-iso-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-iso-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-iso-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-iso-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-iso-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-iso-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-iso-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-west-2:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-iso-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-west-2:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, ResourceArnList=[arn:aws:s3:us-east-1:333333333333:stream/testStream], AccountIdEndpointMode=preferred, Region=us-iso-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "ResourceArnList": [ + "arn:aws:s3:us-east-1:333333333333:stream/testStream" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=, AccountIdEndpointMode=preferred, Region=us-iso-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-iso-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "", + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-iso-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-iso-east-1.api.aws.ic.gov" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-iso-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-iso-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-iso-east-1.api.aws.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-iso-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-iso-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-iso-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-iso-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, AccountIdEndpointMode=preferred, Region=us-iso-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-iso-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:s3:us-west-2:222222222222:stream/testStream" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=, AccountIdEndpointMode=preferred, Region=us-iso-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "", + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-iso-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-iso-east-1.api.aws.ic.gov" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-iso-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-iso-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-iso-east-1.api.aws.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-iso-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-iso-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-iso-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountIdEndpointMode=preferred, Region=us-iso-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-gov-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-gov-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-gov-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-gov-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-gov-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-gov-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-gov-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-gov-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-gov-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-gov-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-west-2:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-gov-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-west-2:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, ResourceArnList=[arn:aws:s3:us-east-1:333333333333:stream/testStream], AccountIdEndpointMode=preferred, Region=us-gov-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "ResourceArnList": [ + "arn:aws:s3:us-east-1:333333333333:stream/testStream" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=, AccountIdEndpointMode=preferred, Region=us-gov-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-gov-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "ListTables" + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "", + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-gov-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-gov-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-gov-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-gov-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-gov-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-gov-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-gov-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, AccountIdEndpointMode=preferred, Region=us-gov-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-gov-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "DescribeTable", + "operationParams": { + "TableName": "arn:aws:s3:us-west-2:222222222222:stream/testStream" + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=, AccountIdEndpointMode=preferred, Region=us-gov-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "", + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-gov-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-gov-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-gov-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-gov-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-gov-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "BatchGetItem", + "operationParams": { + "RequestItems": { + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name": { + "Keys": [ + { + "pk": { + "S": "value" + } + } + ] + } + } + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, ResourceArnList=[arn:aws:dynamodb:us-east-1:333333333333:table/table_name], AccountIdEndpointMode=preferred, Region=us-gov-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "ResourceArnList": [ + "arn:aws:dynamodb:us-east-1:333333333333:table/table_name" + ], + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1" + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountIdEndpointMode=preferred, Region=us-gov-east-1}", + "expect": { + "endpoint": { + "url": "https://dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1" + } + }, + { + "documentation": "{Endpoint=https://dynamodb.cn-north-1.api.amazonwebservices.com.cn, Region=cn-north-1}", + "expect": { + "error": "Endpoint override is not supported for dual-stack endpoints. Please enable dual-stack functionality by enabling the configuration. For more details, see: https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html" + }, + "params": { + "Endpoint": "https://dynamodb.cn-north-1.api.amazonwebservices.com.cn", + "Region": "cn-north-1" + } + }, + { + "documentation": "{Endpoint=https://dynamodb.us-gov-east-1.api.aws, Region=us-gov-east-1}", + "expect": { + "error": "Endpoint override is not supported for dual-stack endpoints. Please enable dual-stack functionality by enabling the configuration. For more details, see: https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html" + }, + "params": { + "Endpoint": "https://dynamodb.us-gov-east-1.api.aws", + "Region": "us-gov-east-1" + } + }, + { + "documentation": "{Endpoint=https://dynamodb.us-east-1.api.aws, Region=us-east-1}", + "expect": { + "error": "Endpoint override is not supported for dual-stack endpoints. Please enable dual-stack functionality by enabling the configuration. For more details, see: https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html" + }, + "params": { + "Endpoint": "https://dynamodb.us-east-1.api.aws", + "Region": "us-east-1" + } + }, + { + "documentation": "{Endpoint=https://111111111111.ddb.us-east-1.api.aws, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://111111111111.ddb.us-east-1.api.aws" + } + }, + "params": { + "Endpoint": "https://111111111111.ddb.us-east-1.api.aws", + "Region": "us-east-1" + } + }, + { + "documentation": "{Endpoint=https://vpce-1a2b3c4d-5e6f.dynamodb.us-east-1.vpce.api.aws, Region=us-east-1}", + "expect": { + "endpoint": { + "url": "https://vpce-1a2b3c4d-5e6f.dynamodb.us-east-1.vpce.api.aws" + } + }, + "params": { + "Endpoint": "https://vpce-1a2b3c4d-5e6f.dynamodb.us-east-1.vpce.api.aws", + "Region": "us-east-1" + } + }, + { + "documentation": "{Endpoint=https://dynamodb.eu-west-1.api.aws, Region=eu-west-1}", + "expect": { + "error": "Endpoint override is not supported for dual-stack endpoints. Please enable dual-stack functionality by enabling the configuration. For more details, see: https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html" + }, + "params": { + "Endpoint": "https://dynamodb.eu-west-1.api.aws", + "Region": "eu-west-1" + } + }, + { + "documentation": "{Endpoint=https://dynamodb.us-west-2.api.aws, Region=us-west-2}", + "expect": { + "error": "Endpoint override is not supported for dual-stack endpoints. Please enable dual-stack functionality by enabling the configuration. For more details, see: https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html" + }, + "params": { + "Endpoint": "https://dynamodb.us-west-2.api.aws", + "Region": "us-west-2" + } + }, + { + "documentation": "{Endpoint=https://dynamodb.us-east-1.api.aws/, Region=us-east-1}", + "expect": { + "error": "Endpoint override is not supported for dual-stack endpoints. Please enable dual-stack functionality by enabling the configuration. For more details, see: https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html" + }, + "params": { + "Endpoint": "https://dynamodb.us-east-1.api.aws/", + "Region": "us-east-1" + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=, AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=, AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountIdEndpointMode=preferred, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=, AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=, AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountIdEndpointMode=disabled, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=, AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=, AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountIdEndpointMode=required, Region=us-east-1, Endpoint=https://example.com, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://example.com", + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "Endpoint": "https://example.com", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=local, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=local, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=local, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: Dualstack and local endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=local, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=, AccountIdEndpointMode=preferred, Region=local, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "", + "AccountIdEndpointMode": "preferred", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=local, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=local, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=local, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: Dualstack and local endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=local, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=local, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, AccountIdEndpointMode=preferred, Region=local, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "AccountIdEndpointMode": "preferred", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=, AccountIdEndpointMode=preferred, Region=local, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "", + "AccountIdEndpointMode": "preferred", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountIdEndpointMode=preferred, Region=local, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "preferred", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=disabled, Region=local, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "disabled", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=disabled, Region=local, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "disabled", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=disabled, Region=local, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: Dualstack and local endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "disabled", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=disabled, Region=local, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "disabled", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=, AccountIdEndpointMode=disabled, Region=local, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "", + "AccountIdEndpointMode": "disabled", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=local, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=local, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=local, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: Dualstack and local endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=local, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=local, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, AccountIdEndpointMode=disabled, Region=local, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "AccountIdEndpointMode": "disabled", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=, AccountIdEndpointMode=disabled, Region=local, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "", + "AccountIdEndpointMode": "disabled", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountIdEndpointMode=disabled, Region=local, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "disabled", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=required, Region=local, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=required, Region=local, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=required, Region=local, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: Dualstack and local endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=required, Region=local, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=, AccountIdEndpointMode=required, Region=local, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "", + "AccountIdEndpointMode": "required", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=local, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=local, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: FIPS and local endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=local, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: Dualstack and local endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=local, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, AccountIdEndpointMode=required, Region=local, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, AccountIdEndpointMode=required, Region=local, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "AccountIdEndpointMode": "required", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=, AccountIdEndpointMode=required, Region=local, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "", + "AccountIdEndpointMode": "required", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountIdEndpointMode=required, Region=local, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "dynamodb", + "signingRegion": "us-east-1" + } + ] + }, + "url": "http://localhost:8000" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "local", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "required", + "Region": "local", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb-fips.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb-fips.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://111111111111.search-ddb.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://111111111111.search-ddb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=, AccountIdEndpointMode=preferred, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "error": "Credentials-sourced account ID parameter is invalid" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb-fips.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb-fips.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://222222222222.search-ddb.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://222222222222.search-ddb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, AccountIdEndpointMode=preferred, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=, AccountIdEndpointMode=preferred, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "", + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountIdEndpointMode=preferred, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "preferred", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=required, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required and FIPS is enabled, but FIPS account endpoints are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=required, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required and FIPS is enabled, but FIPS account endpoints are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=required, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://111111111111.search-ddb.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=required, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://111111111111.search-ddb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=, AccountIdEndpointMode=required, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "error": "Credentials-sourced account ID parameter is invalid" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required and FIPS is enabled, but FIPS account endpoints are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required and FIPS is enabled, but FIPS account endpoints are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://222222222222.search-ddb.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "properties": { + "metricValues": [ + "O" + ] + }, + "url": "https://222222222222.search-ddb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, AccountIdEndpointMode=required, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "error": "AccountIdEndpointMode is required but no AccountID was provided or able to be loaded" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, AccountIdEndpointMode=required, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "error": "AccountIdEndpointMode is required but no AccountID was provided or able to be loaded" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=, AccountIdEndpointMode=required, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "error": "AccountIdEndpointMode is required but no AccountID was provided or able to be loaded" + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "", + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountIdEndpointMode=required, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "error": "AccountIdEndpointMode is required but no AccountID was provided or able to be loaded" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "required", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=required, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required and FIPS is enabled, but FIPS account endpoints are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=required, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required and FIPS is enabled, but FIPS account endpoints are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=required, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=required, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "required", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=, AccountIdEndpointMode=required, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "", + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "", + "AccountIdEndpointMode": "required", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required and FIPS is enabled, but FIPS account endpoints are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required and FIPS is enabled, but FIPS account endpoints are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=required, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, AccountIdEndpointMode=required, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "AccountIdEndpointMode": "required", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, AccountIdEndpointMode=required, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "AccountIdEndpointMode": "required", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=, AccountIdEndpointMode=required, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "", + "AccountIdEndpointMode": "required", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountIdEndpointMode=required, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "required" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "required", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=disabled, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb-fips.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=disabled, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb-fips.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=disabled, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=disabled, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=, AccountIdEndpointMode=disabled, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "", + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb-fips.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb-fips.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": true, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": true, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, AccountIdEndpointMode=disabled, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, AccountIdEndpointMode=disabled, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=, AccountIdEndpointMode=disabled, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "", + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountIdEndpointMode=disabled, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "disabled" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "disabled", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=, AccountIdEndpointMode=preferred, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "", + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, AccountIdEndpointMode=preferred, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=, AccountIdEndpointMode=preferred, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "", + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountIdEndpointMode=preferred, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.cn-north-1.amazonaws.com.cn" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "cn-north-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "preferred", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-iso-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb-fips.us-iso-east-1.api.aws.ic.gov" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-iso-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-iso-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-iso-east-1.api.aws.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-iso-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-iso-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=, AccountIdEndpointMode=preferred, Region=us-iso-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-iso-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "", + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-iso-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb-fips.us-iso-east-1.api.aws.ic.gov" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-iso-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-iso-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-iso-east-1.api.aws.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-iso-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-iso-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-iso-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-iso-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, AccountIdEndpointMode=preferred, Region=us-iso-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-iso-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=, AccountIdEndpointMode=preferred, Region=us-iso-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "", + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountIdEndpointMode=preferred, Region=us-iso-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-iso-east-1.c2s.ic.gov" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-iso-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "preferred", + "Region": "us-iso-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-gov-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-gov-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-gov-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=111111111111, AccountIdEndpointMode=preferred, Region=us-gov-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-gov-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "111111111111", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "111111111111", + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountId=, AccountIdEndpointMode=preferred, Region=us-gov-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-gov-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountId": "", + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountId": "", + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-gov-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=true, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-gov-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=true, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-gov-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-east-1:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-gov-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-gov-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-east-1:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:dynamodb:us-west-2:222222222222:table/table_name, AccountIdEndpointMode=preferred, Region=us-gov-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-gov-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:dynamodb:us-west-2:222222222222:table/table_name", + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=arn:aws:s3:us-west-2:222222222222:stream/testStream, AccountIdEndpointMode=preferred, Region=us-gov-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-gov-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "arn:aws:s3:us-west-2:222222222222:stream/testStream", + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, ResourceArn=, AccountIdEndpointMode=preferred, Region=us-gov-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "ResourceArn": "", + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{UseFIPS=false, UseDualStack=false, AccountIdEndpointMode=preferred, Region=us-gov-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://search-dynamodb.us-gov-east-1.amazonaws.com" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-gov-east-1", + "AWS::UseFIPS": false, + "AWS::UseDualStack": false, + "AWS::Auth::AccountIdEndpointMode": "preferred" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "UseFIPS": false, + "UseDualStack": false, + "AccountIdEndpointMode": "preferred", + "Region": "us-gov-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{Endpoint=https://dynamodb.cn-north-1.api.amazonwebservices.com.cn, Region=cn-north-1, IsSearchOperation=true}", + "expect": { + "error": "Endpoint override is not supported for dual-stack endpoints. Please enable dual-stack functionality by enabling the configuration. For more details, see: https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://dynamodb.cn-north-1.api.amazonwebservices.com.cn", + "AWS::Region": "cn-north-1" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "Endpoint": "https://dynamodb.cn-north-1.api.amazonwebservices.com.cn", + "Region": "cn-north-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{Endpoint=https://dynamodb.us-gov-east-1.api.aws, Region=us-gov-east-1, IsSearchOperation=true}", + "expect": { + "error": "Endpoint override is not supported for dual-stack endpoints. Please enable dual-stack functionality by enabling the configuration. For more details, see: https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://dynamodb.us-gov-east-1.api.aws", + "AWS::Region": "us-gov-east-1" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "Endpoint": "https://dynamodb.us-gov-east-1.api.aws", + "Region": "us-gov-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{Endpoint=https://dynamodb.us-east-1.api.aws, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "error": "Endpoint override is not supported for dual-stack endpoints. Please enable dual-stack functionality by enabling the configuration. For more details, see: https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://dynamodb.us-east-1.api.aws", + "AWS::Region": "us-east-1" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "Endpoint": "https://dynamodb.us-east-1.api.aws", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{Endpoint=https://111111111111.ddb.us-east-1.api.aws, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://111111111111.ddb.us-east-1.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://111111111111.ddb.us-east-1.api.aws", + "AWS::Region": "us-east-1" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "Endpoint": "https://111111111111.ddb.us-east-1.api.aws", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{Endpoint=https://vpce-1a2b3c4d-5e6f.dynamodb.us-east-1.vpce.api.aws, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "endpoint": { + "url": "https://vpce-1a2b3c4d-5e6f.dynamodb.us-east-1.vpce.api.aws" + } + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://vpce-1a2b3c4d-5e6f.dynamodb.us-east-1.vpce.api.aws", + "AWS::Region": "us-east-1" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "Endpoint": "https://vpce-1a2b3c4d-5e6f.dynamodb.us-east-1.vpce.api.aws", + "Region": "us-east-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{Endpoint=https://dynamodb.eu-west-1.api.aws, Region=eu-west-1, IsSearchOperation=true}", + "expect": { + "error": "Endpoint override is not supported for dual-stack endpoints. Please enable dual-stack functionality by enabling the configuration. For more details, see: https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://dynamodb.eu-west-1.api.aws", + "AWS::Region": "eu-west-1" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "Endpoint": "https://dynamodb.eu-west-1.api.aws", + "Region": "eu-west-1", + "IsSearchOperation": true + } + }, + { + "documentation": "{Endpoint=https://dynamodb.us-west-2.api.aws, Region=us-west-2, IsSearchOperation=true}", + "expect": { + "error": "Endpoint override is not supported for dual-stack endpoints. Please enable dual-stack functionality by enabling the configuration. For more details, see: https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://dynamodb.us-west-2.api.aws", + "AWS::Region": "us-west-2" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "Endpoint": "https://dynamodb.us-west-2.api.aws", + "Region": "us-west-2", + "IsSearchOperation": true + } + }, + { + "documentation": "{Endpoint=https://dynamodb.us-east-1.api.aws/, Region=us-east-1, IsSearchOperation=true}", + "expect": { + "error": "Endpoint override is not supported for dual-stack endpoints. Please enable dual-stack functionality by enabling the configuration. For more details, see: https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html" + }, + "operationInputs": [ + { + "builtInParams": { + "SDK::Endpoint": "https://dynamodb.us-east-1.api.aws/", + "AWS::Region": "us-east-1" + }, + "operationName": "SearchVectors", + "operationParams": { + "TableName": "test-table", + "IndexName": "test-index", + "SearchVector": [ + { + "N": "1.0" + }, + { + "N": "2.0" + }, + { + "N": "3.0" + } + ], + "TopK": 10 + } + } + ], + "params": { + "Endpoint": "https://dynamodb.us-east-1.api.aws/", + "Region": "us-east-1", + "IsSearchOperation": true + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.dynamodb#EnableKinesisStreamingConfiguration": { + "type": "structure", + "members": { + "ApproximateCreationDateTimePrecision": { + "target": "com.amazonaws.dynamodb#ApproximateCreationDateTimePrecision", + "traits": { + "smithy.api#documentation": "

Toggle for the precision of Kinesis data stream timestamp. The values are either\n MILLISECOND or MICROSECOND.

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

Enables setting the configuration for Kinesis Streaming.

" + } + }, + "com.amazonaws.dynamodb#EnableKinesisStreamingDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#KinesisStreamingDestinationInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#KinesisStreamingDestinationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Starts table data replication to the specified Kinesis data stream at a timestamp\n chosen during the enable workflow. If this operation doesn't return results immediately,\n use DescribeKinesisStreamingDestination to check if streaming to the Kinesis data stream\n is ACTIVE.

" + } + }, + "com.amazonaws.dynamodb#Endpoint": { + "type": "structure", + "members": { + "Address": { + "target": "com.amazonaws.dynamodb#String", + "traits": { + "smithy.api#documentation": "

IP address of the endpoint.

", + "smithy.api#required": {} + } + }, + "CachePeriodInMinutes": { + "target": "com.amazonaws.dynamodb#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Endpoint cache time to live (TTL) value.

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

An endpoint information details.

" + } + }, + "com.amazonaws.dynamodb#Endpoints": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#Endpoint" + } + }, + "com.amazonaws.dynamodb#ErrorCount": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.dynamodb#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.dynamodb#ExceptionDescription": { + "type": "string" + }, + "com.amazonaws.dynamodb#ExceptionName": { + "type": "string" + }, + "com.amazonaws.dynamodb#ExecuteStatement": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ExecuteStatementInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ExecuteStatementOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#ConditionalCheckFailedException" + }, + { + "target": "com.amazonaws.dynamodb#DuplicateItemException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#ItemCollectionSizeLimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" + }, + { + "target": "com.amazonaws.dynamodb#TransactionConflictException" + } + ], + "traits": { + "smithy.api#documentation": "

This operation allows you to perform reads and singleton writes on data stored in\n DynamoDB, using PartiQL.

\n

For PartiQL reads (SELECT statement), if the total number of processed\n items exceeds the maximum dataset size limit of 1 MB, the read stops and results are\n returned to the user as a LastEvaluatedKey value to continue the read in a\n subsequent operation. If the filter criteria in WHERE clause does not match\n any data, the read will return an empty result set.

\n

A single SELECT statement response can return up to the maximum number of\n items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any\n filtering to the results using WHERE clause). If\n LastEvaluatedKey is present in the response, you need to paginate the\n result set. If NextToken is present, you need to paginate the result set\n and include NextToken.

" + } + }, + "com.amazonaws.dynamodb#ExecuteStatementInput": { + "type": "structure", + "members": { + "Statement": { + "target": "com.amazonaws.dynamodb#PartiQLStatement", + "traits": { + "smithy.api#documentation": "

The PartiQL statement representing the operation to run.

", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.dynamodb#PreparedStatementParameters", + "traits": { + "smithy.api#documentation": "

The parameters for the PartiQL statement, if any.

" + } + }, + "ConsistentRead": { + "target": "com.amazonaws.dynamodb#ConsistentRead", + "traits": { + "smithy.api#documentation": "

The consistency of a read operation. If set to true, then a strongly\n consistent read is used; otherwise, an eventually consistent read is used.

" + } + }, + "NextToken": { + "target": "com.amazonaws.dynamodb#PartiQLNextToken", + "traits": { + "smithy.api#documentation": "

Set this value to get remaining results, if NextToken was returned in the\n statement response.

" + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + }, + "Limit": { + "target": "com.amazonaws.dynamodb#PositiveIntegerObject", + "traits": { + "smithy.api#documentation": "

The maximum number of items to evaluate (not necessarily the number of matching\n items). If DynamoDB processes the number of items up to the limit while processing the\n results, it stops the operation and returns the matching values up to that point, along\n with a key in LastEvaluatedKey to apply in a subsequent operation so you\n can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before\n DynamoDB reaches this limit, it stops the operation and returns the matching values up\n to the limit, and a key in LastEvaluatedKey to apply in a subsequent\n operation to continue the operation.

" + } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "

An optional parameter that returns the item attributes for an\n ExecuteStatement operation that failed a condition check.

\n

There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#ExecuteStatementOutput": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.dynamodb#ItemList", + "traits": { + "smithy.api#documentation": "

If a read operation was used, this property will contain the result of the read\n operation; a map of attribute names and their values. For the write operations this\n value will be empty.

" + } + }, + "NextToken": { + "target": "com.amazonaws.dynamodb#PartiQLNextToken", + "traits": { + "smithy.api#documentation": "

If the response of a read request exceeds the response payload limit DynamoDB will set\n this value in the response. If set, you can use that this value in the subsequent\n request to get the remaining results.

" + } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacity" + }, + "LastEvaluatedKey": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

The primary key of the item where the operation stopped, inclusive of the previous\n result set. Use this value to start a new operation, excluding this value in the new\n request. If LastEvaluatedKey is empty, then the \"last page\" of results has\n been processed and there is no more data to be retrieved. If\n LastEvaluatedKey is not empty, it does not necessarily mean that there\n is more data in the result set. The only way to know when you have reached the end of\n the result set is when LastEvaluatedKey is empty.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#ExecuteTransaction": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ExecuteTransactionInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ExecuteTransactionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" + }, + { + "target": "com.amazonaws.dynamodb#TransactionCanceledException" + }, + { + "target": "com.amazonaws.dynamodb#TransactionInProgressException" + } + ], + "traits": { + "smithy.api#documentation": "

This operation allows you to perform transactional reads or writes on data stored in\n DynamoDB, using PartiQL.

\n \n

The entire transaction must consist of either read statements or write statements,\n you cannot mix both in one transaction. The EXISTS function is an exception and can\n be used to check the condition of specific attributes of the item in a similar\n manner to ConditionCheck in the TransactWriteItems API.

\n " + } + }, + "com.amazonaws.dynamodb#ExecuteTransactionInput": { + "type": "structure", + "members": { + "TransactStatements": { + "target": "com.amazonaws.dynamodb#ParameterizedStatements", + "traits": { + "smithy.api#documentation": "

The list of PartiQL statements representing the transaction to run.

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.dynamodb#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

Set this value to get remaining results, if NextToken was returned in the\n statement response.

", + "smithy.api#idempotencyToken": {} + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity", + "traits": { + "smithy.api#documentation": "

Determines the level of detail about either provisioned or on-demand throughput\n consumption that is returned in the response. For more information, see TransactGetItems and TransactWriteItems.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#ExecuteTransactionOutput": { + "type": "structure", + "members": { + "Responses": { + "target": "com.amazonaws.dynamodb#ItemResponseList", + "traits": { + "smithy.api#documentation": "

The response to a PartiQL transaction.

" + } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityMultiple", + "traits": { + "smithy.api#documentation": "

The capacity units consumed by the entire operation. The values of the list are\n ordered according to the ordering of the statements.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#ExpectedAttributeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#AttributeName" + }, + "value": { + "target": "com.amazonaws.dynamodb#ExpectedAttributeValue" + } + }, + "com.amazonaws.dynamodb#ExpectedAttributeValue": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.dynamodb#AttributeValue", + "traits": { + "smithy.api#documentation": "

Represents the data for the expected attribute.

\n

Each attribute value is described as a name-value pair. The name is the data type, and\n the value is the data itself.

\n

For more information, see Data Types in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "Exists": { + "target": "com.amazonaws.dynamodb#BooleanObject", + "traits": { + "smithy.api#documentation": "

Causes DynamoDB to evaluate the value before attempting a conditional\n operation:

\n \n

The default setting for Exists is true. If you supply a\n Value all by itself, DynamoDB assumes the attribute exists:\n You don't have to set Exists to true, because it is\n implied.

\n

DynamoDB returns a ValidationException if:

\n " + } + }, + "ComparisonOperator": { + "target": "com.amazonaws.dynamodb#ComparisonOperator", + "traits": { + "smithy.api#documentation": "

A comparator for evaluating attributes in the AttributeValueList. For\n example, equals, greater than, less than, etc.

\n

The following comparison operators are available:

\n

\n EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS |\n BEGINS_WITH | IN | BETWEEN\n

\n

The following are descriptions of each comparison operator.

\n " + } + }, + "AttributeValueList": { + "target": "com.amazonaws.dynamodb#AttributeValueList", + "traits": { + "smithy.api#documentation": "

One or more values to evaluate against the supplied attribute. The number of values in\n the list depends on the ComparisonOperator being used.

\n

For type Number, value comparisons are numeric.

\n

String value comparisons for greater than, equals, or less than are based on ASCII\n character code values. For example, a is greater than A, and\n a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

\n

For Binary, DynamoDB treats each byte of the binary data as unsigned when it\n compares binary values.

\n

For information on specifying data types in JSON, see JSON Data Format\n in the Amazon DynamoDB Developer Guide.

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

Represents a condition to be compared with an attribute value. This condition can be\n used with DeleteItem, PutItem, or UpdateItem\n operations; if the comparison evaluates to true, the operation succeeds; if not, the\n operation fails. You can use ExpectedAttributeValue in one of two different\n ways:

\n \n

\n Value and Exists are incompatible with\n AttributeValueList and ComparisonOperator. Note that if\n you use both sets of parameters at once, DynamoDB will return a\n ValidationException exception.

" + } + }, + "com.amazonaws.dynamodb#ExportArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 37, + "max": 1024 + } + } + }, + "com.amazonaws.dynamodb#ExportConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

There was a conflict when writing to the specified S3 bucket.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ExportDescription": { + "type": "structure", + "members": { + "ExportArn": { + "target": "com.amazonaws.dynamodb#ExportArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table export.

" + } + }, + "ExportStatus": { + "target": "com.amazonaws.dynamodb#ExportStatus", + "traits": { + "smithy.api#documentation": "

Export can be in one of the following states: IN_PROGRESS, COMPLETED, or\n FAILED.

" + } + }, + "StartTime": { + "target": "com.amazonaws.dynamodb#ExportStartTime", + "traits": { + "smithy.api#documentation": "

The time at which the export task began.

" + } + }, + "EndTime": { + "target": "com.amazonaws.dynamodb#ExportEndTime", + "traits": { + "smithy.api#documentation": "

The time at which the export task completed.

" + } + }, + "ExportManifest": { + "target": "com.amazonaws.dynamodb#ExportManifest", + "traits": { + "smithy.api#documentation": "

The name of the manifest file for the export task.

" + } + }, + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the table that was exported.

" + } + }, + "TableId": { + "target": "com.amazonaws.dynamodb#TableId", + "traits": { + "smithy.api#documentation": "

Unique ID of the table that was exported.

" + } + }, + "ExportTime": { + "target": "com.amazonaws.dynamodb#ExportTime", + "traits": { + "smithy.api#documentation": "

Point in time from which table data was exported.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.dynamodb#ClientToken", + "traits": { + "smithy.api#documentation": "

The client token that was provided for the export task. A client token makes calls to\n ExportTableToPointInTimeInput idempotent, meaning that multiple\n identical calls have the same effect as one single call.

" + } + }, + "S3Bucket": { + "target": "com.amazonaws.dynamodb#S3Bucket", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket containing the export.

" + } + }, + "S3BucketOwner": { + "target": "com.amazonaws.dynamodb#S3BucketOwner", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the bucket containing the\n export.

" + } + }, + "S3Prefix": { + "target": "com.amazonaws.dynamodb#S3Prefix", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket prefix used as the file name and path of the exported\n snapshot.

" + } + }, + "S3SseAlgorithm": { + "target": "com.amazonaws.dynamodb#S3SseAlgorithm", + "traits": { + "smithy.api#documentation": "

Type of encryption used on the bucket where export data is stored. Valid values for\n S3SseAlgorithm are:

\n " + } + }, + "S3SseKmsKeyId": { + "target": "com.amazonaws.dynamodb#S3SseKmsKeyId", + "traits": { + "smithy.api#documentation": "

The ID of the KMS managed key used to encrypt the S3 bucket where\n export data is stored (if applicable).

" + } + }, + "FailureCode": { + "target": "com.amazonaws.dynamodb#FailureCode", + "traits": { + "smithy.api#documentation": "

Status code for the result of the failed export.

" + } + }, + "FailureMessage": { + "target": "com.amazonaws.dynamodb#FailureMessage", + "traits": { + "smithy.api#documentation": "

Export failure reason description.

" + } + }, + "ExportFormat": { + "target": "com.amazonaws.dynamodb#ExportFormat", + "traits": { + "smithy.api#documentation": "

The format of the exported data. Valid values for ExportFormat are\n DYNAMODB_JSON or ION.

" + } + }, + "BilledSizeBytes": { + "target": "com.amazonaws.dynamodb#BilledSizeBytes", + "traits": { + "smithy.api#documentation": "

The billable size of the table export.

" + } + }, + "ItemCount": { + "target": "com.amazonaws.dynamodb#ItemCount", + "traits": { + "smithy.api#documentation": "

The number of items exported.

" + } + }, + "ExportType": { + "target": "com.amazonaws.dynamodb#ExportType", + "traits": { + "smithy.api#documentation": "

The type of export that was performed. Valid values are FULL_EXPORT or\n INCREMENTAL_EXPORT.

" + } + }, + "IncrementalExportSpecification": { + "target": "com.amazonaws.dynamodb#IncrementalExportSpecification", + "traits": { + "smithy.api#documentation": "

Optional object containing the parameters specific to an incremental export.

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

Represents the properties of the exported table.

" + } + }, + "com.amazonaws.dynamodb#ExportEndTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#ExportFormat": { + "type": "enum", + "members": { + "DYNAMODB_JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DYNAMODB_JSON" + } + }, + "ION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ION" + } + } + } + }, + "com.amazonaws.dynamodb#ExportFromTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#ExportManifest": { + "type": "string" + }, + "com.amazonaws.dynamodb#ExportNextToken": { + "type": "string" + }, + "com.amazonaws.dynamodb#ExportNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified export was not found.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ExportStartTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#ExportStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.dynamodb#ExportSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ExportSummary" + } + }, + "com.amazonaws.dynamodb#ExportSummary": { + "type": "structure", + "members": { + "ExportArn": { + "target": "com.amazonaws.dynamodb#ExportArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the export.

" + } + }, + "ExportStatus": { + "target": "com.amazonaws.dynamodb#ExportStatus", + "traits": { + "smithy.api#documentation": "

Export can be in one of the following states: IN_PROGRESS, COMPLETED, or\n FAILED.

" + } + }, + "ExportType": { + "target": "com.amazonaws.dynamodb#ExportType", + "traits": { + "smithy.api#documentation": "

The type of export that was performed. Valid values are FULL_EXPORT or\n INCREMENTAL_EXPORT.

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

Summary information about an export task.

" + } + }, + "com.amazonaws.dynamodb#ExportTableToPointInTime": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ExportTableToPointInTimeInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ExportTableToPointInTimeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#ExportConflictException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidExportTimeException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#PointInTimeRecoveryUnavailableException" + }, + { + "target": "com.amazonaws.dynamodb#TableNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Exports table data to an S3 bucket. The table must have point in time recovery\n enabled, and you can export data from any time within the point in time recovery\n window.

" + } + }, + "com.amazonaws.dynamodb#ExportTableToPointInTimeInput": { + "type": "structure", + "members": { + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the table to export.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "ExportTime": { + "target": "com.amazonaws.dynamodb#ExportTime", + "traits": { + "smithy.api#documentation": "

Time in the past from which to export table data, counted in seconds from the start of\n the Unix epoch. The table export will be a snapshot of the table's state at this point\n in time.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.dynamodb#ClientToken", + "traits": { + "smithy.api#documentation": "

Providing a ClientToken makes the call to\n ExportTableToPointInTimeInput idempotent, meaning that multiple\n identical calls have the same effect as one single call.

\n

A client token is valid for 8 hours after the first request that uses it is completed.\n After 8 hours, any request with the same client token is treated as a new request. Do\n not resubmit the same request with the same client token for more than 8 hours, or the\n result might not be idempotent.

\n

If you submit a request with the same client token but a change in other parameters\n within the 8-hour idempotency window, DynamoDB returns an\n ExportConflictException.

", + "smithy.api#idempotencyToken": {} + } + }, + "S3Bucket": { + "target": "com.amazonaws.dynamodb#S3Bucket", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket to export the snapshot to.

", + "smithy.api#required": {} + } + }, + "S3BucketOwner": { + "target": "com.amazonaws.dynamodb#S3BucketOwner", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the bucket the export will be\n stored in.

\n \n

S3BucketOwner is a required parameter when exporting to a S3 bucket in another\n account.

\n " + } + }, + "S3Prefix": { + "target": "com.amazonaws.dynamodb#S3Prefix", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket prefix to use as the file name and path of the exported\n snapshot.

" + } + }, + "S3SseAlgorithm": { + "target": "com.amazonaws.dynamodb#S3SseAlgorithm", + "traits": { + "smithy.api#documentation": "

Type of encryption used on the bucket where export data will be stored. Valid values\n for S3SseAlgorithm are:

\n " + } + }, + "S3SseKmsKeyId": { + "target": "com.amazonaws.dynamodb#S3SseKmsKeyId", + "traits": { + "smithy.api#documentation": "

The ID of the KMS managed key used to encrypt the S3 bucket where\n export data will be stored (if applicable).

" + } + }, + "ExportFormat": { + "target": "com.amazonaws.dynamodb#ExportFormat", + "traits": { + "smithy.api#documentation": "

The format for the exported data. Valid values for ExportFormat are\n DYNAMODB_JSON or ION.

" + } + }, + "ExportType": { + "target": "com.amazonaws.dynamodb#ExportType", + "traits": { + "smithy.api#documentation": "

Choice of whether to execute as a full export or incremental export. Valid values are\n FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. If\n INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must also be\n used.

" + } + }, + "IncrementalExportSpecification": { + "target": "com.amazonaws.dynamodb#IncrementalExportSpecification", + "traits": { + "smithy.api#documentation": "

Optional object containing the parameters specific to an incremental export.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#ExportTableToPointInTimeOutput": { + "type": "structure", + "members": { + "ExportDescription": { + "target": "com.amazonaws.dynamodb#ExportDescription", + "traits": { + "smithy.api#documentation": "

Contains a description of the table export.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#ExportTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#ExportToTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#ExportType": { + "type": "enum", + "members": { + "FULL_EXPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL_EXPORT" + } + }, + "INCREMENTAL_EXPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCREMENTAL_EXPORT" + } + } + } + }, + "com.amazonaws.dynamodb#ExportViewType": { + "type": "enum", + "members": { + "NEW_IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW_IMAGE" + } + }, + "NEW_AND_OLD_IMAGES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW_AND_OLD_IMAGES" + } + } + } + }, + "com.amazonaws.dynamodb#ExpressionAttributeNameMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameVariable" + }, + "value": { + "target": "com.amazonaws.dynamodb#AttributeName" + } + }, + "com.amazonaws.dynamodb#ExpressionAttributeNameVariable": { + "type": "string" + }, + "com.amazonaws.dynamodb#ExpressionAttributeValueMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueVariable" + }, + "value": { + "target": "com.amazonaws.dynamodb#AttributeValue" + } + }, + "com.amazonaws.dynamodb#ExpressionAttributeValueVariable": { + "type": "string" + }, + "com.amazonaws.dynamodb#FailureCode": { + "type": "string" + }, + "com.amazonaws.dynamodb#FailureException": { + "type": "structure", + "members": { + "ExceptionName": { + "target": "com.amazonaws.dynamodb#ExceptionName", + "traits": { + "smithy.api#documentation": "

Exception name.

" + } + }, + "ExceptionDescription": { + "target": "com.amazonaws.dynamodb#ExceptionDescription", + "traits": { + "smithy.api#documentation": "

Description of the failure.

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

Represents a failure a contributor insights operation.

" + } + }, + "com.amazonaws.dynamodb#FailureMessage": { + "type": "string" + }, + "com.amazonaws.dynamodb#FilterConditionMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#AttributeName" + }, + "value": { + "target": "com.amazonaws.dynamodb#Condition" + } + }, + "com.amazonaws.dynamodb#Get": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

A map of attribute names to AttributeValue objects that specifies the\n primary key of the item to retrieve.

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table from which to retrieve the specified item. You can also provide\n the Amazon Resource Name (ARN) of the table in this parameter.

", + "smithy.api#required": {} + } + }, + "ProjectionExpression": { + "target": "com.amazonaws.dynamodb#ProjectionExpression", + "traits": { + "smithy.api#documentation": "

A string that identifies one or more attributes of the specified item to retrieve from\n the table. The attributes in the expression must be separated by commas. If no attribute\n names are specified, then all attributes of the specified item are returned. If any of\n the requested attributes are not found, they do not appear in the result.

" + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "

One or more substitution tokens for attribute names in the ProjectionExpression\n parameter.

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

Specifies an item and related attribute values to retrieve in a\n TransactGetItem object.

" + } + }, + "com.amazonaws.dynamodb#GetItem": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#GetItemInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#GetItemOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

The GetItem operation returns a set of attributes for the item with the\n given primary key. If there is no matching item, GetItem does not return\n any data and there will be no Item element in the response.

\n

\n GetItem provides an eventually consistent read by default. If your\n application requires a strongly consistent read, set ConsistentRead to\n true. Although a strongly consistent read might take more time than an\n eventually consistent read, it always returns the last updated value.

", + "smithy.api#examples": [ + { + "title": "To read an item from a table", + "documentation": "This example retrieves an item from the Music table. The table has a partition key and a sort key (Artist and SongTitle), so you must specify both of these attributes.", + "input": { + "TableName": "Music", + "Key": { + "Artist": { + "S": "Acme Band" + }, + "SongTitle": { + "S": "Happy Day" + } + } + }, + "output": { + "Item": { + "AlbumTitle": { + "S": "Songs About Life" + }, + "SongTitle": { + "S": "Happy Day" + }, + "Artist": { + "S": "Acme Band" + } + } + } + } + ] + } + }, + "com.amazonaws.dynamodb#GetItemInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table containing the requested item. You can also provide the\n Amazon Resource Name (ARN) of the table in this parameter.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "Key": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

A map of attribute names to AttributeValue objects, representing the\n primary key of the item to retrieve.

\n

For the primary key, you must provide all of the attributes. For example, with a\n simple primary key, you only need to provide a value for the partition key. For a\n composite primary key, you must provide values for both the partition key and the sort\n key.

", + "smithy.api#required": {} + } + }, + "AttributesToGet": { + "target": "com.amazonaws.dynamodb#AttributeNameList", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use ProjectionExpression instead. For more\n information, see AttributesToGet in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ConsistentRead": { + "target": "com.amazonaws.dynamodb#ConsistentRead", + "traits": { + "smithy.api#documentation": "

Determines the read consistency model: If set to true, then the operation\n uses strongly consistent reads; otherwise, the operation uses eventually consistent\n reads.

" + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + }, + "ProjectionExpression": { + "target": "com.amazonaws.dynamodb#ProjectionExpression", + "traits": { + "smithy.api#documentation": "

A string that identifies one or more attributes to retrieve from the table. These\n attributes can include scalars, sets, or elements of a JSON document. The attributes in\n the expression must be separated by commas.

\n

If no attribute names are specified, then all attributes are returned. If any of the\n requested attributes are not found, they do not appear in the result.

\n

For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.

\n \n

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

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

Represents the input of a GetItem operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#GetItemOutput": { + "type": "structure", + "members": { + "Item": { + "target": "com.amazonaws.dynamodb#AttributeMap", + "traits": { + "smithy.api#documentation": "

A map of attribute names to AttributeValue objects, as specified by\n ProjectionExpression.

" + } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacity", + "traits": { + "smithy.api#documentation": "

The capacity units consumed by the GetItem operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Capacity unit consumption for read operations in the Amazon\n DynamoDB Developer Guide.

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

Represents the output of a GetItem operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#GetResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#GetResourcePolicyInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#GetResourcePolicyOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#PolicyNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Returns the resource-based policy document attached to the resource, which can be a\n table or stream, in JSON format.

\n

\n GetResourcePolicy follows an \n eventually consistent\n model. The following list\n describes the outcomes when you issue the GetResourcePolicy request\n immediately after issuing another request:

\n \n

Because GetResourcePolicy uses an eventually\n consistent query, the metadata for your policy or table might not be\n available at that moment. Wait for a few seconds, and then retry the\n GetResourcePolicy request.

\n

After a GetResourcePolicy request returns a policy created using the\n PutResourcePolicy request, the policy will be applied in the\n authorization of requests to the resource. Because this process is eventually\n consistent, it will take some time to apply the policy to all requests to a resource.\n Policies that you attach while creating a table using the CreateTable\n request will always be applied to all requests for that table.

" + } + }, + "com.amazonaws.dynamodb#GetResourcePolicyInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.dynamodb#ResourceArnString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy is attached. The\n resources you can specify include tables and streams.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#GetResourcePolicyOutput": { + "type": "structure", + "members": { + "Policy": { + "target": "com.amazonaws.dynamodb#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

The resource-based policy document attached to the resource, which can be a table or\n stream, in JSON format.

" + } + }, + "RevisionId": { + "target": "com.amazonaws.dynamodb#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "

A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#GlobalSecondaryIndex": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index. The name must be unique among all other\n indexes on this table.

", + "smithy.api#required": {} + } + }, + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", + "traits": { + "smithy.api#documentation": "

The complete key schema for a global secondary index, which consists of one or more\n pairs of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of\n an internal hash function to evenly distribute data items across partitions, based\n on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key\n value.

\n ", + "smithy.api#required": {} + } + }, + "Projection": { + "target": "com.amazonaws.dynamodb#Projection", + "traits": { + "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into the global\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

", + "smithy.api#required": {} + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "traits": { + "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary\n index. You must use either OnDemandThroughput or\n ProvisionedThroughput based on your table's capacity mode.

\n

For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "

The maximum number of read and write units for the specified global secondary index.\n If you use this parameter, you must specify MaxReadRequestUnits,\n MaxWriteRequestUnits, or both. You must use either\n OnDemandThroughput or ProvisionedThroughput based on your\n table's capacity mode.

" + } + }, + "WarmThroughput": { + "target": "com.amazonaws.dynamodb#WarmThroughput", + "traits": { + "smithy.api#documentation": "

Represents the warm throughput value (in read units per second and write units per\n second) for the specified secondary index. If you use this parameter, you must specify\n ReadUnitsPerSecond, WriteUnitsPerSecond, or both.

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

Represents the properties of a global secondary index.

" + } + }, + "com.amazonaws.dynamodb#GlobalSecondaryIndexAutoScalingUpdate": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index.

" + } + }, + "ProvisionedWriteCapacityAutoScalingUpdate": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate" + } + }, + "traits": { + "smithy.api#documentation": "

Represents the auto scaling settings of a global secondary index for a global table\n that will be modified.

" + } + }, + "com.amazonaws.dynamodb#GlobalSecondaryIndexAutoScalingUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexAutoScalingUpdate" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.dynamodb#GlobalSecondaryIndexDescription": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index.

" + } + }, + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", + "traits": { + "smithy.api#documentation": "

The complete key schema for a global secondary index, which consists of one or more\n pairs of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across\n partitions, based on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with\n the same partition key physically close together, in sorted order by the sort key\n value.

\n " + } + }, + "Projection": { + "target": "com.amazonaws.dynamodb#Projection", + "traits": { + "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into the global\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

" + } + }, + "IndexStatus": { + "target": "com.amazonaws.dynamodb#IndexStatus", + "traits": { + "smithy.api#documentation": "

The current state of the global secondary index:

\n " + } + }, + "Backfilling": { + "target": "com.amazonaws.dynamodb#Backfilling", + "traits": { + "smithy.api#documentation": "

Indicates whether the index is currently backfilling. Backfilling\n is the process of reading items from the table and determining whether they can be added\n to the index. (Not all items will qualify: For example, a partition key cannot have any\n duplicate values.) If an item can be added to the index, DynamoDB will do so. After all\n items have been processed, the backfilling operation is complete and\n Backfilling is false.

\n

You can delete an index that is being created during the Backfilling\n phase when IndexStatus is set to CREATING and Backfilling is\n true. You can't delete the index that is being created when IndexStatus is\n set to CREATING and Backfilling is false.

\n \n

For indexes that were created during a CreateTable operation, the\n Backfilling attribute does not appear in the\n DescribeTable output.

\n " + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputDescription", + "traits": { + "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary\n index.

\n

For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "IndexSizeBytes": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

The total size of the specified index, in bytes. DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this\n value.

" + } + }, + "ItemCount": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

The number of items in the specified index. DynamoDB updates this value approximately\n every six hours. Recent changes might not be reflected in this value.

" + } + }, + "IndexArn": { + "target": "com.amazonaws.dynamodb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the index.

" + } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "

The maximum number of read and write units for the specified global secondary index.\n If you use this parameter, you must specify MaxReadRequestUnits,\n MaxWriteRequestUnits, or both.

" + } + }, + "WarmThroughput": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexWarmThroughputDescription", + "traits": { + "smithy.api#documentation": "

Represents the warm throughput value (in read units per second and write units per\n second) for the specified secondary index.

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

Represents the properties of a global secondary index.

" + } + }, + "com.amazonaws.dynamodb#GlobalSecondaryIndexDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexDescription" + } + }, + "com.amazonaws.dynamodb#GlobalSecondaryIndexInfo": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index.

" + } + }, + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", + "traits": { + "smithy.api#documentation": "

The complete key schema for a global secondary index, which consists of one or more\n pairs of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across\n partitions, based on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with\n the same partition key physically close together, in sorted order by the sort key\n value.

\n " + } + }, + "Projection": { + "target": "com.amazonaws.dynamodb#Projection", + "traits": { + "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into the global\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

" + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "traits": { + "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary\n index.

" + } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput" + } + }, + "traits": { + "smithy.api#documentation": "

Represents the properties of a global secondary index for the table when the backup\n was created.

" + } + }, + "com.amazonaws.dynamodb#GlobalSecondaryIndexList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndex" + } + }, + "com.amazonaws.dynamodb#GlobalSecondaryIndexUpdate": { + "type": "structure", + "members": { + "Update": { + "target": "com.amazonaws.dynamodb#UpdateGlobalSecondaryIndexAction", + "traits": { + "smithy.api#documentation": "

The name of an existing global secondary index, along with new provisioned throughput\n settings to be applied to that index.

" + } + }, + "Create": { + "target": "com.amazonaws.dynamodb#CreateGlobalSecondaryIndexAction", + "traits": { + "smithy.api#documentation": "

The parameters required for creating a global secondary index on an existing\n table:

\n " + } + }, + "Delete": { + "target": "com.amazonaws.dynamodb#DeleteGlobalSecondaryIndexAction", + "traits": { + "smithy.api#documentation": "

The name of an existing global secondary index to be removed.

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

Represents one of the following:

\n " + } + }, + "com.amazonaws.dynamodb#GlobalSecondaryIndexUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexUpdate" + } + }, + "com.amazonaws.dynamodb#GlobalSecondaryIndexWarmThroughputDescription": { + "type": "structure", + "members": { + "ReadUnitsPerSecond": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

Represents warm throughput read units per second value for a global secondary\n index.

" + } + }, + "WriteUnitsPerSecond": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

Represents warm throughput write units per second value for a global secondary\n index.

" + } + }, + "Status": { + "target": "com.amazonaws.dynamodb#IndexStatus", + "traits": { + "smithy.api#documentation": "

Represents the warm throughput status being created or updated on a global secondary\n index. The status can only be UPDATING or ACTIVE.

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

The description of the warm throughput value on a global secondary index.

" + } + }, + "com.amazonaws.dynamodb#GlobalSecondaryIndexes": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexInfo" + } + }, + "com.amazonaws.dynamodb#GlobalTable": { + "type": "structure", + "members": { + "GlobalTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The global table name.

" + } + }, + "ReplicationGroup": { + "target": "com.amazonaws.dynamodb#ReplicaList", + "traits": { + "smithy.api#documentation": "

The Regions where the global table has replicas.

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

Represents the properties of a global table.

" + } + }, + "com.amazonaws.dynamodb#GlobalTableAlreadyExistsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified global table already exists.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#GlobalTableArnString": { + "type": "string" + }, + "com.amazonaws.dynamodb#GlobalTableDescription": { + "type": "structure", + "members": { + "ReplicationGroup": { + "target": "com.amazonaws.dynamodb#ReplicaDescriptionList", + "traits": { + "smithy.api#documentation": "

The Regions where the global table has replicas.

" + } + }, + "GlobalTableArn": { + "target": "com.amazonaws.dynamodb#GlobalTableArnString", + "traits": { + "smithy.api#documentation": "

The unique identifier of the global table.

" + } + }, + "CreationDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

The creation time of the global table.

" + } + }, + "GlobalTableStatus": { + "target": "com.amazonaws.dynamodb#GlobalTableStatus", + "traits": { + "smithy.api#documentation": "

The current state of the global table:

\n " + } + }, + "GlobalTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The global table name.

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

Contains details about the global table.

" + } + }, + "com.amazonaws.dynamodb#GlobalTableGlobalSecondaryIndexSettingsUpdate": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index. The name must be unique among all other\n indexes on this table.

", + "smithy.api#required": {} + } + }, + "ProvisionedWriteCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException.\n

" + } + }, + "ProvisionedWriteCapacityAutoScalingSettingsUpdate": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate", + "traits": { + "smithy.api#documentation": "

Auto scaling settings for managing a global secondary index's write capacity\n units.

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

Represents the settings of a global secondary index for a global table that will be\n modified.

" + } + }, + "com.amazonaws.dynamodb#GlobalTableGlobalSecondaryIndexSettingsUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#GlobalTableGlobalSecondaryIndexSettingsUpdate" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.dynamodb#GlobalTableList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#GlobalTable" + } + }, + "com.amazonaws.dynamodb#GlobalTableNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified global table does not exist.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#GlobalTableSettingsReplicationMode": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "ENABLED_WITH_OVERRIDES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED_WITH_OVERRIDES" + } + } + } + }, + "com.amazonaws.dynamodb#GlobalTableStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } + } + }, + "com.amazonaws.dynamodb#GlobalTableWitnessDescription": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Web Services Region that serves as a witness for the MRSC global\n table.

" + } + }, + "WitnessStatus": { + "target": "com.amazonaws.dynamodb#WitnessStatus", + "traits": { + "smithy.api#documentation": "

The current status of the witness Region in the MRSC global table.

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

Represents the properties of a witness Region in a MRSC global table.

" + } + }, + "com.amazonaws.dynamodb#GlobalTableWitnessDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#GlobalTableWitnessDescription" + } + }, + "com.amazonaws.dynamodb#GlobalTableWitnessGroupUpdate": { + "type": "structure", + "members": { + "Create": { + "target": "com.amazonaws.dynamodb#CreateGlobalTableWitnessGroupMemberAction", + "traits": { + "smithy.api#documentation": "

Specifies a witness Region to be added to a new MRSC global table. The witness must be\n added when creating the MRSC global table.

" + } + }, + "Delete": { + "target": "com.amazonaws.dynamodb#DeleteGlobalTableWitnessGroupMemberAction", + "traits": { + "smithy.api#documentation": "

Specifies a witness Region to be removed from an existing global table. Must be done\n in conjunction with removing a replica. The deletion of both a witness and replica\n converts the remaining replica to a single-Region DynamoDB table.

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

Represents one of the following:

\n \n

You can configure one witness per MRSC global table.

" + } + }, + "com.amazonaws.dynamodb#GlobalTableWitnessGroupUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#GlobalTableWitnessGroupUpdate" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.dynamodb#IdempotentParameterMismatchException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

DynamoDB rejected the request because you retried a request with a\n different payload but with an idempotent token that was already used.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ImportArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 37, + "max": 1024 + } + } + }, + "com.amazonaws.dynamodb#ImportConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

There was a conflict when importing from the specified S3 source. This can occur when\n the current import conflicts with a previous import request that had the same client\n token.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ImportEndTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#ImportNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 112, + "max": 1024 + }, + "smithy.api#pattern": "^([0-9a-f]{16})+$" + } + }, + "com.amazonaws.dynamodb#ImportNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified import was not found.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ImportStartTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#ImportStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "CANCELLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLING" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.dynamodb#ImportSummary": { + "type": "structure", + "members": { + "ImportArn": { + "target": "com.amazonaws.dynamodb#ImportArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) corresponding to the import request.

" + } + }, + "ImportStatus": { + "target": "com.amazonaws.dynamodb#ImportStatus", + "traits": { + "smithy.api#documentation": "

The status of the import operation.

" + } + }, + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the table being imported into.

" + } + }, + "S3BucketSource": { + "target": "com.amazonaws.dynamodb#S3BucketSource", + "traits": { + "smithy.api#documentation": "

The path and S3 bucket of the source file that is being imported. This includes the\n S3Bucket (required), S3KeyPrefix (optional) and S3BucketOwner (optional if the bucket is\n owned by the requester).

" + } + }, + "CloudWatchLogGroupArn": { + "target": "com.amazonaws.dynamodb#CloudWatchLogGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with this\n import task.

" + } + }, + "InputFormat": { + "target": "com.amazonaws.dynamodb#InputFormat", + "traits": { + "smithy.api#documentation": "

The format of the source data. Valid values are CSV,\n DYNAMODB_JSON or ION.

" + } + }, + "StartTime": { + "target": "com.amazonaws.dynamodb#ImportStartTime", + "traits": { + "smithy.api#documentation": "

The time at which this import task began.

" + } + }, + "EndTime": { + "target": "com.amazonaws.dynamodb#ImportEndTime", + "traits": { + "smithy.api#documentation": "

The time at which this import task ended.

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

Summary information about the source file for the import.\n

" + } + }, + "com.amazonaws.dynamodb#ImportSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ImportSummary" + } + }, + "com.amazonaws.dynamodb#ImportTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ImportTableInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ImportTableOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#ImportConflictException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + } + ], + "traits": { + "smithy.api#documentation": "

Imports table data from an S3 bucket.

", + "smithy.rules#operationContextParams": { + "ResourceArn": { + "path": "TableCreationParameters.TableName" + } + } + } + }, + "com.amazonaws.dynamodb#ImportTableDescription": { + "type": "structure", + "members": { + "ImportArn": { + "target": "com.amazonaws.dynamodb#ImportArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) corresponding to the import request.\n

" + } + }, + "ImportStatus": { + "target": "com.amazonaws.dynamodb#ImportStatus", + "traits": { + "smithy.api#documentation": "

The status of the import.

" + } + }, + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the table being imported into.\n

" + } + }, + "TableId": { + "target": "com.amazonaws.dynamodb#TableId", + "traits": { + "smithy.api#documentation": "

The table id corresponding to the table created by import table process.\n

" + } + }, + "ClientToken": { + "target": "com.amazonaws.dynamodb#ClientToken", + "traits": { + "smithy.api#documentation": "

The client token that was provided for the import task. Reusing the client token on\n retry makes a call to ImportTable idempotent.

" + } + }, + "S3BucketSource": { + "target": "com.amazonaws.dynamodb#S3BucketSource", + "traits": { + "smithy.api#documentation": "

Values for the S3 bucket the source file is imported from. Includes bucket name\n (required), key prefix (optional) and bucket account owner ID (optional).

" + } + }, + "ErrorCount": { + "target": "com.amazonaws.dynamodb#ErrorCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of errors occurred on importing the source file into the target table.\n

" + } + }, + "CloudWatchLogGroupArn": { + "target": "com.amazonaws.dynamodb#CloudWatchLogGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with the\n target table.

" + } + }, + "InputFormat": { + "target": "com.amazonaws.dynamodb#InputFormat", + "traits": { + "smithy.api#documentation": "

The format of the source data going into the target table.\n

" + } + }, + "InputFormatOptions": { + "target": "com.amazonaws.dynamodb#InputFormatOptions", + "traits": { + "smithy.api#documentation": "

The format options for the data that was imported into the target table. There is one\n value, CsvOption.

" + } + }, + "InputCompressionType": { + "target": "com.amazonaws.dynamodb#InputCompressionType", + "traits": { + "smithy.api#documentation": "

The compression options for the data that has been imported into the target table.\n The values are NONE, GZIP, or ZSTD.

" + } + }, + "TableCreationParameters": { + "target": "com.amazonaws.dynamodb#TableCreationParameters", + "traits": { + "smithy.api#documentation": "

The parameters for the new table that is being imported into.

" + } + }, + "StartTime": { + "target": "com.amazonaws.dynamodb#ImportStartTime", + "traits": { + "smithy.api#documentation": "

The time when this import task started.

" + } + }, + "EndTime": { + "target": "com.amazonaws.dynamodb#ImportEndTime", + "traits": { + "smithy.api#documentation": "

The time at which the creation of the table associated with this import task\n completed.

" + } + }, + "ProcessedSizeBytes": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

The total size of data processed from the source file, in Bytes.

" + } + }, + "ProcessedItemCount": { + "target": "com.amazonaws.dynamodb#ProcessedItemCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of items processed from the source file.

" + } + }, + "ImportedItemCount": { + "target": "com.amazonaws.dynamodb#ImportedItemCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of items successfully imported into the new table.

" + } + }, + "FailureCode": { + "target": "com.amazonaws.dynamodb#FailureCode", + "traits": { + "smithy.api#documentation": "

The error code corresponding to the failure that the import job ran into during\n execution.

" + } + }, + "FailureMessage": { + "target": "com.amazonaws.dynamodb#FailureMessage", + "traits": { + "smithy.api#documentation": "

The error message corresponding to the failure that the import job ran into during\n execution.

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

Represents the properties of the table being imported into.\n

" + } + }, + "com.amazonaws.dynamodb#ImportTableInput": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.dynamodb#ClientToken", + "traits": { + "smithy.api#documentation": "

Providing a ClientToken makes the call to ImportTableInput\n idempotent, meaning that multiple identical calls have the same effect as one single\n call.

\n

A client token is valid for 8 hours after the first request that uses it is completed.\n After 8 hours, any request with the same client token is treated as a new request. Do\n not resubmit the same request with the same client token for more than 8 hours, or the\n result might not be idempotent.

\n

If you submit a request with the same client token but a change in other parameters\n within the 8-hour idempotency window, DynamoDB returns an\n IdempotentParameterMismatch exception.

", + "smithy.api#idempotencyToken": {} + } + }, + "S3BucketSource": { + "target": "com.amazonaws.dynamodb#S3BucketSource", + "traits": { + "smithy.api#documentation": "

The S3 bucket that provides the source for the import.

", + "smithy.api#required": {} + } + }, + "InputFormat": { + "target": "com.amazonaws.dynamodb#InputFormat", + "traits": { + "smithy.api#documentation": "

The format of the source data. Valid values for ImportFormat are\n CSV, DYNAMODB_JSON or ION.

", + "smithy.api#required": {} + } + }, + "InputFormatOptions": { + "target": "com.amazonaws.dynamodb#InputFormatOptions", + "traits": { + "smithy.api#documentation": "

Additional properties that specify how the input is formatted,

" + } + }, + "InputCompressionType": { + "target": "com.amazonaws.dynamodb#InputCompressionType", + "traits": { + "smithy.api#documentation": "

Type of compression to be used on the input coming from the imported table.

" + } + }, + "TableCreationParameters": { + "target": "com.amazonaws.dynamodb#TableCreationParameters", + "traits": { + "smithy.api#documentation": "

Parameters for the table to import the data into.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#ImportTableOutput": { + "type": "structure", + "members": { + "ImportTableDescription": { + "target": "com.amazonaws.dynamodb#ImportTableDescription", + "traits": { + "smithy.api#documentation": "

Represents the properties of the table created for the import, and parameters of the\n import. The import parameters include import status, how many items were processed, and\n how many errors were encountered.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#ImportedItemCount": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.dynamodb#IncrementalExportSpecification": { + "type": "structure", + "members": { + "ExportFromTime": { + "target": "com.amazonaws.dynamodb#ExportFromTime", + "traits": { + "smithy.api#documentation": "

Time in the past which provides the inclusive start range for the export table's data,\n counted in seconds from the start of the Unix epoch. The incremental export will reflect\n the table's state including and after this point in time.

" + } + }, + "ExportToTime": { + "target": "com.amazonaws.dynamodb#ExportToTime", + "traits": { + "smithy.api#documentation": "

Time in the past which provides the exclusive end range for the export table's data,\n counted in seconds from the start of the Unix epoch. The incremental export will reflect\n the table's state just prior to this point in time. If this is not provided, the latest\n time with data available will be used.

" + } + }, + "ExportViewType": { + "target": "com.amazonaws.dynamodb#ExportViewType", + "traits": { + "smithy.api#documentation": "

The view type that was chosen for the export. Valid values are\n NEW_AND_OLD_IMAGES and NEW_IMAGES. The default value is\n NEW_AND_OLD_IMAGES.

\n

\n NEW_AND_OLD_IMAGES exports both the new and old images of each changed\n item, while NEW_IMAGES exports only the new (latest) image. The view type\n you choose determines the structure of each item in the output for\n insert, update, and delete operations. For\n details and examples of how each view type shapes the export output, see DynamoDB table\n export output format in the Amazon DynamoDB Developer\n Guide.

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

Optional object containing the parameters specific to an incremental export.

" + } + }, + "com.amazonaws.dynamodb#IndexName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" + } + }, + "com.amazonaws.dynamodb#IndexNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The operation tried to access a nonexistent index.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#IndexStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + } + } + }, + "com.amazonaws.dynamodb#InputCompressionType": { + "type": "enum", + "members": { + "GZIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GZIP" + } + }, + "ZSTD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZSTD" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.dynamodb#InputFormat": { + "type": "enum", + "members": { + "DYNAMODB_JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DYNAMODB_JSON" + } + }, + "ION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ION" + } + }, + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + } + } + }, + "com.amazonaws.dynamodb#InputFormatOptions": { + "type": "structure", + "members": { + "Csv": { + "target": "com.amazonaws.dynamodb#CsvOptions", + "traits": { + "smithy.api#documentation": "

The options for imported source files in CSV format. The values are Delimiter and\n HeaderList.

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

The format options for the data that was imported into the target table. There is one\n value, CsvOption.

" + } + }, + "com.amazonaws.dynamodb#Integer": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.dynamodb#IntegerObject": { + "type": "integer" + }, + "com.amazonaws.dynamodb#InternalServerError": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The server encountered an internal error trying to fulfill the request.

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

An error occurred on the server side.

", + "smithy.api#error": "server" + } + }, + "com.amazonaws.dynamodb#InvalidEndpointException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.dynamodb#String" + } + }, + "traits": { + "smithy.api#error": "client", + "smithy.api#httpError": 421 + } + }, + "com.amazonaws.dynamodb#InvalidExportTimeException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified ExportTime is outside of the point in time recovery\n window.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#InvalidRestoreTimeException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

An invalid restore time was specified. RestoreDateTime must be between\n EarliestRestorableDateTime and LatestRestorableDateTime.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ItemCollectionKeyAttributeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#AttributeName" + }, + "value": { + "target": "com.amazonaws.dynamodb#AttributeValue" + } + }, + "com.amazonaws.dynamodb#ItemCollectionMetrics": { + "type": "structure", + "members": { + "ItemCollectionKey": { + "target": "com.amazonaws.dynamodb#ItemCollectionKeyAttributeMap", + "traits": { + "smithy.api#documentation": "

The partition key value of the item collection. This value is the same as the\n partition key value of the item.

" + } + }, + "SizeEstimateRangeGB": { + "target": "com.amazonaws.dynamodb#ItemCollectionSizeEstimateRange", + "traits": { + "smithy.api#documentation": "

An estimate of item collection size, in gigabytes. This value is a two-element array\n containing a lower bound and an upper bound for the estimate. The estimate includes the\n size of all the items in the table, plus the size of all attributes projected into all\n of the local secondary indexes on that table. Use this estimate to measure whether a\n local secondary index is approaching its size limit.

\n

The estimate is subject to change over time; therefore, do not rely on the precision\n or accuracy of the estimate.

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

Information about item collections, if any, that were affected by the operation.\n ItemCollectionMetrics is only returned if the request asked for it. If\n the table does not have any local secondary indexes, this information is not returned in\n the response.

" + } + }, + "com.amazonaws.dynamodb#ItemCollectionMetricsMultiple": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ItemCollectionMetrics" + } + }, + "com.amazonaws.dynamodb#ItemCollectionMetricsPerTable": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#TableArn" + }, + "value": { + "target": "com.amazonaws.dynamodb#ItemCollectionMetricsMultiple" + } + }, + "com.amazonaws.dynamodb#ItemCollectionSizeEstimateBound": { + "type": "double" + }, + "com.amazonaws.dynamodb#ItemCollectionSizeEstimateRange": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ItemCollectionSizeEstimateBound" + } + }, + "com.amazonaws.dynamodb#ItemCollectionSizeLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The total size of an item collection has exceeded the maximum limit of 10\n gigabytes.

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

An item collection is too large. This exception is only returned for tables that\n have one or more local secondary indexes.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ItemCount": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.dynamodb#ItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#AttributeMap" + } + }, + "com.amazonaws.dynamodb#ItemResponse": { + "type": "structure", + "members": { + "Item": { + "target": "com.amazonaws.dynamodb#AttributeMap", + "traits": { + "smithy.api#documentation": "

Map of attribute data consisting of the data type and attribute value.

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

Details for the requested item.

" + } + }, + "com.amazonaws.dynamodb#ItemResponseList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ItemResponse" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.dynamodb#KMSMasterKeyArn": { + "type": "string" + }, + "com.amazonaws.dynamodb#KMSMasterKeyId": { + "type": "string" + }, + "com.amazonaws.dynamodb#Key": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#AttributeName" + }, + "value": { + "target": "com.amazonaws.dynamodb#AttributeValue" + } + }, + "com.amazonaws.dynamodb#KeyConditions": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#AttributeName" + }, + "value": { + "target": "com.amazonaws.dynamodb#Condition" + } + }, + "com.amazonaws.dynamodb#KeyExpression": { + "type": "string" + }, + "com.amazonaws.dynamodb#KeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#Key" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.dynamodb#KeySchema": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#KeySchemaElement" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.dynamodb#KeySchemaAttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.dynamodb#KeySchemaElement": { + "type": "structure", + "members": { + "AttributeName": { + "target": "com.amazonaws.dynamodb#KeySchemaAttributeName", + "traits": { + "smithy.api#documentation": "

The name of a key attribute.

", + "smithy.api#required": {} + } + }, + "KeyType": { + "target": "com.amazonaws.dynamodb#KeyType", + "traits": { + "smithy.api#documentation": "

The role that this key attribute will assume:

\n \n \n

The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across\n partitions, based on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with\n the same partition key physically close together, in sorted order by the sort key\n value.

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

Represents a single element of a key schema. A key schema\n specifies the attributes that make up the primary key of a table, or the key attributes\n of an index.

\n

A KeySchemaElement represents exactly one attribute of the primary key.\n For example, a simple primary key would be represented by one\n KeySchemaElement (for the partition key). A composite primary key would\n require one KeySchemaElement for the partition key, and another\n KeySchemaElement for the sort key.

\n

A KeySchemaElement must be a scalar, top-level attribute (not a nested\n attribute). The data type must be one of String, Number, or Binary. The attribute cannot\n be nested within a List or a Map.

" + } + }, + "com.amazonaws.dynamodb#KeyType": { + "type": "enum", + "members": { + "HASH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HASH" + } + }, + "RANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RANGE" + } + } + } + }, + "com.amazonaws.dynamodb#KeysAndAttributes": { + "type": "structure", + "members": { + "Keys": { + "target": "com.amazonaws.dynamodb#KeyList", + "traits": { + "smithy.api#documentation": "

The primary key attribute values that define the items and the attributes associated\n with the items.

", + "smithy.api#required": {} + } + }, + "AttributesToGet": { + "target": "com.amazonaws.dynamodb#AttributeNameList", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use ProjectionExpression instead. For more\n information, see Legacy\n Conditional Parameters in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ConsistentRead": { + "target": "com.amazonaws.dynamodb#ConsistentRead", + "traits": { + "smithy.api#documentation": "

The consistency of a read operation. If set to true, then a strongly\n consistent read is used; otherwise, an eventually consistent read is used.

" + } + }, + "ProjectionExpression": { + "target": "com.amazonaws.dynamodb#ProjectionExpression", + "traits": { + "smithy.api#documentation": "

A string that identifies one or more attributes to retrieve from the table. These\n attributes can include scalars, sets, or elements of a JSON document. The attributes in\n the ProjectionExpression must be separated by commas.

\n

If no attribute names are specified, then all attributes will be returned. If any of\n the requested attributes are not found, they will not appear in the result.

\n

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.

\n \n

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer\n Guide.

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

Represents a set of primary keys and, for each key, the attributes to retrieve from\n the table.

\n

For each primary key, you must provide all of the key attributes.\n For example, with a simple primary key, you only need to provide the partition key. For\n a composite primary key, you must provide both the partition key\n and the sort key.

" + } + }, + "com.amazonaws.dynamodb#KinesisDataStreamDestination": { + "type": "structure", + "members": { + "StreamArn": { + "target": "com.amazonaws.dynamodb#StreamArn", + "traits": { + "smithy.api#documentation": "

The ARN for a specific Kinesis data stream.

" + } + }, + "DestinationStatus": { + "target": "com.amazonaws.dynamodb#DestinationStatus", + "traits": { + "smithy.api#documentation": "

The current status of replication.

" + } + }, + "DestinationStatusDescription": { + "target": "com.amazonaws.dynamodb#String", + "traits": { + "smithy.api#documentation": "

The human-readable string that corresponds to the replica status.

" + } + }, + "ApproximateCreationDateTimePrecision": { + "target": "com.amazonaws.dynamodb#ApproximateCreationDateTimePrecision", + "traits": { + "smithy.api#documentation": "

The precision of the Kinesis data stream timestamp. The values are either\n MILLISECOND or MICROSECOND.

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

Describes a Kinesis data stream destination.

" + } + }, + "com.amazonaws.dynamodb#KinesisDataStreamDestinations": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#KinesisDataStreamDestination" + } + }, + "com.amazonaws.dynamodb#KinesisStreamingDestinationInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the DynamoDB table. You can also provide the Amazon Resource Name (ARN) of the\n table in this parameter.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "StreamArn": { + "target": "com.amazonaws.dynamodb#StreamArn", + "traits": { + "smithy.api#documentation": "

The ARN for a Kinesis data stream.

", + "smithy.api#required": {} + } + }, + "EnableKinesisStreamingConfiguration": { + "target": "com.amazonaws.dynamodb#EnableKinesisStreamingConfiguration", + "traits": { + "smithy.api#documentation": "

The source for the Kinesis streaming information that is being enabled.

" + } + } + } + }, + "com.amazonaws.dynamodb#KinesisStreamingDestinationOutput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table being modified.

" + } + }, + "StreamArn": { + "target": "com.amazonaws.dynamodb#StreamArn", + "traits": { + "smithy.api#documentation": "

The ARN for the specific Kinesis data stream.

" + } + }, + "DestinationStatus": { + "target": "com.amazonaws.dynamodb#DestinationStatus", + "traits": { + "smithy.api#documentation": "

The current status of the replication.

" + } + }, + "EnableKinesisStreamingConfiguration": { + "target": "com.amazonaws.dynamodb#EnableKinesisStreamingConfiguration", + "traits": { + "smithy.api#documentation": "

The destination for the Kinesis streaming information that is being enabled.

" + } + } + } + }, + "com.amazonaws.dynamodb#LastUpdateDateTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#LimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Too many operations for a given subscriber.

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

There is no limit to the number of daily on-demand backups that can be taken.

\n

For most purposes, up to 500 simultaneous table operations are allowed per account.\n These operations include CreateTable, UpdateTable,\n DeleteTable,UpdateTimeToLive,\n RestoreTableFromBackup, and RestoreTableToPointInTime.

\n

When you are creating a table with one or more secondary indexes, you can have up\n to 250 such requests running at a time. However, if the table or index specifications\n are complex, then DynamoDB might temporarily reduce the number of concurrent\n operations.

\n

When importing into DynamoDB, up to 50 simultaneous import table operations are\n allowed per account.

\n

There is a soft account quota of 2,500 tables.

\n

GetRecords was called with a value of more than 1000 for the limit request\n parameter.

\n

More than 2 processes are reading from the same streams shard at the same time.\n Exceeding this limit may result in request throttling.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ListAttributeValue": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#AttributeValue" + } + }, + "com.amazonaws.dynamodb#ListBackups": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ListBackupsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ListBackupsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

List DynamoDB backups that are associated with an Amazon Web Services account and\n weren't made with Amazon Web Services Backup. To list these backups for a given table,\n specify TableName. ListBackups returns a paginated list of\n results with at most 1 MB worth of items in a page. You can also specify a maximum\n number of entries to be returned in a page.

\n

In the request, start time is inclusive, but end time is exclusive. Note that these\n boundaries are for the time at which the original backup was requested.

\n

You can call ListBackups a maximum of five times per second.

\n

If you want to retrieve the complete list of backups made with Amazon Web Services\n Backup, use the Amazon Web Services Backup\n list API.\n

" + } + }, + "com.amazonaws.dynamodb#ListBackupsInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

Lists the backups from the table specified in TableName. You can also\n provide the Amazon Resource Name (ARN) of the table in this parameter.

", + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "Limit": { + "target": "com.amazonaws.dynamodb#BackupsInputLimit", + "traits": { + "smithy.api#documentation": "

Maximum number of backups to return at once.

" + } + }, + "TimeRangeLowerBound": { + "target": "com.amazonaws.dynamodb#TimeRangeLowerBound", + "traits": { + "smithy.api#documentation": "

Only backups created after this time are listed. TimeRangeLowerBound is\n inclusive.

" + } + }, + "TimeRangeUpperBound": { + "target": "com.amazonaws.dynamodb#TimeRangeUpperBound", + "traits": { + "smithy.api#documentation": "

Only backups created before this time are listed. TimeRangeUpperBound is\n exclusive.

" + } + }, + "ExclusiveStartBackupArn": { + "target": "com.amazonaws.dynamodb#BackupArn", + "traits": { + "smithy.api#documentation": "

\n LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last\n evaluated when the current page of results was returned, inclusive of the current page\n of results. This value may be specified as the ExclusiveStartBackupArn of a\n new ListBackups operation in order to fetch the next page of results.\n

" + } + }, + "BackupType": { + "target": "com.amazonaws.dynamodb#BackupTypeFilter", + "traits": { + "smithy.api#documentation": "

The backups from the table specified by BackupType are listed.

\n

Where BackupType can be:

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#ListBackupsOutput": { + "type": "structure", + "members": { + "BackupSummaries": { + "target": "com.amazonaws.dynamodb#BackupSummaries", + "traits": { + "smithy.api#documentation": "

List of BackupSummary objects.

" + } + }, + "LastEvaluatedBackupArn": { + "target": "com.amazonaws.dynamodb#BackupArn", + "traits": { + "smithy.api#documentation": "

The ARN of the backup last evaluated when the current page of results was returned,\n inclusive of the current page of results. This value may be specified as the\n ExclusiveStartBackupArn of a new ListBackups operation in\n order to fetch the next page of results.

\n

If LastEvaluatedBackupArn is empty, then the last page of results has\n been processed and there are no more results to be retrieved.

\n

If LastEvaluatedBackupArn is not empty, this may or may not indicate\n that there is more data to be returned. All results are guaranteed to have been returned\n if and only if no value for LastEvaluatedBackupArn is returned.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#ListContributorInsights": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ListContributorInsightsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ListContributorInsightsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of ContributorInsightsSummary for a table and all its global secondary\n indexes.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.dynamodb#ListContributorInsightsInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this\n parameter.

", + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "NextToken": { + "target": "com.amazonaws.dynamodb#NextTokenString", + "traits": { + "smithy.api#documentation": "

A token to for the desired page, if there is one.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.dynamodb#ListContributorInsightsLimit", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Maximum number of results to return per page.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#ListContributorInsightsLimit": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "max": 100 + } + } + }, + "com.amazonaws.dynamodb#ListContributorInsightsOutput": { + "type": "structure", + "members": { + "ContributorInsightsSummaries": { + "target": "com.amazonaws.dynamodb#ContributorInsightsSummaries", + "traits": { + "smithy.api#documentation": "

A list of ContributorInsightsSummary.

" + } + }, + "NextToken": { + "target": "com.amazonaws.dynamodb#NextTokenString", + "traits": { + "smithy.api#documentation": "

A token to go to the next page if there is one.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#ListExports": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ListExportsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ListExportsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists completed exports within the past 90 days, in reverse alphanumeric order of ExportArn.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.dynamodb#ListExportsInput": { + "type": "structure", + "members": { + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the exported table.

", + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "MaxResults": { + "target": "com.amazonaws.dynamodb#ListExportsMaxLimit", + "traits": { + "smithy.api#documentation": "

Maximum number of results to return per page.

" + } + }, + "NextToken": { + "target": "com.amazonaws.dynamodb#ExportNextToken", + "traits": { + "smithy.api#documentation": "

An optional string that, if supplied, must be copied from the output of a previous\n call to ListExports. When provided in this manner, the API fetches the next\n page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#ListExportsMaxLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.dynamodb#ListExportsOutput": { + "type": "structure", + "members": { + "ExportSummaries": { + "target": "com.amazonaws.dynamodb#ExportSummaries", + "traits": { + "smithy.api#documentation": "

A list of ExportSummary objects.

" + } + }, + "NextToken": { + "target": "com.amazonaws.dynamodb#ExportNextToken", + "traits": { + "smithy.api#documentation": "

If this value is returned, there are additional results to be displayed. To retrieve\n them, call ListExports again, with NextToken set to this\n value.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#ListGlobalTables": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ListGlobalTablesInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ListGlobalTablesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Lists all global tables that have a replica in the specified Region.

\n \n

This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

\n

To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

\n " + } + }, + "com.amazonaws.dynamodb#ListGlobalTablesInput": { + "type": "structure", + "members": { + "ExclusiveStartGlobalTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The first global table name that this operation will evaluate.

" + } + }, + "Limit": { + "target": "com.amazonaws.dynamodb#PositiveIntegerObject", + "traits": { + "smithy.api#documentation": "

The maximum number of table names to return, if the parameter is not specified\n DynamoDB defaults to 100.

\n

If the number of global tables DynamoDB finds reaches this limit, it stops the\n operation and returns the table names collected up to that point, with a table name in\n the LastEvaluatedGlobalTableName to apply in a subsequent operation to the\n ExclusiveStartGlobalTableName parameter.

" + } + }, + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

Lists the global tables in a specific Region.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#ListGlobalTablesOutput": { + "type": "structure", + "members": { + "GlobalTables": { + "target": "com.amazonaws.dynamodb#GlobalTableList", + "traits": { + "smithy.api#documentation": "

List of global table names.

" + } + }, + "LastEvaluatedGlobalTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

Last evaluated global table name.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#ListImports": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ListImportsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ListImportsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists completed imports within the past 90 days.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "PageSize" + } + } + }, + "com.amazonaws.dynamodb#ListImportsInput": { + "type": "structure", + "members": { + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the table that was imported to.\n

", + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "PageSize": { + "target": "com.amazonaws.dynamodb#ListImportsMaxLimit", + "traits": { + "smithy.api#documentation": "

The number of ImportSummary objects returned in a single page.

" + } + }, + "NextToken": { + "target": "com.amazonaws.dynamodb#ImportNextToken", + "traits": { + "smithy.api#documentation": "

An optional string that, if supplied, must be copied from the output of a previous\n call to ListImports. When provided in this manner, the API fetches the next\n page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#ListImportsMaxLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.dynamodb#ListImportsOutput": { + "type": "structure", + "members": { + "ImportSummaryList": { + "target": "com.amazonaws.dynamodb#ImportSummaryList", + "traits": { + "smithy.api#documentation": "

A list of ImportSummary objects.

" + } + }, + "NextToken": { + "target": "com.amazonaws.dynamodb#ImportNextToken", + "traits": { + "smithy.api#documentation": "

If this value is returned, there are additional results to be displayed. To retrieve\n them, call ListImports again, with NextToken set to this\n value.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#ListTables": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ListTablesInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ListTablesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Returns an array of table names associated with the current account and endpoint. The\n output from ListTables is paginated, with each page returning a maximum of\n 100 table names.

", + "smithy.api#examples": [ + { + "title": "To list tables", + "documentation": "This example lists all of the tables associated with the current AWS account and endpoint.", + "output": { + "TableNames": [ + "Forum", + "ProductCatalog", + "Reply", + "Thread" + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "ExclusiveStartTableName", + "outputToken": "LastEvaluatedTableName", + "items": "TableNames", + "pageSize": "Limit" + }, + "smithy.test#smokeTests": [ + { + "id": "ListTablesSuccess", + "params": { + "Limit": 1 + }, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] + } + }, + "com.amazonaws.dynamodb#ListTablesInput": { + "type": "structure", + "members": { + "ExclusiveStartTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The first table name that this operation will evaluate. Use the value that was\n returned for LastEvaluatedTableName in a previous operation, so that you\n can obtain the next page of results.

" + } + }, + "Limit": { + "target": "com.amazonaws.dynamodb#ListTablesInputLimit", + "traits": { + "smithy.api#documentation": "

A maximum number of table names to return. If this parameter is not specified, the\n limit is 100.

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

Represents the input of a ListTables operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#ListTablesInputLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.dynamodb#ListTablesOutput": { + "type": "structure", + "members": { + "TableNames": { + "target": "com.amazonaws.dynamodb#TableNameList", + "traits": { + "smithy.api#documentation": "

The names of the tables associated with the current account at the current endpoint.\n The maximum size of this array is 100.

\n

If LastEvaluatedTableName also appears in the output, you can use this\n value as the ExclusiveStartTableName parameter in a subsequent\n ListTables request and obtain the next page of results.

" + } + }, + "LastEvaluatedTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the last table in the current page of results. Use this value as the\n ExclusiveStartTableName in a new request to obtain the next page of\n results, until all the table names are returned.

\n

If you do not receive a LastEvaluatedTableName value in the response,\n this means that there are no more table names to be retrieved.

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

Represents the output of a ListTables operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#ListTagsOfResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ListTagsOfResourceInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ListTagsOfResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10\n times per second, per account.

\n

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.

" + } + }, + "com.amazonaws.dynamodb#ListTagsOfResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.dynamodb#ResourceArnString", + "traits": { + "smithy.api#documentation": "

The Amazon DynamoDB resource with tags to be listed. This value is an Amazon Resource\n Name (ARN).

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "NextToken": { + "target": "com.amazonaws.dynamodb#NextTokenString", + "traits": { + "smithy.api#documentation": "

An optional string that, if supplied, must be copied from the output of a previous\n call to ListTagOfResource. When provided in this manner, this API fetches the next page\n of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#ListTagsOfResourceOutput": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.dynamodb#TagList", + "traits": { + "smithy.api#documentation": "

The tags currently associated with the Amazon DynamoDB resource.

" + } + }, + "NextToken": { + "target": "com.amazonaws.dynamodb#NextTokenString", + "traits": { + "smithy.api#documentation": "

If this value is returned, there are additional results to be displayed. To retrieve\n them, call ListTagsOfResource again, with NextToken set to this value.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#LocalSecondaryIndex": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the local secondary index. The name must be unique among all other indexes\n on this table.

", + "smithy.api#required": {} + } + }, + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", + "traits": { + "smithy.api#documentation": "

The complete key schema for the local secondary index, consisting of one or more pairs\n of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of\n an internal hash function to evenly distribute data items across partitions, based\n on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key\n value.

\n ", + "smithy.api#required": {} + } + }, + "Projection": { + "target": "com.amazonaws.dynamodb#Projection", + "traits": { + "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into the local\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

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

Represents the properties of a local secondary index.

" + } + }, + "com.amazonaws.dynamodb#LocalSecondaryIndexDescription": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

Represents the name of the local secondary index.

" + } + }, + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", + "traits": { + "smithy.api#documentation": "

The complete key schema for the local secondary index, consisting of one or more pairs\n of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of\n an internal hash function to evenly distribute data items across partitions, based\n on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key\n value.

\n " + } + }, + "Projection": { + "target": "com.amazonaws.dynamodb#Projection", + "traits": { + "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into the global\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

" + } + }, + "IndexSizeBytes": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

The total size of the specified index, in bytes. DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this\n value.

" + } + }, + "ItemCount": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

The number of items in the specified index. DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this\n value.

" + } + }, + "IndexArn": { + "target": "com.amazonaws.dynamodb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the index.

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

Represents the properties of a local secondary index.

" + } + }, + "com.amazonaws.dynamodb#LocalSecondaryIndexDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#LocalSecondaryIndexDescription" + } + }, + "com.amazonaws.dynamodb#LocalSecondaryIndexInfo": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

Represents the name of the local secondary index.

" + } + }, + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", + "traits": { + "smithy.api#documentation": "

The complete key schema for a local secondary index, which consists of one or more\n pairs of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of\n an internal hash function to evenly distribute data items across partitions, based\n on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key\n value.

\n " + } + }, + "Projection": { + "target": "com.amazonaws.dynamodb#Projection", + "traits": { + "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into the global\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

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

Represents the properties of a local secondary index for the table when the backup was\n created.

" + } + }, + "com.amazonaws.dynamodb#LocalSecondaryIndexList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#LocalSecondaryIndex" + } + }, + "com.amazonaws.dynamodb#LocalSecondaryIndexes": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#LocalSecondaryIndexInfo" + } + }, + "com.amazonaws.dynamodb#Long": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.dynamodb#LongObject": { + "type": "long" + }, + "com.amazonaws.dynamodb#MapAttributeValue": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#AttributeName" + }, + "value": { + "target": "com.amazonaws.dynamodb#AttributeValue" + } + }, + "com.amazonaws.dynamodb#MultiRegionConsistency": { + "type": "enum", + "members": { + "EVENTUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVENTUAL" + } + }, + "STRONG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRONG" + } + } + } + }, + "com.amazonaws.dynamodb#NextTokenString": { + "type": "string" + }, + "com.amazonaws.dynamodb#NonKeyAttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.dynamodb#NonKeyAttributeNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#NonKeyAttributeName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.dynamodb#NonNegativeLongObject": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.dynamodb#NullAttributeValue": { + "type": "boolean" + }, + "com.amazonaws.dynamodb#NumberAttributeValue": { + "type": "string" + }, + "com.amazonaws.dynamodb#NumberSetAttributeValue": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#NumberAttributeValue" + } + }, + "com.amazonaws.dynamodb#OnDemandThroughput": { + "type": "structure", + "members": { + "MaxReadRequestUnits": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

Maximum number of read request units for the specified table.

\n

To specify a maximum OnDemandThroughput on your table, set the value of\n MaxReadRequestUnits as greater than or equal to 1. To remove the\n maximum OnDemandThroughput that is currently set on your table, set the\n value of MaxReadRequestUnits to -1.

" + } + }, + "MaxWriteRequestUnits": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

Maximum number of write request units for the specified table.

\n

To specify a maximum OnDemandThroughput on your table, set the value of\n MaxWriteRequestUnits as greater than or equal to 1. To remove the\n maximum OnDemandThroughput that is currently set on your table, set the\n value of MaxWriteRequestUnits to -1.

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

Sets the maximum number of read and write units for the specified on-demand table. If\n you use this parameter, you must specify MaxReadRequestUnits,\n MaxWriteRequestUnits, or both.

" + } + }, + "com.amazonaws.dynamodb#OnDemandThroughputOverride": { + "type": "structure", + "members": { + "MaxReadRequestUnits": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

Maximum number of read request units for the specified replica table.

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

Overrides the on-demand throughput settings for this replica table. If you don't\n specify a value for this parameter, it uses the source table's on-demand throughput\n settings.

" + } + }, + "com.amazonaws.dynamodb#ParameterizedStatement": { + "type": "structure", + "members": { + "Statement": { + "target": "com.amazonaws.dynamodb#PartiQLStatement", + "traits": { + "smithy.api#documentation": "

A PartiQL statement that uses parameters.

", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.dynamodb#PreparedStatementParameters", + "traits": { + "smithy.api#documentation": "

The parameter values.

" + } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "

An optional parameter that returns the item attributes for a PartiQL\n ParameterizedStatement operation that failed a condition check.

\n

There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

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

Represents a PartiQL statement that uses parameters.

" + } + }, + "com.amazonaws.dynamodb#ParameterizedStatements": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ParameterizedStatement" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.dynamodb#PartiQLBatchRequest": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#BatchStatementRequest" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.dynamodb#PartiQLBatchResponse": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#BatchStatementResponse" + } + }, + "com.amazonaws.dynamodb#PartiQLNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32768 + } + } + }, + "com.amazonaws.dynamodb#PartiQLStatement": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8192 + } + } + }, + "com.amazonaws.dynamodb#PointInTimeRecoveryDescription": { + "type": "structure", + "members": { + "PointInTimeRecoveryStatus": { + "target": "com.amazonaws.dynamodb#PointInTimeRecoveryStatus", + "traits": { + "smithy.api#documentation": "

The current state of point in time recovery:

\n " + } + }, + "RecoveryPeriodInDays": { + "target": "com.amazonaws.dynamodb#RecoveryPeriodInDays", + "traits": { + "smithy.api#documentation": "

The number of preceding days for which continuous backups are taken and maintained.\n Your table data is only recoverable to any point-in-time from within the configured\n recovery period. This parameter is optional.

" + } + }, + "EarliestRestorableDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

Specifies the earliest point in time you can restore your table to. You can restore\n your table to any point in time during the last 35 days.

" + } + }, + "LatestRestorableDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

\n LatestRestorableDateTime is typically 5 minutes before the current time.\n

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

The description of the point in time settings applied to the table.

" + } + }, + "com.amazonaws.dynamodb#PointInTimeRecoverySpecification": { + "type": "structure", + "members": { + "PointInTimeRecoveryEnabled": { + "target": "com.amazonaws.dynamodb#BooleanObject", + "traits": { + "smithy.api#documentation": "

Indicates whether point in time recovery is enabled (true) or disabled (false) on the\n table.

", + "smithy.api#required": {} + } + }, + "RecoveryPeriodInDays": { + "target": "com.amazonaws.dynamodb#RecoveryPeriodInDays", + "traits": { + "smithy.api#documentation": "

The number of preceding days for which continuous backups are taken and maintained.\n Your table data is only recoverable to any point-in-time from within the configured\n recovery period. This parameter is optional. If no value is provided, the value will\n default to 35.

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

Represents the settings used to enable point in time recovery.

" + } + }, + "com.amazonaws.dynamodb#PointInTimeRecoveryStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.dynamodb#PointInTimeRecoveryUnavailableException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Point in time recovery has not yet been enabled for this source table.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#PolicyNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The operation tried to access a nonexistent resource-based policy.

\n

If you specified an ExpectedRevisionId, it's possible that a policy is\n present for the resource but its revision ID didn't match the expected value.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#PolicyRevisionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.dynamodb#PositiveIntegerObject": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.dynamodb#PositiveLongObject": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.dynamodb#PreparedStatementParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#AttributeValue" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.dynamodb#ProcessedItemCount": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.dynamodb#Projection": { + "type": "structure", + "members": { + "ProjectionType": { + "target": "com.amazonaws.dynamodb#ProjectionType", + "traits": { + "smithy.api#documentation": "

The set of attributes that are projected into the index:

\n \n

When using the DynamoDB console, ALL is selected by default.

" + } + }, + "NonKeyAttributes": { + "target": "com.amazonaws.dynamodb#NonKeyAttributeNameList", + "traits": { + "smithy.api#documentation": "

Represents the non-key attribute names which will be projected into the index.

\n

For global and local secondary indexes, the total count of\n NonKeyAttributes summed across all of the secondary indexes, must not\n exceed 100. If you project the same attribute into two different indexes, this counts as\n two distinct attributes when determining the total. This limit only applies when you\n specify the ProjectionType of INCLUDE. You still can specify the\n ProjectionType of ALL to project all attributes from the source table, even\n if the table has more than 100 attributes.

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

Represents attributes that are copied (projected) from the table into an index. These\n are in addition to the primary key attributes and index key attributes, which are\n automatically projected.

" + } + }, + "com.amazonaws.dynamodb#ProjectionExpression": { + "type": "string" + }, + "com.amazonaws.dynamodb#ProjectionType": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "KEYS_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEYS_ONLY" + } + }, + "INCLUDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCLUDE" + } + } + } + }, + "com.amazonaws.dynamodb#ProvisionedThroughput": { + "type": "structure", + "members": { + "ReadCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB\n returns a ThrottlingException. For more information, see Specifying\n Read and Write Requirements in the Amazon DynamoDB Developer\n Guide.

\n

If read/write capacity mode is PAY_PER_REQUEST the value is set to\n 0.

", + "smithy.api#required": {} + } + }, + "WriteCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException. For more information, see Specifying\n Read and Write Requirements in the Amazon DynamoDB Developer\n Guide.

\n

If read/write capacity mode is PAY_PER_REQUEST the value is set to\n 0.

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

Represents the provisioned throughput settings for the specified global secondary\n index. You must use ProvisionedThroughput or\n OnDemandThroughput based on your table’s capacity mode.

\n

For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "com.amazonaws.dynamodb#ProvisionedThroughputDescription": { + "type": "structure", + "members": { + "LastIncreaseDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

The date and time of the last provisioned throughput increase for this table.

" + } + }, + "LastDecreaseDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

The date and time of the last provisioned throughput decrease for this table.

" + } + }, + "NumberOfDecreasesToday": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The number of provisioned throughput decreases for this table during this UTC calendar\n day. For current maximums on provisioned throughput decreases, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ReadCapacityUnits": { + "target": "com.amazonaws.dynamodb#NonNegativeLongObject", + "traits": { + "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB\n returns a ThrottlingException. Eventually consistent reads require less\n effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits\n per second provides 100 eventually consistent ReadCapacityUnits per\n second.

\n

For a table or global secondary index that uses on-demand capacity mode\n (PAY_PER_REQUEST), this value is 0, because on-demand mode\n does not use provisioned throughput.

" + } + }, + "WriteCapacityUnits": { + "target": "com.amazonaws.dynamodb#NonNegativeLongObject", + "traits": { + "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException.

\n

For a table or global secondary index that uses on-demand capacity mode\n (PAY_PER_REQUEST), this value is 0, because on-demand mode\n does not use provisioned throughput.

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

Represents the provisioned throughput settings for the table, consisting of read and\n write capacity units, along with data about increases and decreases.

" + } + }, + "com.amazonaws.dynamodb#ProvisionedThroughputExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage", + "traits": { + "smithy.api#documentation": "

You exceeded your maximum allowed provisioned throughput.

" + } + }, + "ThrottlingReasons": { + "target": "com.amazonaws.dynamodb#ThrottlingReasonList", + "traits": { + "smithy.api#documentation": "

A list of ThrottlingReason that\n provide detailed diagnostic information about why the request was throttled.\n

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

The request was denied due to request throttling. For detailed information about\n why the request was throttled and the ARN of the impacted resource, find the ThrottlingReason field in the returned exception. The Amazon Web Services\n SDKs for DynamoDB automatically retry requests that receive this exception.\n Your request is eventually successful, unless your retry queue is too large to finish.\n Reduce the frequency of requests and use exponential backoff. For more information, go\n to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ProvisionedThroughputOverride": { + "type": "structure", + "members": { + "ReadCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

Replica-specific read capacity units. If not specified, uses the source table's read\n capacity settings.

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

Replica-specific provisioned throughput settings. If not specified, uses the source\n table's provisioned throughput settings.

" + } + }, + "com.amazonaws.dynamodb#Put": { + "type": "structure", + "members": { + "Item": { + "target": "com.amazonaws.dynamodb#PutItemInputAttributeMap", + "traits": { + "smithy.api#documentation": "

A map of attribute name to attribute values, representing the primary key of the item\n to be written by PutItem. All of the table's primary key attributes must be\n specified, and their data types must match those of the table's key schema. If any\n attributes are present in the item that are part of an index key schema for the table,\n their types must match the index key schema.

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

Name of the table in which to write the item. You can also provide the Amazon Resource Name (ARN) of\n the table in this parameter.

", + "smithy.api#required": {} + } + }, + "ConditionExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", + "traits": { + "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional update to\n succeed.

" + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression.

" + } + }, + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "traits": { + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

" + } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the\n Put condition fails. For\n ReturnValuesOnConditionCheckFailure, the valid values are: NONE and\n ALL_OLD.

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

Represents a request to perform a PutItem operation.

" + } + }, + "com.amazonaws.dynamodb#PutItem": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#PutItemInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#PutItemOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#ConditionalCheckFailedException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ItemCollectionSizeLimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ReplicatedWriteConflictException" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" + }, + { + "target": "com.amazonaws.dynamodb#TransactionConflictException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Creates a new item, or replaces an old item with a new item. If an item that has the\n same primary key as the new item already exists in the specified table, the new item\n completely replaces the existing item. You can perform a conditional put operation (add\n a new item if one with the specified primary key doesn't exist), or replace an existing\n item if it has certain attribute values. You can return the item's attribute values in\n the same operation, using the ReturnValues parameter.

\n

When you add an item, the primary key attributes are the only required attributes.

\n

Empty String and Binary attribute values are allowed. Attribute values of type String\n and Binary must have a length greater than zero if the attribute is used as a key\n attribute for a table or index. Set type attributes cannot be empty.

\n

Invalid Requests with empty values will be rejected with a\n ValidationException exception.

\n \n

To prevent a new item from replacing an existing item, use a conditional\n expression that contains the attribute_not_exists function with the\n name of the attribute being used as the partition key for the table. Since every\n record must contain that attribute, the attribute_not_exists function\n will only succeed if no matching item exists.

\n \n \n

To determine whether PutItem overwrote an existing item, use\n ReturnValues set to ALL_OLD. If the response includes\n the Attributes element, an existing item was overwritten.

\n \n

For more information about PutItem, see Working with\n Items in the Amazon DynamoDB Developer Guide.

", + "smithy.api#examples": [ + { + "title": "To add an item to a table", + "documentation": "This example adds a new item to the Music table.", + "input": { + "TableName": "Music", + "Item": { + "AlbumTitle": { + "S": "Somewhat Famous" + }, + "SongTitle": { + "S": "Call Me Today" + }, + "Artist": { + "S": "No One You Know" + } + }, + "ReturnConsumedCapacity": "TOTAL" + }, + "output": { + "ConsumedCapacity": { + "CapacityUnits": 1, + "TableName": "Music" + } + } + } + ] + } + }, + "com.amazonaws.dynamodb#PutItemInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the\n table in this parameter.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "Item": { + "target": "com.amazonaws.dynamodb#PutItemInputAttributeMap", + "traits": { + "smithy.api#documentation": "

A map of attribute name/value pairs, one for each attribute. Only the primary key\n attributes are required; you can optionally provide other attribute name-value pairs for\n the item.

\n

You must provide all of the attributes for the primary key. For example, with a simple\n primary key, you only need to provide a value for the partition key. For a composite\n primary key, you must provide both values for both the partition key and the sort\n key.

\n

If you specify any attributes that are part of an index key, then the data types for\n those attributes must match those of the schema in the table's attribute\n definition.

\n

If the table has vector indexes, the following validations apply to write\n operations. A violation of any of these constraints results in a\n ValidationException:

\n \n

Empty String and Binary attribute values are allowed. Attribute values of type String\n and Binary must have a length greater than zero if the attribute is used as a key\n attribute for a table or index.

\n

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer\n Guide.

\n

Each element in the Item map is an AttributeValue\n object.

", + "smithy.api#required": {} + } + }, + "Expected": { + "target": "com.amazonaws.dynamodb#ExpectedAttributeMap", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more\n information, see Expected in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ReturnValues": { + "target": "com.amazonaws.dynamodb#ReturnValue", + "traits": { + "smithy.api#documentation": "

Use ReturnValues if you want to get the item attributes as they appeared\n before they were updated with the PutItem request. For\n PutItem, the valid values are:

\n \n

The values returned are strongly consistent.

\n

There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

\n \n

The ReturnValues parameter is used by several DynamoDB operations;\n however, PutItem does not recognize any values other than\n NONE or ALL_OLD.

\n " + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + }, + "ReturnItemCollectionMetrics": { + "target": "com.amazonaws.dynamodb#ReturnItemCollectionMetrics", + "traits": { + "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to SIZE,\n the response includes statistics about item collections, if any, that were modified\n during the operation are returned in the response. If set to NONE (the\n default), no statistics are returned.

" + } + }, + "ConditionalOperator": { + "target": "com.amazonaws.dynamodb#ConditionalOperator", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more\n information, see ConditionalOperator in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ConditionExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", + "traits": { + "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional PutItem\n operation to succeed.

\n

An expression can contain any of the following:

\n \n

For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.

\n \n

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "traits": { + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as\n follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},\n \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "

An optional parameter that returns the item attributes for a PutItem\n operation that failed a condition check.

\n

There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

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

Represents the input of a PutItem operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#PutItemInputAttributeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#AttributeName" + }, + "value": { + "target": "com.amazonaws.dynamodb#AttributeValue" + } + }, + "com.amazonaws.dynamodb#PutItemOutput": { + "type": "structure", + "members": { + "Attributes": { + "target": "com.amazonaws.dynamodb#AttributeMap", + "traits": { + "smithy.api#documentation": "

The attribute values as they appeared before the PutItem operation, but\n only if ReturnValues is specified as ALL_OLD in the request.\n Each element consists of an attribute name and an attribute value.

" + } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacity", + "traits": { + "smithy.api#documentation": "

The capacity units consumed by the PutItem operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Capacity unity consumption for write operations in the Amazon\n DynamoDB Developer Guide.

\n

If the table has vector indexes, the response includes a\n VectorIndexes field with VectorWriteRequestBytes consumed\n for each affected vector index.

" + } + }, + "ItemCollectionMetrics": { + "target": "com.amazonaws.dynamodb#ItemCollectionMetrics", + "traits": { + "smithy.api#documentation": "

Information about item collections, if any, that were affected by the\n PutItem operation. ItemCollectionMetrics is only returned\n if the ReturnItemCollectionMetrics parameter was specified. If the table\n does not have any local secondary indexes, this information is not returned in the\n response.

\n

Each ItemCollectionMetrics element consists of:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of a PutItem operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#PutRequest": { + "type": "structure", + "members": { + "Item": { + "target": "com.amazonaws.dynamodb#PutItemInputAttributeMap", + "traits": { + "smithy.api#documentation": "

A map of attribute name to attribute values, representing the primary key of an item\n to be processed by PutItem. All of the table's primary key attributes must\n be specified, and their data types must match those of the table's key schema. If any\n attributes are present in the item that are part of an index key schema for the table,\n their types must match the index key schema.

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

Represents a request to perform a PutItem operation on an item.

" + } + }, + "com.amazonaws.dynamodb#PutResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#PutResourcePolicyInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#PutResourcePolicyOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#PolicyNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Attaches a resource-based policy document to the resource, which can be a table or\n stream. When you attach a resource-based policy using this API, the policy application\n is \n eventually consistent\n .

\n

\n PutResourcePolicy is an idempotent operation; running it multiple times\n on the same resource using the same policy document will return the same revision ID. If\n you specify an ExpectedRevisionId that doesn't match the current policy's\n RevisionId, the PolicyNotFoundException will be\n returned.

\n \n

\n PutResourcePolicy is an asynchronous operation. If you issue a\n GetResourcePolicy request immediately after a\n PutResourcePolicy request, DynamoDB might return your\n previous policy, if there was one, or return the\n PolicyNotFoundException. This is because\n GetResourcePolicy uses an eventually consistent query, and the\n metadata for your policy or table might not be available at that moment. Wait for a\n few seconds, and then try the GetResourcePolicy request again.

\n " + } + }, + "com.amazonaws.dynamodb#PutResourcePolicyInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.dynamodb#ResourceArnString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy will be attached.\n The resources you can specify include tables and streams.

\n

You can control index permissions using the base table's policy. To specify the same permission level for your table and its indexes, you can provide both the table and index Amazon Resource Name (ARN)s in the Resource field of a given Statement in your policy document. Alternatively, to specify different permissions for your table, indexes, or both, you can define multiple Statement fields in your policy document.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "Policy": { + "target": "com.amazonaws.dynamodb#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

An Amazon Web Services resource-based policy document in JSON format.

\n \n

For a full list of all considerations that apply while attaching a resource-based\n policy, see Resource-based\n policy considerations.

", + "smithy.api#required": {} + } + }, + "ExpectedRevisionId": { + "target": "com.amazonaws.dynamodb#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "

A string value that you can use to conditionally update your policy. You can provide\n the revision ID of your existing policy to make mutating requests against that\n policy.

\n \n

When you provide an expected revision ID, if the revision ID of the existing\n policy on the resource doesn't match or if there's no policy attached to the\n resource, your request will be rejected with a\n PolicyNotFoundException.

\n \n

To conditionally attach a policy when no policy exists for the resource, specify\n NO_POLICY for the revision ID.

" + } + }, + "ConfirmRemoveSelfResourceAccess": { + "target": "com.amazonaws.dynamodb#ConfirmRemoveSelfResourceAccess", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Set this parameter to true to confirm that you want to remove your\n permissions to change the policy of this resource in the future.

", + "smithy.api#httpHeader": "x-amz-confirm-remove-self-resource-access" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#PutResourcePolicyOutput": { + "type": "structure", + "members": { + "RevisionId": { + "target": "com.amazonaws.dynamodb#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "

A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#Query": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#QueryInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#QueryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

You must provide the name of the partition key attribute and a single value for that\n attribute. Query returns all items with that partition key value.\n Optionally, you can provide a sort key attribute and use a comparison operator to refine\n the search results.

\n

Use the KeyConditionExpression parameter to provide a specific value for\n the partition key. The Query operation will return all of the items from\n the table or index with that partition key value. You can optionally narrow the scope of\n the Query operation by specifying a sort key value and a comparison\n operator in KeyConditionExpression. To further refine the\n Query results, you can optionally provide a\n FilterExpression. A FilterExpression determines which\n items within the results should be returned to you. All of the other results are\n discarded.

\n

A Query operation always returns a result set. If no matching items are\n found, the result set will be empty. Queries that do not return results consume the\n minimum number of read capacity units for that type of read operation.

\n \n

DynamoDB calculates the number of read capacity units consumed based on item\n size, not on the amount of data that is returned to an application. The number of\n capacity units consumed will be the same whether you request all of the attributes\n (the default behavior) or just some of them (using a projection expression). The\n number will also be the same whether or not you use a FilterExpression.\n

\n \n

\n Query results are always sorted by the sort key value. If the data type of\n the sort key is Number, the results are returned in numeric order; otherwise, the\n results are returned in order of UTF-8 bytes. By default, the sort order is ascending.\n To reverse the order, set the ScanIndexForward parameter to false.

\n

A single Query operation will read up to the maximum number of items set\n (if using the Limit parameter) or a maximum of 1 MB of data and then apply\n any filtering to the results using FilterExpression. If\n LastEvaluatedKey is present in the response, you will need to paginate\n the result set. For more information, see Paginating\n the Results in the Amazon DynamoDB Developer Guide.

\n

\n FilterExpression is applied after a Query finishes, but before\n the results are returned. A FilterExpression cannot contain partition key\n or sort key attributes. You need to specify those attributes in the\n KeyConditionExpression.

\n \n

A Query operation can return an empty result set and a\n LastEvaluatedKey if all the items read for the page of results are\n filtered out.

\n \n

You can query a table, a local secondary index, or a global secondary index. For a\n query on a table or on a local secondary index, you can set the\n ConsistentRead parameter to true and obtain a strongly\n consistent result. Global secondary indexes support eventually consistent reads only, so\n do not specify ConsistentRead when querying a global secondary\n index.

", + "smithy.api#examples": [ + { + "title": "To query an item", + "documentation": "This example queries items in the Music table. The table has a partition key and sort key (Artist and SongTitle), but this query only specifies the partition key value. It returns song titles by the artist named \"No One You Know\".", + "input": { + "TableName": "Music", + "ProjectionExpression": "SongTitle", + "KeyConditionExpression": "Artist = :v1", + "ExpressionAttributeValues": { + ":v1": { + "S": "No One You Know" + } + } + }, + "output": { + "Count": 2, + "Items": [ + { + "SongTitle": { + "S": "Call Me Today" + } + } + ], + "ScannedCount": 2, + "ConsumedCapacity": {} + } + } + ], + "smithy.api#paginated": { + "inputToken": "ExclusiveStartKey", + "outputToken": "LastEvaluatedKey", + "items": "Items", + "pageSize": "Limit" + }, + "smithy.api#suppress": [ + "PaginatedTrait" + ] + } + }, + "com.amazonaws.dynamodb#QueryInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table containing the requested items. You can also provide the\n Amazon Resource Name (ARN) of the table in this parameter.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of an index to query. This index can be any local secondary index or global\n secondary index on the table. Note that if you use the IndexName parameter,\n you must also provide TableName.\n

" + } + }, + "Select": { + "target": "com.amazonaws.dynamodb#Select", + "traits": { + "smithy.api#documentation": "

The attributes to be returned in the result. You can retrieve all item attributes,\n specific item attributes, the count of matching items, or in the case of an index, some\n or all of the attributes projected into the index.

\n \n

If neither Select nor ProjectionExpression are specified,\n DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and\n ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both\n Select and ProjectionExpression together in a single\n request, unless the value for Select is SPECIFIC_ATTRIBUTES.\n (This usage is equivalent to specifying ProjectionExpression without any\n value for Select.)

\n \n

If you use the ProjectionExpression parameter, then the value for\n Select can only be SPECIFIC_ATTRIBUTES. Any other\n value for Select will return an error.

\n " + } + }, + "AttributesToGet": { + "target": "com.amazonaws.dynamodb#AttributeNameList", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use ProjectionExpression instead. For more\n information, see AttributesToGet in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "Limit": { + "target": "com.amazonaws.dynamodb#PositiveIntegerObject", + "traits": { + "smithy.api#documentation": "

The maximum number of items to evaluate (not necessarily the number of matching\n items). If DynamoDB processes the number of items up to the limit while processing the\n results, it stops the operation and returns the matching values up to that point, and a\n key in LastEvaluatedKey to apply in a subsequent operation, so that you can\n pick up where you left off. Also, if the processed dataset size exceeds 1 MB before\n DynamoDB reaches this limit, it stops the operation and returns the matching values up\n to the limit, and a key in LastEvaluatedKey to apply in a subsequent\n operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ConsistentRead": { + "target": "com.amazonaws.dynamodb#ConsistentRead", + "traits": { + "smithy.api#documentation": "

Determines the read consistency model: If set to true, then the operation\n uses strongly consistent reads; otherwise, the operation uses eventually consistent\n reads.

\n

Strongly consistent reads are not supported on global secondary indexes. If you query\n a global secondary index with ConsistentRead set to true, you\n will receive a ValidationException.

" + } + }, + "KeyConditions": { + "target": "com.amazonaws.dynamodb#KeyConditions", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use KeyConditionExpression instead. For more\n information, see KeyConditions in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "QueryFilter": { + "target": "com.amazonaws.dynamodb#FilterConditionMap", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use FilterExpression instead. For more\n information, see QueryFilter in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ConditionalOperator": { + "target": "com.amazonaws.dynamodb#ConditionalOperator", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use FilterExpression instead. For more\n information, see ConditionalOperator in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ScanIndexForward": { + "target": "com.amazonaws.dynamodb#BooleanObject", + "traits": { + "smithy.api#documentation": "

Specifies the order for index traversal: If true (default), the traversal\n is performed in ascending order; if false, the traversal is performed in\n descending order.

\n

Items with the same partition key value are stored in sorted order by sort key. If the\n sort key data type is Number, the results are stored in numeric order. For type String,\n the results are stored in order of UTF-8 bytes. For type Binary, DynamoDB treats each\n byte of the binary data as unsigned.

\n

If ScanIndexForward is true, DynamoDB returns the results in\n the order in which they are stored (by sort key value). This is the default behavior. If\n ScanIndexForward is false, DynamoDB reads the results in\n reverse order by sort key value, and then returns the results to the client.

" + } + }, + "ExclusiveStartKey": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

The primary key of the first item that this operation will evaluate. Use the value\n that was returned for LastEvaluatedKey in the previous operation.

\n

The data type for ExclusiveStartKey must be String, Number, or Binary. No\n set data types are allowed.

" + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + }, + "ProjectionExpression": { + "target": "com.amazonaws.dynamodb#ProjectionExpression", + "traits": { + "smithy.api#documentation": "

A string that identifies one or more attributes to retrieve from the table. These\n attributes can include scalars, sets, or elements of a JSON document. The attributes in\n the expression must be separated by commas.

\n

If no attribute names are specified, then all attributes will be returned. If any of\n the requested attributes are not found, they will not appear in the result.

\n

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "FilterExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", + "traits": { + "smithy.api#documentation": "

A string that contains conditions that DynamoDB applies after the Query\n operation, but before the data is returned to you. Items that do not satisfy the\n FilterExpression criteria are not returned.

\n

A FilterExpression does not allow key attributes. You cannot define a\n filter expression based on a partition key or a sort key.

\n \n

A FilterExpression is applied after the items have already been read;\n the process of filtering does not consume any additional read capacity units.

\n \n

For more information, see Filter\n Expressions in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "KeyConditionExpression": { + "target": "com.amazonaws.dynamodb#KeyExpression", + "traits": { + "smithy.api#documentation": "

The condition that specifies the key values for items to be retrieved by the\n Query action.

\n

The condition must perform an equality test on a single partition key value.

\n

The condition can optionally perform one of several comparison tests on a single sort\n key value. This allows Query to retrieve one item with a given partition\n key value and sort key value, or several items that have the same partition key value\n but different sort key values.

\n

The partition key equality test is required, and must be specified in the following\n format:

\n

\n partitionKeyName\n =\n :partitionkeyval\n

\n

If you also want to provide a condition for the sort key, it must be combined using\n AND with the condition for the sort key. Following is an example, using\n the = comparison operator for the sort key:

\n

\n partitionKeyName\n =\n :partitionkeyval\n AND\n sortKeyName\n =\n :sortkeyval\n

\n

Valid comparisons for the sort key condition are as follows:

\n \n

Use the ExpressionAttributeValues parameter to replace tokens such as\n :partitionval and :sortval with actual values at\n runtime.

\n

You can optionally use the ExpressionAttributeNames parameter to replace\n the names of the partition key and sort key with placeholder tokens. This option might\n be necessary if an attribute name conflicts with a DynamoDB reserved word. For example,\n the following KeyConditionExpression parameter causes an error because\n Size is a reserved word:

\n \n

To work around this, define a placeholder (such a #S) to represent the\n attribute name Size. KeyConditionExpression then is as\n follows:

\n \n

For a list of reserved words, see Reserved Words\n in the Amazon DynamoDB Developer Guide.

\n

For more information on ExpressionAttributeNames and\n ExpressionAttributeValues, see Using\n Placeholders for Attribute Names and Values in the Amazon DynamoDB\n Developer Guide.

" + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.

\n \n

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "traits": { + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as\n follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},\n \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer\n Guide.

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

Represents the input of a Query operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#QueryOutput": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.dynamodb#ItemList", + "traits": { + "smithy.api#documentation": "

An array of item attributes that match the query criteria. Each element in this array\n consists of an attribute name and the value for that attribute.

" + } + }, + "Count": { + "target": "com.amazonaws.dynamodb#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of items in the response.

\n

If you used a QueryFilter in the request, then Count is the\n number of items returned after the filter was applied, and ScannedCount is\n the number of matching items before the filter was applied.

\n

If you did not use a filter in the request, then Count and\n ScannedCount are the same.

" + } + }, + "ScannedCount": { + "target": "com.amazonaws.dynamodb#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of items evaluated, before any QueryFilter is applied. A high\n ScannedCount value with few, or no, Count results\n indicates an inefficient Query operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer\n Guide.

\n

If you did not use a filter in the request, then ScannedCount is the same\n as Count.

" + } + }, + "LastEvaluatedKey": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

The primary key of the item where the operation stopped, inclusive of the previous\n result set. Use this value to start a new operation, excluding this value in the new\n request.

\n

If LastEvaluatedKey is empty, then the \"last page\" of results has been\n processed and there is no more data to be retrieved.

\n

If LastEvaluatedKey is not empty, it does not necessarily mean that there\n is more data in the result set. The only way to know when you have reached the end of\n the result set is when LastEvaluatedKey is empty.

" + } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacity", + "traits": { + "smithy.api#documentation": "

The capacity units consumed by the Query operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Capacity unit consumption for read operations in the Amazon\n DynamoDB Developer Guide.

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

Represents the output of a Query operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#Reason": { + "type": "string" + }, + "com.amazonaws.dynamodb#RecoveryPeriodInDays": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 35 + } + } + }, + "com.amazonaws.dynamodb#RegionName": { + "type": "string" + }, + "com.amazonaws.dynamodb#Replica": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

The Region where the replica needs to be created.

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

Represents the properties of a replica.

" + } + }, + "com.amazonaws.dynamodb#ReplicaAlreadyExistsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified replica is already part of the global table.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ReplicaAutoScalingDescription": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

The Region where the replica exists.

" + } + }, + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexAutoScalingDescriptionList", + "traits": { + "smithy.api#documentation": "

Replica-specific global secondary index auto scaling settings.

" + } + }, + "ReplicaProvisionedReadCapacityAutoScalingSettings": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsDescription" + }, + "ReplicaProvisionedWriteCapacityAutoScalingSettings": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsDescription" + }, + "ReplicaStatus": { + "target": "com.amazonaws.dynamodb#ReplicaStatus", + "traits": { + "smithy.api#documentation": "

The current state of the replica:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the auto scaling settings of the replica.

" + } + }, + "com.amazonaws.dynamodb#ReplicaAutoScalingDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ReplicaAutoScalingDescription" + } + }, + "com.amazonaws.dynamodb#ReplicaAutoScalingUpdate": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

The Region where the replica exists.

", + "smithy.api#required": {} + } + }, + "ReplicaGlobalSecondaryIndexUpdates": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexAutoScalingUpdateList", + "traits": { + "smithy.api#documentation": "

Represents the auto scaling settings of global secondary indexes that will be\n modified.

" + } + }, + "ReplicaProvisionedReadCapacityAutoScalingUpdate": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate" + } + }, + "traits": { + "smithy.api#documentation": "

Represents the auto scaling settings of a replica that will be modified.

" + } + }, + "com.amazonaws.dynamodb#ReplicaAutoScalingUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ReplicaAutoScalingUpdate" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.dynamodb#ReplicaDescription": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

The name of the Region.

" + } + }, + "ReplicaStatus": { + "target": "com.amazonaws.dynamodb#ReplicaStatus", + "traits": { + "smithy.api#documentation": "

The current state of the replica:

\n " + } + }, + "ReplicaArn": { + "target": "com.amazonaws.dynamodb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the global table replica.

" + } + }, + "ReplicaStatusDescription": { + "target": "com.amazonaws.dynamodb#ReplicaStatusDescription", + "traits": { + "smithy.api#documentation": "

Detailed information about the replica status.

" + } + }, + "ReplicaStatusPercentProgress": { + "target": "com.amazonaws.dynamodb#ReplicaStatusPercentProgress", + "traits": { + "smithy.api#documentation": "

Specifies the progress of a Create, Update, or Delete action on the replica as a\n percentage.

" + } + }, + "KMSMasterKeyId": { + "target": "com.amazonaws.dynamodb#KMSMasterKeyId", + "traits": { + "smithy.api#documentation": "

The KMS key of the replica that will be used for KMS\n encryption.

" + } + }, + "ProvisionedThroughputOverride": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputOverride", + "traits": { + "smithy.api#documentation": "

Replica-specific provisioned throughput. If not described, uses the source table's\n provisioned throughput settings.

" + } + }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughputOverride", + "traits": { + "smithy.api#documentation": "

Overrides the maximum on-demand throughput settings for the specified replica\n table.

" + } + }, + "WarmThroughput": { + "target": "com.amazonaws.dynamodb#TableWarmThroughputDescription", + "traits": { + "smithy.api#documentation": "

Represents the warm throughput value for this replica.

" + } + }, + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexDescriptionList", + "traits": { + "smithy.api#documentation": "

Replica-specific global secondary index settings.

" + } + }, + "ReplicaInaccessibleDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

The time at which the replica was first detected as inaccessible. To determine cause\n of inaccessibility check the ReplicaStatus property.

" + } + }, + "ReplicaTableClassSummary": { + "target": "com.amazonaws.dynamodb#TableClassSummary" + }, + "GlobalTableSettingsReplicationMode": { + "target": "com.amazonaws.dynamodb#GlobalTableSettingsReplicationMode", + "traits": { + "smithy.api#documentation": "

Indicates one of the settings synchronization modes for the global table replica:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of the replica.

" + } + }, + "com.amazonaws.dynamodb#ReplicaDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ReplicaDescription" + } + }, + "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndex": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index.

", + "smithy.api#required": {} + } + }, + "ProvisionedThroughputOverride": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputOverride", + "traits": { + "smithy.api#documentation": "

Replica table GSI-specific provisioned throughput. If not specified, uses the source\n table GSI's read capacity settings.

" + } + }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughputOverride", + "traits": { + "smithy.api#documentation": "

Overrides the maximum on-demand throughput settings for the specified global secondary\n index in the specified replica table.

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

Represents the properties of a replica global secondary index.

" + } + }, + "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexAutoScalingDescription": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index.

" + } + }, + "IndexStatus": { + "target": "com.amazonaws.dynamodb#IndexStatus", + "traits": { + "smithy.api#documentation": "

The current state of the replica global secondary index:

\n " + } + }, + "ProvisionedReadCapacityAutoScalingSettings": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsDescription" + }, + "ProvisionedWriteCapacityAutoScalingSettings": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsDescription" + } + }, + "traits": { + "smithy.api#documentation": "

Represents the auto scaling configuration for a replica global secondary index.

" + } + }, + "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexAutoScalingDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexAutoScalingDescription" + } + }, + "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexAutoScalingUpdate": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index.

" + } + }, + "ProvisionedReadCapacityAutoScalingUpdate": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate" + } + }, + "traits": { + "smithy.api#documentation": "

Represents the auto scaling settings of a global secondary index for a replica that\n will be modified.

" + } + }, + "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexAutoScalingUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexAutoScalingUpdate" + } + }, + "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexDescription": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index.

" + } + }, + "ProvisionedThroughputOverride": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputOverride", + "traits": { + "smithy.api#documentation": "

If not described, uses the source table GSI's read capacity settings.

" + } + }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughputOverride", + "traits": { + "smithy.api#documentation": "

Overrides the maximum on-demand throughput for the specified global secondary index in\n the specified replica table.

" + } + }, + "WarmThroughput": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexWarmThroughputDescription", + "traits": { + "smithy.api#documentation": "

Represents the warm throughput of the global secondary index for this replica.

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

Represents the properties of a replica global secondary index.

" + } + }, + "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexDescription" + } + }, + "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndex" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexSettingsDescription": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index. The name must be unique among all other\n indexes on this table.

", + "smithy.api#required": {} + } + }, + "IndexStatus": { + "target": "com.amazonaws.dynamodb#IndexStatus", + "traits": { + "smithy.api#documentation": "

The current status of the global secondary index:

\n " + } + }, + "ProvisionedReadCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB\n returns a ThrottlingException.

" + } + }, + "ProvisionedReadCapacityAutoScalingSettings": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsDescription", + "traits": { + "smithy.api#documentation": "

Auto scaling settings for a global secondary index replica's read capacity\n units.

" + } + }, + "ProvisionedWriteCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException.

" + } + }, + "ProvisionedWriteCapacityAutoScalingSettings": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsDescription", + "traits": { + "smithy.api#documentation": "

Auto scaling settings for a global secondary index replica's write capacity\n units.

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

Represents the properties of a global secondary index.

" + } + }, + "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexSettingsDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexSettingsDescription" + } + }, + "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexSettingsUpdate": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index. The name must be unique among all other\n indexes on this table.

", + "smithy.api#required": {} + } + }, + "ProvisionedReadCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB\n returns a ThrottlingException.

" + } + }, + "ProvisionedReadCapacityAutoScalingSettingsUpdate": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate", + "traits": { + "smithy.api#documentation": "

Auto scaling settings for managing a global secondary index replica's read capacity\n units.

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

Represents the settings of a global secondary index for a global table that will be\n modified.

" + } + }, + "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexSettingsUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexSettingsUpdate" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.dynamodb#ReplicaList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#Replica" + } + }, + "com.amazonaws.dynamodb#ReplicaNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified replica is no longer part of the global table.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ReplicaSettingsDescription": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

The Region name of the replica.

", + "smithy.api#required": {} + } + }, + "ReplicaStatus": { + "target": "com.amazonaws.dynamodb#ReplicaStatus", + "traits": { + "smithy.api#documentation": "

The current state of the Region:

\n " + } + }, + "ReplicaBillingModeSummary": { + "target": "com.amazonaws.dynamodb#BillingModeSummary", + "traits": { + "smithy.api#documentation": "

The read/write capacity mode of the replica.

" + } + }, + "ReplicaProvisionedReadCapacityUnits": { + "target": "com.amazonaws.dynamodb#NonNegativeLongObject", + "traits": { + "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB\n returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB\n Developer Guide.

" + } + }, + "ReplicaProvisionedReadCapacityAutoScalingSettings": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsDescription", + "traits": { + "smithy.api#documentation": "

Auto scaling settings for a global table replica's read capacity units.

" + } + }, + "ReplicaProvisionedWriteCapacityUnits": { + "target": "com.amazonaws.dynamodb#NonNegativeLongObject", + "traits": { + "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB\n Developer Guide.

" + } + }, + "ReplicaProvisionedWriteCapacityAutoScalingSettings": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsDescription", + "traits": { + "smithy.api#documentation": "

Auto scaling settings for a global table replica's write capacity units.

" + } + }, + "ReplicaGlobalSecondaryIndexSettings": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexSettingsDescriptionList", + "traits": { + "smithy.api#documentation": "

Replica global secondary index settings for the global table.

" + } + }, + "ReplicaTableClassSummary": { + "target": "com.amazonaws.dynamodb#TableClassSummary" + } + }, + "traits": { + "smithy.api#documentation": "

Represents the properties of a replica.

" + } + }, + "com.amazonaws.dynamodb#ReplicaSettingsDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ReplicaSettingsDescription" + } + }, + "com.amazonaws.dynamodb#ReplicaSettingsUpdate": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

The Region of the replica to be added.

", + "smithy.api#required": {} + } + }, + "ReplicaProvisionedReadCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB\n returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB\n Developer Guide.

" + } + }, + "ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate", + "traits": { + "smithy.api#documentation": "

Auto scaling settings for managing a global table replica's read capacity\n units.

" + } + }, + "ReplicaGlobalSecondaryIndexSettingsUpdate": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexSettingsUpdateList", + "traits": { + "smithy.api#documentation": "

Represents the settings of a global secondary index for a global table that will be\n modified.

" + } + }, + "ReplicaTableClass": { + "target": "com.amazonaws.dynamodb#TableClass", + "traits": { + "smithy.api#documentation": "

Replica-specific table class. If not specified, uses the source table's table\n class.

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

Represents the settings for a global table in a Region that will be modified.

" + } + }, + "com.amazonaws.dynamodb#ReplicaSettingsUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ReplicaSettingsUpdate" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.dynamodb#ReplicaStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "REGION_DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGION_DISABLED" + } + }, + "INACCESSIBLE_ENCRYPTION_CREDENTIALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACCESSIBLE_ENCRYPTION_CREDENTIALS" + } + }, + "ARCHIVING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARCHIVING" + } + }, + "ARCHIVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARCHIVED" + } + }, + "REPLICATION_NOT_AUTHORIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPLICATION_NOT_AUTHORIZED" + } + } + } + }, + "com.amazonaws.dynamodb#ReplicaStatusDescription": { + "type": "string" + }, + "com.amazonaws.dynamodb#ReplicaStatusPercentProgress": { + "type": "string" + }, + "com.amazonaws.dynamodb#ReplicaUpdate": { + "type": "structure", + "members": { + "Create": { + "target": "com.amazonaws.dynamodb#CreateReplicaAction", + "traits": { + "smithy.api#documentation": "

The parameters required for creating a replica on an existing global table.

" + } + }, + "Delete": { + "target": "com.amazonaws.dynamodb#DeleteReplicaAction", + "traits": { + "smithy.api#documentation": "

The name of the existing replica to be removed.

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

Represents one of the following:

\n " + } + }, + "com.amazonaws.dynamodb#ReplicaUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ReplicaUpdate" + } + }, + "com.amazonaws.dynamodb#ReplicatedWriteConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The request was rejected because one or more items in the request are being modified\n by a request in another Region.

", + "smithy.api#error": "client", + "smithy.api#retryable": {} + } + }, + "com.amazonaws.dynamodb#ReplicationGroupUpdate": { + "type": "structure", + "members": { + "Create": { + "target": "com.amazonaws.dynamodb#CreateReplicationGroupMemberAction", + "traits": { + "smithy.api#documentation": "

The parameters required for creating a replica for the table.

" + } + }, + "Update": { + "target": "com.amazonaws.dynamodb#UpdateReplicationGroupMemberAction", + "traits": { + "smithy.api#documentation": "

The parameters required for updating a replica for the table.

" + } + }, + "Delete": { + "target": "com.amazonaws.dynamodb#DeleteReplicationGroupMemberAction", + "traits": { + "smithy.api#documentation": "

The parameters required for deleting a replica for the table.

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

Represents one of the following:

\n \n \n

When you manually remove a table or global table replica, you do not automatically\n remove any associated scalable targets, scaling policies, or CloudWatch\n alarms.

\n " + } + }, + "com.amazonaws.dynamodb#ReplicationGroupUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ReplicationGroupUpdate" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.dynamodb#RequestLimitExceeded": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + }, + "ThrottlingReasons": { + "target": "com.amazonaws.dynamodb#ThrottlingReasonList", + "traits": { + "smithy.api#documentation": "

A list of ThrottlingReason that\n provide detailed diagnostic information about why the request was throttled.\n

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

Throughput exceeds the current throughput quota for your account. For detailed\n information about why the request was throttled and the ARN of the impacted resource,\n find the ThrottlingReason field in the returned exception. Contact Amazon Web Services Support to request a quota\n increase.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#Resource": { + "type": "string" + }, + "com.amazonaws.dynamodb#ResourceArnString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1283 + } + } + }, + "com.amazonaws.dynamodb#ResourceInUseException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The resource which is being attempted to be changed is in use.

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

The operation conflicts with the resource's availability. For example:

\n \n

When appropriate, wait for the ongoing update to complete and attempt the request\n again.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The resource which is being requested does not exist.

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

The operation tried to access a nonexistent table or index. The resource might not\n be specified correctly, or its status might not be ACTIVE.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ResourcePolicy": { + "type": "string" + }, + "com.amazonaws.dynamodb#RestoreInProgress": { + "type": "boolean" + }, + "com.amazonaws.dynamodb#RestoreSummary": { + "type": "structure", + "members": { + "SourceBackupArn": { + "target": "com.amazonaws.dynamodb#BackupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the backup from which the table was restored.

" + } + }, + "SourceTableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The ARN of the source table of the backup that is being restored.

" + } + }, + "RestoreDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

Point in time or source backup time.

", + "smithy.api#required": {} + } + }, + "RestoreInProgress": { + "target": "com.amazonaws.dynamodb#RestoreInProgress", + "traits": { + "smithy.api#documentation": "

Indicates if a restore is in progress or not.

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

Contains details for the restore.

" + } + }, + "com.amazonaws.dynamodb#RestoreTableFromBackup": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#RestoreTableFromBackupInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#RestoreTableFromBackupOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#BackupInUseException" + }, + { + "target": "com.amazonaws.dynamodb#BackupNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#TableAlreadyExistsException" + }, + { + "target": "com.amazonaws.dynamodb#TableInUseException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Creates a new table from an existing backup. Any number of users can execute up to 50\n concurrent restores (any type of restore) in a given account.

\n

You can call RestoreTableFromBackup at a maximum rate of 10 times per\n second.

\n

You must manually set up the following on the restored table:

\n " + } + }, + "com.amazonaws.dynamodb#RestoreTableFromBackupInput": { + "type": "structure", + "members": { + "TargetTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the new table to which the backup must be restored.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "BackupArn": { + "target": "com.amazonaws.dynamodb#BackupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the backup.

", + "smithy.api#required": {} + } + }, + "BillingModeOverride": { + "target": "com.amazonaws.dynamodb#BillingMode", + "traits": { + "smithy.api#documentation": "

The billing mode of the restored table.

" + } + }, + "GlobalSecondaryIndexOverride": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

List of global secondary indexes for the restored table. The indexes provided should\n match existing secondary indexes. You can choose to exclude some or all of the indexes\n at the time of restore.

" + } + }, + "LocalSecondaryIndexOverride": { + "target": "com.amazonaws.dynamodb#LocalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

List of local secondary indexes for the restored table. The indexes provided should\n match existing secondary indexes. You can choose to exclude some or all of the indexes\n at the time of restore.

" + } + }, + "ProvisionedThroughputOverride": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "traits": { + "smithy.api#documentation": "

Provisioned throughput settings for the restored table.

" + } + }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput" + }, + "SSESpecificationOverride": { + "target": "com.amazonaws.dynamodb#SSESpecification", + "traits": { + "smithy.api#documentation": "

The new server-side encryption settings for the restored table.

" + } + }, + "VectorIndexOverride": { + "target": "com.amazonaws.dynamodb#VectorIndexList", + "traits": { + "smithy.api#documentation": "

The vector indexes for the restored table. If not specified, all vector indexes\n from the backup are restored. The indexes provided must match existing vector\n indexes from the backup. You can choose to exclude some or all of the vector\n indexes at the time of restore.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#RestoreTableFromBackupOutput": { + "type": "structure", + "members": { + "TableDescription": { + "target": "com.amazonaws.dynamodb#TableDescription", + "traits": { + "smithy.api#documentation": "

The description of the table created from an existing backup.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#RestoreTableToPointInTime": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#RestoreTableToPointInTimeInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#RestoreTableToPointInTimeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#InvalidRestoreTimeException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#PointInTimeRecoveryUnavailableException" + }, + { + "target": "com.amazonaws.dynamodb#TableAlreadyExistsException" + }, + { + "target": "com.amazonaws.dynamodb#TableInUseException" + }, + { + "target": "com.amazonaws.dynamodb#TableNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Restores the specified table to the specified point in time within\n EarliestRestorableDateTime and LatestRestorableDateTime.\n You can restore your table to any point in time in the last 35 days. You can set the\n recovery period to any value between 1 and 35 days. Any number of users can execute up\n to 50 concurrent restores (any type of restore) in a given account.

\n

When you restore using point in time recovery, DynamoDB restores your table data to\n the state based on the selected date and time (day:hour:minute:second) to a new table.

\n

Along with data, the following are also included on the new restored table using point\n in time recovery:

\n \n

You must manually set up the following on the restored table:

\n " + } + }, + "com.amazonaws.dynamodb#RestoreTableToPointInTimeInput": { + "type": "structure", + "members": { + "SourceTableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The DynamoDB table that will be restored. This value is an Amazon Resource Name\n (ARN).

" + } + }, + "SourceTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

Name of the source table that is being restored.

" + } + }, + "TargetTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the new table to which it must be restored to.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "UseLatestRestorableTime": { + "target": "com.amazonaws.dynamodb#BooleanObject", + "traits": { + "smithy.api#documentation": "

Restore the table to the latest possible time. LatestRestorableDateTime\n is typically 5 minutes before the current time.

" + } + }, + "RestoreDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

Time in the past to restore the table to.

" + } + }, + "BillingModeOverride": { + "target": "com.amazonaws.dynamodb#BillingMode", + "traits": { + "smithy.api#documentation": "

The billing mode of the restored table.

" + } + }, + "GlobalSecondaryIndexOverride": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

List of global secondary indexes for the restored table. The indexes provided should\n match existing secondary indexes. You can choose to exclude some or all of the indexes\n at the time of restore.

\n

The WarmThroughput setting is not supported on global secondary indexes\n when you use RestoreTableToPointInTime. Although WarmThroughput\n appears in the shared index definition, including it in a\n GlobalSecondaryIndexOverride entry causes the request to fail with a\n validation error.

" + } + }, + "LocalSecondaryIndexOverride": { + "target": "com.amazonaws.dynamodb#LocalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

List of local secondary indexes for the restored table. The indexes provided should\n match existing secondary indexes. You can choose to exclude some or all of the indexes\n at the time of restore.

" + } + }, + "ProvisionedThroughputOverride": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "traits": { + "smithy.api#documentation": "

Provisioned throughput settings for the restored table.

" + } + }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput" + }, + "SSESpecificationOverride": { + "target": "com.amazonaws.dynamodb#SSESpecification", + "traits": { + "smithy.api#documentation": "

The new server-side encryption settings for the restored table.

" + } + }, + "VectorIndexOverride": { + "target": "com.amazonaws.dynamodb#VectorIndexList", + "traits": { + "smithy.api#documentation": "

The vector indexes for the restored table. If not specified, all vector indexes\n from the source table are restored. The indexes provided must match existing\n vector indexes from the source table. You can choose to exclude some or all of\n the vector indexes at the time of restore.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#RestoreTableToPointInTimeOutput": { + "type": "structure", + "members": { + "TableDescription": { + "target": "com.amazonaws.dynamodb#TableDescription", + "traits": { + "smithy.api#documentation": "

Represents the properties of a table.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#ReturnConsumedCapacity": { + "type": "enum", + "members": { + "INDEXES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INDEXES" + } + }, + "TOTAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOTAL" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines the level of detail about either provisioned or on-demand throughput\n consumption that is returned in the response:

\n " + } + }, + "com.amazonaws.dynamodb#ReturnItemCollectionMetrics": { + "type": "enum", + "members": { + "SIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SIZE" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.dynamodb#ReturnValue": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "ALL_OLD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_OLD" + } + }, + "UPDATED_OLD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATED_OLD" + } + }, + "ALL_NEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_NEW" + } + }, + "UPDATED_NEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATED_NEW" + } + } + } + }, + "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure": { + "type": "enum", + "members": { + "ALL_OLD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_OLD" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.dynamodb#S3Bucket": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[a-z0-9A-Z]+[\\.\\-\\w]*[a-z0-9A-Z]+$" + } + }, + "com.amazonaws.dynamodb#S3BucketOwner": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{12}$" + } + }, + "com.amazonaws.dynamodb#S3BucketSource": { + "type": "structure", + "members": { + "S3BucketOwner": { + "target": "com.amazonaws.dynamodb#S3BucketOwner", + "traits": { + "smithy.api#documentation": "

The account number of the S3 bucket that is being imported from. If the bucket is\n owned by the requester this is optional.

" + } + }, + "S3Bucket": { + "target": "com.amazonaws.dynamodb#S3Bucket", + "traits": { + "smithy.api#documentation": "

The S3 bucket that is being imported from.

", + "smithy.api#required": {} + } + }, + "S3KeyPrefix": { + "target": "com.amazonaws.dynamodb#S3Prefix", + "traits": { + "smithy.api#documentation": "

The key prefix shared by all S3 Objects that are being imported.

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

The S3 bucket that is being imported from.

" + } + }, + "com.amazonaws.dynamodb#S3Prefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.dynamodb#S3SseAlgorithm": { + "type": "enum", + "members": { + "AES256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AES256" + } + }, + "KMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMS" + } + } + } + }, + "com.amazonaws.dynamodb#S3SseKmsKeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.dynamodb#SSEDescription": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.dynamodb#SSEStatus", + "traits": { + "smithy.api#documentation": "

Represents the current state of server-side encryption. The only supported values\n are:

\n " + } + }, + "SSEType": { + "target": "com.amazonaws.dynamodb#SSEType", + "traits": { + "smithy.api#documentation": "

Server-side encryption type. The only supported value is:

\n " + } + }, + "KMSMasterKeyArn": { + "target": "com.amazonaws.dynamodb#KMSMasterKeyArn", + "traits": { + "smithy.api#documentation": "

The KMS key ARN used for the KMS encryption.

" + } + }, + "InaccessibleEncryptionDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

Indicates the time, in UNIX epoch date format, when DynamoDB detected that\n the table's KMS key was inaccessible. This attribute will automatically\n be cleared when DynamoDB detects that the table's KMS key is accessible\n again. DynamoDB will initiate the table archival process when table's KMS key remains inaccessible for more than seven days from this date.

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

The description of the server-side encryption status on the specified table.

" + } + }, + "com.amazonaws.dynamodb#SSEEnabled": { + "type": "boolean" + }, + "com.amazonaws.dynamodb#SSESpecification": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.dynamodb#SSEEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether server-side encryption is done using an Amazon Web Services managed\n key or an Amazon Web Services owned key. If enabled (true), server-side encryption type\n is set to KMS and an Amazon Web Services managed key is used (KMS charges apply). If disabled (false) or not specified, server-side\n encryption is set to Amazon Web Services owned key.

" + } + }, + "SSEType": { + "target": "com.amazonaws.dynamodb#SSEType", + "traits": { + "smithy.api#documentation": "

Server-side encryption type. The only supported value is:

\n " + } + }, + "KMSMasterKeyId": { + "target": "com.amazonaws.dynamodb#KMSMasterKeyId", + "traits": { + "smithy.api#documentation": "

The KMS key that should be used for the KMS encryption.\n To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN.\n Note that you should only provide this parameter if the key is different from the\n default DynamoDB key alias/aws/dynamodb.

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

Represents the settings used to enable server-side encryption.

" + } + }, + "com.amazonaws.dynamodb#SSEStatus": { + "type": "enum", + "members": { + "ENABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLING" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLING" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } + } + }, + "com.amazonaws.dynamodb#SSEType": { + "type": "enum", + "members": { + "AES256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AES256" + } + }, + "KMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMS" + } + } + } + }, + "com.amazonaws.dynamodb#ScalarAttributeType": { + "type": "enum", + "members": { + "S": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S" + } + }, + "N": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "N" + } + }, + "B": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "B" + } + } + } + }, + "com.amazonaws.dynamodb#Scan": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ScanInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ScanOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

The Scan operation returns one or more items and item attributes by\n accessing every item in a table or a secondary index. To have DynamoDB return fewer\n items, you can provide a FilterExpression operation.

\n

If the total size of scanned items exceeds the maximum dataset size limit of 1 MB, the\n scan completes and results are returned to the user. The LastEvaluatedKey\n value is also returned and the requestor can use the LastEvaluatedKey to\n continue the scan in a subsequent operation. Each scan response also includes number of\n items that were scanned (ScannedCount) as part of the request. If using a\n FilterExpression, a scan result can result in no items meeting the\n criteria and the Count will result in zero. If you did not use a\n FilterExpression in the scan request, then Count is the\n same as ScannedCount.

\n \n

\n Count and ScannedCount only return the count of items\n specific to a single scan request and, unless the table is less than 1MB, do not\n represent the total number of items in the table.

\n \n

A single Scan operation first reads up to the maximum number of items set\n (if using the Limit parameter) or a maximum of 1 MB of data and then\n applies any filtering to the results if a FilterExpression is provided. If\n LastEvaluatedKey is present in the response, pagination is required to\n complete the full table scan. For more information, see Paginating the\n Results in the Amazon DynamoDB Developer Guide.

\n

\n Scan operations proceed sequentially; however, for faster performance on\n a large table or secondary index, applications can request a parallel Scan\n operation by providing the Segment and TotalSegments\n parameters. For more information, see Parallel\n Scan in the Amazon DynamoDB Developer Guide.

\n

By default, a Scan uses eventually consistent reads when accessing the\n items in a table. Therefore, the results from an eventually consistent Scan\n may not include the latest item changes at the time the scan iterates through each item\n in the table. If you require a strongly consistent read of each item as the scan\n iterates through the items in the table, you can set the ConsistentRead\n parameter to true. Strong consistency only relates to the consistency of the read at the\n item level.

\n \n

DynamoDB does not provide snapshot isolation for a scan operation when the\n ConsistentRead parameter is set to true. Thus, a DynamoDB scan\n operation does not guarantee that all reads in a scan see a consistent snapshot of\n the table when the scan operation was requested.

\n ", + "smithy.api#examples": [ + { + "title": "To scan a table", + "documentation": "This example scans the entire Music table, and then narrows the results to songs by the artist \"No One You Know\". For each item, only the album title and song title are returned.", + "input": { + "TableName": "Music", + "FilterExpression": "Artist = :a", + "ProjectionExpression": "#ST, #AT", + "ExpressionAttributeNames": { + "#ST": "SongTitle", + "#AT": "AlbumTitle" + }, + "ExpressionAttributeValues": { + ":a": { + "S": "No One You Know" + } + } + }, + "output": { + "Count": 2, + "Items": [ + { + "SongTitle": { + "S": "Call Me Today" + }, + "AlbumTitle": { + "S": "Somewhat Famous" + } + }, + { + "SongTitle": { + "S": "Scared of My Shadow" + }, + "AlbumTitle": { + "S": "Blue Sky Blues" + } + } + ], + "ScannedCount": 3, + "ConsumedCapacity": {} + } + } + ], + "smithy.api#paginated": { + "inputToken": "ExclusiveStartKey", + "outputToken": "LastEvaluatedKey", + "items": "Items", + "pageSize": "Limit" + }, + "smithy.api#suppress": [ + "PaginatedTrait" + ] + } + }, + "com.amazonaws.dynamodb#ScanInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table containing the requested items or if you provide\n IndexName, the name of the table to which that index belongs.

\n

You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of a secondary index to scan. This index can be any local secondary index or\n global secondary index. Note that if you use the IndexName parameter, you\n must also provide TableName.

" + } + }, + "AttributesToGet": { + "target": "com.amazonaws.dynamodb#AttributeNameList", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use ProjectionExpression instead. For more\n information, see AttributesToGet in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "Limit": { + "target": "com.amazonaws.dynamodb#PositiveIntegerObject", + "traits": { + "smithy.api#documentation": "

The maximum number of items to evaluate (not necessarily the number of matching\n items). If DynamoDB processes the number of items up to the limit while processing the\n results, it stops the operation and returns the matching values up to that point, and a\n key in LastEvaluatedKey to apply in a subsequent operation, so that you can\n pick up where you left off. Also, if the processed dataset size exceeds 1 MB before\n DynamoDB reaches this limit, it stops the operation and returns the matching values up\n to the limit, and a key in LastEvaluatedKey to apply in a subsequent\n operation to continue the operation. For more information, see Working with Queries in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "Select": { + "target": "com.amazonaws.dynamodb#Select", + "traits": { + "smithy.api#documentation": "

The attributes to be returned in the result. You can retrieve all item attributes,\n specific item attributes, the count of matching items, or in the case of an index, some\n or all of the attributes projected into the index.

\n \n

If neither Select nor ProjectionExpression are specified,\n DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and\n ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both\n Select and ProjectionExpression together in a single\n request, unless the value for Select is SPECIFIC_ATTRIBUTES.\n (This usage is equivalent to specifying ProjectionExpression without any\n value for Select.)

\n \n

If you use the ProjectionExpression parameter, then the value for\n Select can only be SPECIFIC_ATTRIBUTES. Any other\n value for Select will return an error.

\n " + } + }, + "ScanFilter": { + "target": "com.amazonaws.dynamodb#FilterConditionMap", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use FilterExpression instead. For more\n information, see ScanFilter in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ConditionalOperator": { + "target": "com.amazonaws.dynamodb#ConditionalOperator", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use FilterExpression instead. For more\n information, see ConditionalOperator in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ExclusiveStartKey": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

The primary key of the first item that this operation will evaluate. Use the value\n that was returned for LastEvaluatedKey in the previous operation.

\n

The data type for ExclusiveStartKey must be String, Number or Binary. No\n set data types are allowed.

\n

In a parallel scan, a Scan request that includes\n ExclusiveStartKey must specify the same segment whose previous\n Scan returned the corresponding value of\n LastEvaluatedKey.

" + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + }, + "TotalSegments": { + "target": "com.amazonaws.dynamodb#ScanTotalSegments", + "traits": { + "smithy.api#documentation": "

For a parallel Scan request, TotalSegments represents the\n total number of segments into which the Scan operation will be divided. The\n value of TotalSegments corresponds to the number of application workers\n that will perform the parallel scan. For example, if you want to use four application\n threads to scan a table or an index, specify a TotalSegments value of\n 4.

\n

The value for TotalSegments must be greater than or equal to 1, and less\n than or equal to 1000000. If you specify a TotalSegments value of 1, the\n Scan operation will be sequential rather than parallel.

\n

If you specify TotalSegments, you must also specify\n Segment.

" + } + }, + "Segment": { + "target": "com.amazonaws.dynamodb#ScanSegment", + "traits": { + "smithy.api#documentation": "

For a parallel Scan request, Segment identifies an\n individual segment to be scanned by an application worker.

\n

Segment IDs are zero-based, so the first segment is always 0. For example, if you want\n to use four application threads to scan a table or an index, then the first thread\n specifies a Segment value of 0, the second thread specifies 1, and so\n on.

\n

The value of LastEvaluatedKey returned from a parallel Scan\n request must be used as ExclusiveStartKey with the same segment ID in a\n subsequent Scan operation.

\n

The value for Segment must be greater than or equal to 0, and less than\n the value provided for TotalSegments.

\n

If you provide Segment, you must also provide\n TotalSegments.

" + } + }, + "ProjectionExpression": { + "target": "com.amazonaws.dynamodb#ProjectionExpression", + "traits": { + "smithy.api#documentation": "

A string that identifies one or more attributes to retrieve from the specified table\n or index. These attributes can include scalars, sets, or elements of a JSON document.\n The attributes in the expression must be separated by commas.

\n

If no attribute names are specified, then all attributes will be returned. If any of\n the requested attributes are not found, they will not appear in the result.

\n

For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "FilterExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", + "traits": { + "smithy.api#documentation": "

A string that contains conditions that DynamoDB applies after the Scan\n operation, but before the data is returned to you. Items that do not satisfy the\n FilterExpression criteria are not returned.

\n \n

A FilterExpression is applied after the items have already been read;\n the process of filtering does not consume any additional read capacity units.

\n \n

For more information, see Filter\n Expressions in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.

\n \n

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "traits": { + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as\n follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},\n \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ConsistentRead": { + "target": "com.amazonaws.dynamodb#ConsistentRead", + "traits": { + "smithy.api#documentation": "

A Boolean value that determines the read consistency model during the scan:

\n \n

The default setting for ConsistentRead is false.

\n

The ConsistentRead parameter is not supported on global secondary\n indexes. If you scan a global secondary index with ConsistentRead set to\n true, you will receive a ValidationException.

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

Represents the input of a Scan operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#ScanOutput": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.dynamodb#ItemList", + "traits": { + "smithy.api#documentation": "

An array of item attributes that match the scan criteria. Each element in this array\n consists of an attribute name and the value for that attribute.

" + } + }, + "Count": { + "target": "com.amazonaws.dynamodb#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of items in the response.

\n

If you set ScanFilter in the request, then Count is the\n number of items returned after the filter was applied, and ScannedCount is\n the number of matching items before the filter was applied.

\n

If you did not use a filter in the request, then Count is the same as\n ScannedCount.

" + } + }, + "ScannedCount": { + "target": "com.amazonaws.dynamodb#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of items evaluated, before any ScanFilter is applied. A high\n ScannedCount value with few, or no, Count results\n indicates an inefficient Scan operation. For more information, see Count and\n ScannedCount in the Amazon DynamoDB Developer\n Guide.

\n

If you did not use a filter in the request, then ScannedCount is the same\n as Count.

" + } + }, + "LastEvaluatedKey": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

The primary key of the item where the operation stopped, inclusive of the previous\n result set. Use this value to start a new operation, excluding this value in the new\n request.

\n

If LastEvaluatedKey is empty, then the \"last page\" of results has been\n processed and there is no more data to be retrieved.

\n

If LastEvaluatedKey is not empty, it does not necessarily mean that there\n is more data in the result set. The only way to know when you have reached the end of\n the result set is when LastEvaluatedKey is empty.

" + } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacity", + "traits": { + "smithy.api#documentation": "

The capacity units consumed by the Scan operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Capacity unit consumption for read operations in the Amazon\n DynamoDB Developer Guide.

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

Represents the output of a Scan operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#ScanSegment": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 999999 + } + } + }, + "com.amazonaws.dynamodb#ScanTotalSegments": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000000 + } + } + }, + "com.amazonaws.dynamodb#ScoreNumber": { + "type": "double", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.dynamodb#SearchResultItem": { + "type": "structure", + "members": { + "Item": { + "target": "com.amazonaws.dynamodb#AttributeMap", + "traits": { + "smithy.api#documentation": "

A map of attribute names to AttributeValue objects, representing the\n projected attributes of the item returned by the vector search.

" + } + }, + "Score": { + "target": "com.amazonaws.dynamodb#ScoreNumber", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The similarity score for this item relative to the search vector. The\n interpretation depends on the distance function configured for the vector\n index.

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

A single result from a SearchVectors operation.

" + } + }, + "com.amazonaws.dynamodb#SearchResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#SearchResultItem" + } + }, + "com.amazonaws.dynamodb#SearchSchema": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#SearchSchemaElement" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.dynamodb#SearchSchemaElement": { + "type": "structure", + "members": { + "AttributeName": { + "target": "com.amazonaws.dynamodb#AttributeName", + "traits": { + "smithy.api#documentation": "

The name of the attribute.

", + "smithy.api#required": {} + } + }, + "SearchSchemaElementType": { + "target": "com.amazonaws.dynamodb#SearchSchemaElementType", + "traits": { + "smithy.api#documentation": "

The role of the attribute in the search schema. Valid values:

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

An element in the search schema of a vector index.

" + } + }, + "com.amazonaws.dynamodb#SearchSchemaElementType": { + "type": "enum", + "members": { + "HASH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HASH" + } + }, + "INLINE_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INLINE_FILTER" + } + } + } + }, + "com.amazonaws.dynamodb#SearchVectorList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#AttributeValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "com.amazonaws.dynamodb#SearchVectors": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#SearchVectorsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#SearchVectorsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Performs a vector similarity search on a vector index associated with an Amazon\n DynamoDB table, and returns the most similar items sorted by similarity score\n based on the distance function configured for the index.

\n

Score interpretation depends on the distance function:

\n ", + "smithy.api#examples": [ + { + "title": "To search for similar vectors", + "documentation": "This example searches the Products table for the top 3 items most similar to a provided vector, using the 'cosine-product-idx' vector index. The SearchConditionExpression filters results to the 'Electronics' category. The operation returns only the ProductName and Price attributes.", + "input": { + "TableName": "Products", + "IndexName": "cosine-product-idx", + "SearchVector": [ + { + "N": "0.12" + }, + { + "N": "0.85" + }, + { + "N": "0.44" + }, + { + "N": "0.67" + } + ], + "TopK": 3, + "SearchConditionExpression": "Category = :cat", + "ProjectionExpression": "ProductName, Price", + "ExpressionAttributeValues": { + ":cat": { + "S": "Electronics" + } + }, + "ReturnConsumedCapacity": "INDEXES" + }, + "output": { + "SearchResults": [ + { + "Item": { + "ProductName": { + "S": "Wireless Headphones" + }, + "Price": { + "N": "79.99" + } + }, + "Score": 0.95 + }, + { + "Item": { + "ProductName": { + "S": "Bluetooth Speaker" + }, + "Price": { + "N": "49.99" + } + }, + "Score": 0.87 + }, + { + "Item": { + "ProductName": { + "S": "USB-C Hub" + }, + "Price": { + "N": "34.99" + } + }, + "Score": 0.82 + } + ], + "ConsumedCapacity": { + "VectorSearchRequestBytes": 1024 + } + } + } + ], + "smithy.rules#staticContextParams": { + "IsSearchOperation": { + "value": true + } + } + } + }, + "com.amazonaws.dynamodb#SearchVectorsInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the table containing the vector index.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the vector index to search. The index must be in the\n ACTIVE state.

", + "smithy.api#required": {} + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. Use the\n # character in an expression to dereference an attribute name.

" + } + }, + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "traits": { + "smithy.api#documentation": "

One or more values that can be substituted in an expression. Use the\n : character in an expression to dereference an attribute value.

" + } + }, + "ProjectionExpression": { + "target": "com.amazonaws.dynamodb#ProjectionExpression", + "traits": { + "smithy.api#documentation": "

A string that identifies one or more attributes to retrieve from the index.\n Separate attribute names with commas. If not specified, the operation returns all\n attributes projected into the vector index.

\n

Only attributes projected into the vector index can be retrieved.

" + } + }, + "SearchVector": { + "target": "com.amazonaws.dynamodb#SearchVectorList", + "traits": { + "smithy.api#documentation": "

The search vector to compare against the indexed vectors. Each element is a 32-bit\n IEEE-754 floating point number, provided in DynamoDB list format.

\n

The number of dimensions must match the number of dimensions configured for the\n vector index.

", + "smithy.api#required": {} + } + }, + "SearchConditionExpression": { + "target": "com.amazonaws.dynamodb#String", + "traits": { + "smithy.api#documentation": "

A condition expression used to filter the vector search results. The expression can\n reference attributes defined in the vector index search schema, including\n HASH and INLINE_FILTER key elements.

\n

Only the equality operator (=) is supported for HASH\n attributes. Comparison and range operators are supported for\n INLINE_FILTER attributes. Only top-level attributes from the search\n schema can be referenced.

" + } + }, + "TopK": { + "target": "com.amazonaws.dynamodb#TopKInteger", + "traits": { + "smithy.api#documentation": "

The number of most similar results to return.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#SearchVectorsOutput": { + "type": "structure", + "members": { + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#VectorCapacity", + "traits": { + "smithy.api#documentation": "

The capacity units consumed by the SearchVectors operation. Contains\n VectorSearchRequestBytes, which represents the vector search capacity\n consumed.

" + } + }, + "SearchResults": { + "target": "com.amazonaws.dynamodb#SearchResultList", + "traits": { + "smithy.api#documentation": "

A list of items returned by the vector similarity search, sorted by similarity\n with the most similar item first. Each item contains the projected attributes and\n a similarity score.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#SecondaryIndexesCapacityMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#IndexName" + }, + "value": { + "target": "com.amazonaws.dynamodb#Capacity" + } + }, + "com.amazonaws.dynamodb#Select": { + "type": "enum", + "members": { + "ALL_ATTRIBUTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_ATTRIBUTES" + } + }, + "ALL_PROJECTED_ATTRIBUTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_PROJECTED_ATTRIBUTES" + } + }, + "SPECIFIC_ATTRIBUTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPECIFIC_ATTRIBUTES" + } + }, + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + } + } + }, + "com.amazonaws.dynamodb#SourceTableDetails": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table for which the backup was created.

", + "smithy.api#required": {} + } + }, + "TableId": { + "target": "com.amazonaws.dynamodb#TableId", + "traits": { + "smithy.api#documentation": "

Unique identifier for the table for which the backup was created.

", + "smithy.api#required": {} + } + }, + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

ARN of the table for which backup was created.

" + } + }, + "TableSizeBytes": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

Size of the table in bytes. Note that this is an approximate value.

" + } + }, + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", + "traits": { + "smithy.api#documentation": "

Schema of the table.

", + "smithy.api#required": {} + } + }, + "TableCreationDateTime": { + "target": "com.amazonaws.dynamodb#TableCreationDateTime", + "traits": { + "smithy.api#documentation": "

Time when the source table was created.

", + "smithy.api#required": {} + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "traits": { + "smithy.api#documentation": "

Read IOPs and Write IOPS on the table when the backup was created.

", + "smithy.api#required": {} + } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput" + }, + "ItemCount": { + "target": "com.amazonaws.dynamodb#ItemCount", + "traits": { + "smithy.api#documentation": "

Number of items in the table. Note that this is an approximate value.

" + } + }, + "BillingMode": { + "target": "com.amazonaws.dynamodb#BillingMode", + "traits": { + "smithy.api#documentation": "

Controls how you are charged for read and write throughput and how you manage\n capacity. This setting can be changed later.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of the table when the backup was created.

" + } + }, + "com.amazonaws.dynamodb#SourceTableFeatureDetails": { + "type": "structure", + "members": { + "LocalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#LocalSecondaryIndexes", + "traits": { + "smithy.api#documentation": "

Represents the LSI properties for the table when the backup was created. It includes\n the IndexName, KeySchema and Projection for the LSIs on the table at the time of backup.\n

" + } + }, + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexes", + "traits": { + "smithy.api#documentation": "

Represents the GSI properties for the table when the backup was created. It includes\n the IndexName, KeySchema, Projection, and ProvisionedThroughput for the GSIs on the\n table at the time of backup.

" + } + }, + "StreamDescription": { + "target": "com.amazonaws.dynamodb#StreamSpecification", + "traits": { + "smithy.api#documentation": "

Stream settings on the table when the backup was created.

" + } + }, + "TimeToLiveDescription": { + "target": "com.amazonaws.dynamodb#TimeToLiveDescription", + "traits": { + "smithy.api#documentation": "

Time to Live settings on the table when the backup was created.

" + } + }, + "SSEDescription": { + "target": "com.amazonaws.dynamodb#SSEDescription", + "traits": { + "smithy.api#documentation": "

The description of the server-side encryption status on the table when the backup was\n created.

" + } + }, + "VectorIndexes": { + "target": "com.amazonaws.dynamodb#VectorIndexes", + "traits": { + "smithy.api#documentation": "

The vector index properties for the table at the time the backup was created,\n including the index name, vector attribute, dimensions, distance function, search\n schema, and projection.

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

Contains the details of the features enabled on the table when the backup was created.\n For example, LSIs, GSIs, streams, TTL.

" + } + }, + "com.amazonaws.dynamodb#StreamArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 37, + "max": 1024 + } + } + }, + "com.amazonaws.dynamodb#StreamEnabled": { + "type": "boolean" + }, + "com.amazonaws.dynamodb#StreamSpecification": { + "type": "structure", + "members": { + "StreamEnabled": { + "target": "com.amazonaws.dynamodb#StreamEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the\n table.

", + "smithy.api#required": {} + } + }, + "StreamViewType": { + "target": "com.amazonaws.dynamodb#StreamViewType", + "traits": { + "smithy.api#documentation": "

When an item in the table is modified, StreamViewType determines what\n information is written to the stream for this table. Valid values for\n StreamViewType are:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the DynamoDB Streams configuration for a table in DynamoDB.

" + } + }, + "com.amazonaws.dynamodb#StreamViewType": { + "type": "enum", + "members": { + "NEW_IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW_IMAGE" + } + }, + "OLD_IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OLD_IMAGE" + } + }, + "NEW_AND_OLD_IMAGES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW_AND_OLD_IMAGES" + } + }, + "KEYS_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEYS_ONLY" + } + } + } + }, + "com.amazonaws.dynamodb#String": { + "type": "string" + }, + "com.amazonaws.dynamodb#StringAttributeValue": { + "type": "string" + }, + "com.amazonaws.dynamodb#StringSetAttributeValue": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#StringAttributeValue" + } + }, + "com.amazonaws.dynamodb#TableAlreadyExistsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

A target table with the specified name already exists.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#TableArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.dynamodb#TableAutoScalingDescription": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table.

" + } + }, + "TableStatus": { + "target": "com.amazonaws.dynamodb#TableStatus", + "traits": { + "smithy.api#documentation": "

The current state of the table:

\n " + } + }, + "Replicas": { + "target": "com.amazonaws.dynamodb#ReplicaAutoScalingDescriptionList", + "traits": { + "smithy.api#documentation": "

Represents replicas of the global table.

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

Represents the auto scaling configuration for a global table.

" + } + }, + "com.amazonaws.dynamodb#TableClass": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + }, + "STANDARD_INFREQUENT_ACCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD_INFREQUENT_ACCESS" + } + } + } + }, + "com.amazonaws.dynamodb#TableClassSummary": { + "type": "structure", + "members": { + "TableClass": { + "target": "com.amazonaws.dynamodb#TableClass", + "traits": { + "smithy.api#documentation": "

The table class of the specified table. Valid values are STANDARD and\n STANDARD_INFREQUENT_ACCESS.

" + } + }, + "LastUpdateDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

The date and time at which the table class was last updated.

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

Contains details of the table class.

" + } + }, + "com.amazonaws.dynamodb#TableCreationDateTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#TableCreationParameters": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table created as part of the import operation.

", + "smithy.api#required": {} + } + }, + "AttributeDefinitions": { + "target": "com.amazonaws.dynamodb#AttributeDefinitions", + "traits": { + "smithy.api#documentation": "

The attributes of the table created as part of the import operation.

", + "smithy.api#required": {} + } + }, + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", + "traits": { + "smithy.api#documentation": "

The primary key and option sort key of the table created as part of the import\n operation.

", + "smithy.api#required": {} + } + }, + "BillingMode": { + "target": "com.amazonaws.dynamodb#BillingMode", + "traits": { + "smithy.api#documentation": "

The billing mode for provisioning the table created as part of the import operation.\n

" + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput" + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput" + }, + "SSESpecification": { + "target": "com.amazonaws.dynamodb#SSESpecification" + }, + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

The Global Secondary Indexes (GSI) of the table to be created as part of the import\n operation.

" + } + }, + "VectorIndexes": { + "target": "com.amazonaws.dynamodb#VectorIndexList", + "traits": { + "smithy.api#documentation": "

The vector indexes of the table to be created as part of the import\n operation.

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

The parameters for the table created as part of the import operation.

" + } + }, + "com.amazonaws.dynamodb#TableDescription": { + "type": "structure", + "members": { + "AttributeDefinitions": { + "target": "com.amazonaws.dynamodb#AttributeDefinitions", + "traits": { + "smithy.api#documentation": "

An array of AttributeDefinition objects. Each of these objects describes\n one attribute in the table and index key schema.

\n

Each AttributeDefinition object in this array is composed of:

\n " + } + }, + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table.

" + } + }, + "KeySchema": { + "target": "com.amazonaws.dynamodb#KeySchema", + "traits": { + "smithy.api#documentation": "

The primary key structure for the table. Each KeySchemaElement consists\n of:

\n \n

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "TableStatus": { + "target": "com.amazonaws.dynamodb#TableStatus", + "traits": { + "smithy.api#documentation": "

The current state of the table:

\n " + } + }, + "CreationDateTime": { + "target": "com.amazonaws.dynamodb#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the table was created, in UNIX epoch time format.

" + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputDescription", + "traits": { + "smithy.api#documentation": "

The provisioned throughput settings for the table, consisting of read and write\n capacity units, along with data about increases and decreases.

" + } + }, + "TableSizeBytes": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

The total size of the specified table, in bytes. DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this\n value.

" + } + }, + "ItemCount": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

The number of items in the specified table. DynamoDB updates this value approximately\n every six hours. Recent changes might not be reflected in this value.

" + } + }, + "TableArn": { + "target": "com.amazonaws.dynamodb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the table.

" + } + }, + "TableId": { + "target": "com.amazonaws.dynamodb#TableId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the table, in UUID format, generated by DynamoDB when the\n table is created.

" + } + }, + "BillingModeSummary": { + "target": "com.amazonaws.dynamodb#BillingModeSummary", + "traits": { + "smithy.api#documentation": "

Contains the details for the read/write capacity mode.

" + } + }, + "LocalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#LocalSecondaryIndexDescriptionList", + "traits": { + "smithy.api#documentation": "

Represents one or more local secondary indexes on the table. Each index is scoped to a\n given partition key value. Tables with one or more local secondary indexes are subject\n to an item collection size limit, where the amount of data within a given item\n collection cannot exceed 10 GB. Each element is composed of:

\n \n

If the table is in the DELETING state, no information about indexes will\n be returned.

" + } + }, + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexDescriptionList", + "traits": { + "smithy.api#documentation": "

The global secondary indexes, if any, on the table. Each index is scoped to a given\n partition key value. Each element is composed of:

\n \n

If the table is in the DELETING state, no information about indexes will\n be returned.

" + } + }, + "StreamSpecification": { + "target": "com.amazonaws.dynamodb#StreamSpecification", + "traits": { + "smithy.api#documentation": "

The current DynamoDB Streams configuration for the table.

" + } + }, + "LatestStreamLabel": { + "target": "com.amazonaws.dynamodb#String", + "traits": { + "smithy.api#documentation": "

A timestamp, in ISO 8601 format, for this stream.

\n

Note that LatestStreamLabel is not a unique identifier for the stream,\n because it is possible that a stream from another table might have the same timestamp.\n However, the combination of the following three elements is guaranteed to be\n unique:

\n " + } + }, + "LatestStreamArn": { + "target": "com.amazonaws.dynamodb#StreamArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this\n table.

" + } + }, + "GlobalTableVersion": { + "target": "com.amazonaws.dynamodb#String", + "traits": { + "smithy.api#documentation": "

Represents the version of global tables\n in use, if the table is replicated across Amazon Web Services Regions.

" + } + }, + "Replicas": { + "target": "com.amazonaws.dynamodb#ReplicaDescriptionList", + "traits": { + "smithy.api#documentation": "

Represents replicas of the table.

" + } + }, + "GlobalTableWitnesses": { + "target": "com.amazonaws.dynamodb#GlobalTableWitnessDescriptionList", + "traits": { + "smithy.api#documentation": "

The witness Region and its current status in the MRSC global table. Only one witness\n Region can be configured per MRSC global table.

" + } + }, + "GlobalTableSettingsReplicationMode": { + "target": "com.amazonaws.dynamodb#GlobalTableSettingsReplicationMode", + "traits": { + "smithy.api#documentation": "

Indicates one of the settings synchronization modes for the global table:

\n " + } + }, + "RestoreSummary": { + "target": "com.amazonaws.dynamodb#RestoreSummary", + "traits": { + "smithy.api#documentation": "

Contains details for the restore.

" + } + }, + "SSEDescription": { + "target": "com.amazonaws.dynamodb#SSEDescription", + "traits": { + "smithy.api#documentation": "

The description of the server-side encryption status on the specified table.

" + } + }, + "ArchivalSummary": { + "target": "com.amazonaws.dynamodb#ArchivalSummary", + "traits": { + "smithy.api#documentation": "

Contains information about the table archive.

" + } + }, + "TableClassSummary": { + "target": "com.amazonaws.dynamodb#TableClassSummary", + "traits": { + "smithy.api#documentation": "

Contains details of the table class.

" + } + }, + "DeletionProtectionEnabled": { + "target": "com.amazonaws.dynamodb#DeletionProtectionEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether deletion protection is enabled (true) or disabled (false) on the\n table.

" + } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "

The maximum number of read and write units for the specified on-demand table. If you\n use this parameter, you must specify MaxReadRequestUnits,\n MaxWriteRequestUnits, or both.

" + } + }, + "WarmThroughput": { + "target": "com.amazonaws.dynamodb#TableWarmThroughputDescription", + "traits": { + "smithy.api#documentation": "

Describes the warm throughput value of the base table.

" + } + }, + "MultiRegionConsistency": { + "target": "com.amazonaws.dynamodb#MultiRegionConsistency", + "traits": { + "smithy.api#documentation": "

Indicates one of the following consistency modes for a global table:

\n \n

If you don't specify this field, the global table consistency mode defaults to\n EVENTUAL. For more information about global tables consistency modes,\n see \n Consistency modes in DynamoDB developer guide.

" + } + }, + "VectorIndexes": { + "target": "com.amazonaws.dynamodb#VectorIndexDescriptionList", + "traits": { + "smithy.api#documentation": "

The vector indexes, if any, on the table. Each element is composed of:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the properties of a table.

" + } + }, + "com.amazonaws.dynamodb#TableId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + } + }, + "com.amazonaws.dynamodb#TableInUseException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

A target table with the specified name is either being created or deleted.\n

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#TableName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" + } + }, + "com.amazonaws.dynamodb#TableNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#TableName" + } + }, + "com.amazonaws.dynamodb#TableNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

A source table with the name TableName does not currently exist within\n the subscriber's account or the subscriber is operating in the wrong Amazon Web Services\n Region.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#TableStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "INACCESSIBLE_ENCRYPTION_CREDENTIALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACCESSIBLE_ENCRYPTION_CREDENTIALS" + } + }, + "ARCHIVING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARCHIVING" + } + }, + "ARCHIVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARCHIVED" + } + }, + "REPLICATION_NOT_AUTHORIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPLICATION_NOT_AUTHORIZED" + } + } + } + }, + "com.amazonaws.dynamodb#TableWarmThroughputDescription": { + "type": "structure", + "members": { + "ReadUnitsPerSecond": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

Represents the base table's warm throughput value in read units per second.

" + } + }, + "WriteUnitsPerSecond": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

Represents the base table's warm throughput value in write units per second.

" + } + }, + "Status": { + "target": "com.amazonaws.dynamodb#TableStatus", + "traits": { + "smithy.api#documentation": "

Represents warm throughput value of the base table.

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

Represents the warm throughput value (in read units per second and write units per\n second) of the table. Warm throughput is applicable for DynamoDB Standard-IA tables and\n specifies the minimum provisioned capacity maintained for immediate data access.

" + } + }, + "com.amazonaws.dynamodb#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.dynamodb#TagKeyString", + "traits": { + "smithy.api#documentation": "

The key of the tag. Tag keys are case sensitive. Each DynamoDB table can\n only have up to one tag with the same key. If you try to add an existing tag (same key),\n the existing tag value will be updated to the new value.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.dynamodb#TagValueString", + "traits": { + "smithy.api#documentation": "

The value of the tag. Tag values are case-sensitive and can be null.

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

Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single\n DynamoDB table.

\n

Amazon Web Services-assigned tag names and values are automatically assigned the\n aws: prefix, which the user cannot assign. Amazon Web Services-assigned\n tag names do not count towards the tag limit of 50. User-assigned tag names have the\n prefix user: in the Cost Allocation Report. You cannot backdate the\n application of a tag.

\n

For an overview on tagging DynamoDB resources, see Tagging\n for DynamoDB in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "com.amazonaws.dynamodb#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#TagKeyString" + } + }, + "com.amazonaws.dynamodb#TagKeyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.dynamodb#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#Tag" + } + }, + "com.amazonaws.dynamodb#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#TagResourceInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Associate a set of tags with an Amazon DynamoDB resource. You can then activate these\n user-defined tags so that they appear on the Billing and Cost Management console for\n cost allocation tracking. You can call TagResource up to five times per second, per\n account.

\n \n

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.

" + } + }, + "com.amazonaws.dynamodb#TagResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.dynamodb#ResourceArnString", + "traits": { + "smithy.api#documentation": "

Identifies the Amazon DynamoDB resource to which tags should be added. This value is\n an Amazon Resource Name (ARN).

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "Tags": { + "target": "com.amazonaws.dynamodb#TagList", + "traits": { + "smithy.api#documentation": "

The tags to be assigned to the Amazon DynamoDB resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#TagValueString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.dynamodb#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#AvailabilityErrorMessage" + }, + "throttlingReasons": { + "target": "com.amazonaws.dynamodb#ThrottlingReasonList", + "traits": { + "smithy.api#documentation": "

A list of ThrottlingReason that\n provide detailed diagnostic information about why the request was throttled.\n

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "Throttling", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was denied due to request throttling. For detailed information about why\n the request was throttled and the ARN of the impacted resource, find the ThrottlingReason field in the returned exception.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.dynamodb#ThrottlingReason": { + "type": "structure", + "members": { + "reason": { + "target": "com.amazonaws.dynamodb#Reason", + "traits": { + "smithy.api#documentation": "

The reason for throttling. The throttling reason follows a specific format:\n ResourceType+OperationType+LimitType:

\n \n

Examples of complete throttling reasons:

\n \n

This helps identify exactly what resource is being throttled, what type of operation\n caused it, and why the throttling occurred.

" + } + }, + "resource": { + "target": "com.amazonaws.dynamodb#Resource", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the DynamoDB table or index that experienced the\n throttling event.

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

Represents the specific reason why a DynamoDB request was throttled and the\n ARN of the impacted resource. This helps identify exactly what resource is being throttled, \n what type of operation caused it, and why the throttling occurred.

" + } + }, + "com.amazonaws.dynamodb#ThrottlingReasonList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ThrottlingReason" + } + }, + "com.amazonaws.dynamodb#TimeRangeLowerBound": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#TimeRangeUpperBound": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#TimeToLiveAttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.dynamodb#TimeToLiveDescription": { + "type": "structure", + "members": { + "TimeToLiveStatus": { + "target": "com.amazonaws.dynamodb#TimeToLiveStatus", + "traits": { + "smithy.api#documentation": "

The TTL status for the table.

" + } + }, + "AttributeName": { + "target": "com.amazonaws.dynamodb#TimeToLiveAttributeName", + "traits": { + "smithy.api#documentation": "

The name of the TTL attribute for items in the table.

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

The description of the Time to Live (TTL) status on the specified table.

" + } + }, + "com.amazonaws.dynamodb#TimeToLiveEnabled": { + "type": "boolean" + }, + "com.amazonaws.dynamodb#TimeToLiveSpecification": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.dynamodb#TimeToLiveEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether TTL is to be enabled (true) or disabled (false) on the table.

", + "smithy.api#required": {} + } + }, + "AttributeName": { + "target": "com.amazonaws.dynamodb#TimeToLiveAttributeName", + "traits": { + "smithy.api#documentation": "

The name of the TTL attribute used to store the expiration time for items in the\n table.

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

Represents the settings used to enable or disable Time to Live (TTL) for the specified\n table.

" + } + }, + "com.amazonaws.dynamodb#TimeToLiveStatus": { + "type": "enum", + "members": { + "ENABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLING" + } + }, + "DISABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLING" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.dynamodb#TopKInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.dynamodb#TransactGetItem": { + "type": "structure", + "members": { + "Get": { + "target": "com.amazonaws.dynamodb#Get", + "traits": { + "smithy.api#documentation": "

Contains the primary key that identifies the item to get, together with the name of\n the table that contains the item, and optionally the specific attributes of the item to\n retrieve.

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

Specifies an item to be retrieved as part of the transaction.

" + } + }, + "com.amazonaws.dynamodb#TransactGetItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#TransactGetItem" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.dynamodb#TransactGetItems": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#TransactGetItemsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#TransactGetItemsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" + }, + { + "target": "com.amazonaws.dynamodb#TransactionCanceledException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

\n TransactGetItems is a synchronous operation that atomically retrieves\n multiple items from one or more tables (but not from indexes) in a single account and\n Region. A TransactGetItems call can contain up to 100\n TransactGetItem objects, each of which contains a Get\n structure that specifies an item to retrieve from a table in the account and Region. A\n call to TransactGetItems cannot retrieve items from tables in more than one\n Amazon Web Services account or Region. The aggregate size of the items in the\n transaction cannot exceed 4 MB.

\n

DynamoDB rejects the entire TransactGetItems request if any of\n the following is true:

\n ", + "smithy.rules#operationContextParams": { + "ResourceArnList": { + "path": "TransactItems[*].Get.TableName" + } + } + } + }, + "com.amazonaws.dynamodb#TransactGetItemsInput": { + "type": "structure", + "members": { + "TransactItems": { + "target": "com.amazonaws.dynamodb#TransactGetItemList", + "traits": { + "smithy.api#documentation": "

An ordered array of up to 100 TransactGetItem objects, each of which\n contains a Get structure.

", + "smithy.api#required": {} + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity", + "traits": { + "smithy.api#documentation": "

A value of TOTAL causes consumed capacity information to be returned, and\n a value of NONE prevents that information from being returned. No other\n value is valid.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#TransactGetItemsOutput": { + "type": "structure", + "members": { + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityMultiple", + "traits": { + "smithy.api#documentation": "

If the ReturnConsumedCapacity value was TOTAL, this\n is an array of ConsumedCapacity objects, one for each table addressed by\n TransactGetItem objects in the TransactItems\n parameter. These ConsumedCapacity objects report the read-capacity units\n consumed by the TransactGetItems call in that table.

" + } + }, + "Responses": { + "target": "com.amazonaws.dynamodb#ItemResponseList", + "traits": { + "smithy.api#documentation": "

An ordered array of up to 100 ItemResponse objects, each of which\n corresponds to the TransactGetItem object in the same position in the\n TransactItems array. Each ItemResponse object\n contains a Map of the name-value pairs that are the projected attributes of the\n requested item.

\n

If a requested item could not be retrieved, the corresponding\n ItemResponse object is Null, or if the requested item has no projected\n attributes, the corresponding ItemResponse object is an empty Map.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#TransactWriteItem": { + "type": "structure", + "members": { + "ConditionCheck": { + "target": "com.amazonaws.dynamodb#ConditionCheck", + "traits": { + "smithy.api#documentation": "

A request to perform a check item operation.

" + } + }, + "Put": { + "target": "com.amazonaws.dynamodb#Put", + "traits": { + "smithy.api#documentation": "

A request to perform a PutItem operation.

" + } + }, + "Delete": { + "target": "com.amazonaws.dynamodb#Delete", + "traits": { + "smithy.api#documentation": "

A request to perform a DeleteItem operation.

" + } + }, + "Update": { + "target": "com.amazonaws.dynamodb#Update", + "traits": { + "smithy.api#documentation": "

A request to perform an UpdateItem operation.

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

A list of requests that can perform update, put, delete, or check operations on\n multiple items in one or more tables atomically.

" + } + }, + "com.amazonaws.dynamodb#TransactWriteItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#TransactWriteItem" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.dynamodb#TransactWriteItems": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#TransactWriteItemsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#TransactWriteItemsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" + }, + { + "target": "com.amazonaws.dynamodb#TransactionCanceledException" + }, + { + "target": "com.amazonaws.dynamodb#TransactionInProgressException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

\n TransactWriteItems is a synchronous write operation that groups up to 100\n action requests. These actions can target items in different tables, but not in\n different Amazon Web Services accounts or Regions, and no two actions can target the same\n item. For example, you cannot both ConditionCheck and Update\n the same item. The aggregate size of the items in the transaction cannot exceed 4\n MB.

\n

The actions are completed atomically so that either all of them succeed, or all of\n them fail. They are defined by the following objects:

\n \n

DynamoDB rejects the entire TransactWriteItems request if any of the\n following is true:

\n ", + "smithy.rules#operationContextParams": { + "ResourceArnList": { + "path": "TransactItems[*].[ConditionCheck.TableName, Put.TableName, Delete.TableName, Update.TableName][]" + } + } + } + }, + "com.amazonaws.dynamodb#TransactWriteItemsInput": { + "type": "structure", + "members": { + "TransactItems": { + "target": "com.amazonaws.dynamodb#TransactWriteItemList", + "traits": { + "smithy.api#documentation": "

An ordered array of up to 100 TransactWriteItem objects, each of which\n contains a ConditionCheck, Put, Update, or\n Delete object. These can operate on items in different tables, but the\n tables must reside in the same Amazon Web Services account and Region, and no two of them\n can operate on the same item.

", + "smithy.api#required": {} + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + }, + "ReturnItemCollectionMetrics": { + "target": "com.amazonaws.dynamodb#ReturnItemCollectionMetrics", + "traits": { + "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to SIZE,\n the response includes statistics about item collections (if any), that were modified\n during the operation and are returned in the response. If set to NONE (the\n default), no statistics are returned.

" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.dynamodb#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

Providing a ClientRequestToken makes the call to\n TransactWriteItems idempotent, meaning that multiple identical calls\n have the same effect as one single call.

\n

Although multiple identical calls using the same client request token produce the same\n result on the server (no side effects), the responses to the calls might not be the\n same. If the ReturnConsumedCapacity parameter is set, then the initial\n TransactWriteItems call returns the amount of write capacity units\n consumed in making the changes. Subsequent TransactWriteItems calls with\n the same client token return the number of read capacity units consumed in reading the\n item.

\n

A client request token is valid for 10 minutes after the first request that uses it is\n completed. After 10 minutes, any request with the same client token is treated as a new\n request. Do not resubmit the same request with the same client token for more than 10\n minutes, or the result might not be idempotent.

\n

If you submit a request with the same client token but a change in other parameters\n within the 10-minute idempotency window, DynamoDB returns an\n IdempotentParameterMismatch exception.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#TransactWriteItemsOutput": { + "type": "structure", + "members": { + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityMultiple", + "traits": { + "smithy.api#documentation": "

The capacity units consumed by the entire TransactWriteItems operation.\n The values of the list are ordered according to the ordering of the\n TransactItems request parameter.

\n

If the table has vector indexes, each element also includes a\n VectorIndexes field with VectorWriteRequestBytes consumed\n for each affected vector index.

" + } + }, + "ItemCollectionMetrics": { + "target": "com.amazonaws.dynamodb#ItemCollectionMetricsPerTable", + "traits": { + "smithy.api#documentation": "

A list of tables that were processed by TransactWriteItems and, for each\n table, information about any item collections that were affected by individual\n UpdateItem, PutItem, or DeleteItem\n operations.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#TransactionCanceledException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + }, + "CancellationReasons": { + "target": "com.amazonaws.dynamodb#CancellationReasonList", + "traits": { + "smithy.api#documentation": "

A list of cancellation reasons.

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

The entire transaction request was canceled.

\n

DynamoDB cancels a TransactWriteItems request under the following\n circumstances:

\n \n

DynamoDB cancels a TransactGetItems request under the\n following circumstances:

\n \n \n

DynamoDB lists the cancellation reasons on the\n CancellationReasons property. Transaction cancellation reasons are ordered in the order of requested\n items, if an item has no error it will have None code and\n Null message. The None code is returned as the literal\n string \"None\", not a null or absent value; the message field is omitted\n entirely for an item that has no error. This is important to note when using an SDK\n that surfaces the code as an optional or nullable type.

\n \n

Cancellation reason codes and possible error messages:

\n ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#TransactionConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Operation was rejected because there is an ongoing transaction for the\n item.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#TransactionInProgressException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The transaction with the given request token is already in progress.

\n

Recommended Settings

\n \n

This is a general recommendation for handling the\n TransactionInProgressException. These settings help ensure that the\n client retries will trigger completion of the ongoing\n TransactWriteItems request.

\n \n \n

Assuming default retry policy, example timeout settings based on the guidelines\n above are as follows:

\n

Example timeline:

\n ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#UntagResourceInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Removes the association of tags from an Amazon DynamoDB resource. You can call\n UntagResource up to five times per second, per account.

\n \n

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.

" + } + }, + "com.amazonaws.dynamodb#UntagResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.dynamodb#ResourceArnString", + "traits": { + "smithy.api#documentation": "

The DynamoDB resource that the tags will be removed from. This value is an Amazon\n Resource Name (ARN).

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "TagKeys": { + "target": "com.amazonaws.dynamodb#TagKeyList", + "traits": { + "smithy.api#documentation": "

A list of tag keys. Existing tags of the resource whose keys are members of this list\n will be removed from the DynamoDB resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#Update": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

The primary key of the item to be updated. Each element consists of an attribute name\n and a value for that attribute.

", + "smithy.api#required": {} + } + }, + "UpdateExpression": { + "target": "com.amazonaws.dynamodb#UpdateExpression", + "traits": { + "smithy.api#documentation": "

An expression that defines one or more attributes to be updated, the action to be\n performed on them, and new value(s) for them.

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

Name of the table for the UpdateItem request. You can also provide the\n Amazon Resource Name (ARN) of the table in this parameter.

", + "smithy.api#required": {} + } + }, + "ConditionExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", + "traits": { + "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional update to\n succeed.

" + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression.

" + } + }, + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "traits": { + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

" + } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the\n Update condition fails. For\n ReturnValuesOnConditionCheckFailure, the valid values are: NONE and\n ALL_OLD.

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

Represents a request to perform an UpdateItem operation.

" + } + }, + "com.amazonaws.dynamodb#UpdateContinuousBackups": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#UpdateContinuousBackupsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#UpdateContinuousBackupsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#ContinuousBackupsUnavailableException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#TableNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

\n UpdateContinuousBackups enables or disables point in time recovery for\n the specified table. A successful UpdateContinuousBackups call returns the\n current ContinuousBackupsDescription. Continuous backups are\n ENABLED on all tables at table creation. If point in time recovery is\n enabled, PointInTimeRecoveryStatus will be set to ENABLED.

\n

Once continuous backups and point in time recovery are enabled, you can restore to\n any point in time within EarliestRestorableDateTime and\n LatestRestorableDateTime.

\n

\n LatestRestorableDateTime is typically 5 minutes before the current time.\n You can restore your table to any point in time in the last 35 days. You can set the\n RecoveryPeriodInDays to any value between 1 and 35 days.

" + } + }, + "com.amazonaws.dynamodb#UpdateContinuousBackupsInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this\n parameter.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "PointInTimeRecoverySpecification": { + "target": "com.amazonaws.dynamodb#PointInTimeRecoverySpecification", + "traits": { + "smithy.api#documentation": "

Represents the settings used to enable point in time recovery.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#UpdateContinuousBackupsOutput": { + "type": "structure", + "members": { + "ContinuousBackupsDescription": { + "target": "com.amazonaws.dynamodb#ContinuousBackupsDescription", + "traits": { + "smithy.api#documentation": "

Represents the continuous backups and point in time recovery settings on the\n table.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#UpdateContributorInsights": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#UpdateContributorInsightsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#UpdateContributorInsightsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the status for contributor insights for a specific table or index. CloudWatch\n Contributor Insights for DynamoDB graphs display the partition key and (if applicable)\n sort key of frequently accessed items and frequently throttled items in plaintext. If\n you require the use of Amazon Web Services Key Management Service (KMS) to encrypt this\n table’s partition key and sort key data with an Amazon Web Services managed key or\n customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB\n for this table.

" + } + }, + "com.amazonaws.dynamodb#UpdateContributorInsightsInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this\n parameter.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The global secondary index name, if applicable.

" + } + }, + "ContributorInsightsAction": { + "target": "com.amazonaws.dynamodb#ContributorInsightsAction", + "traits": { + "smithy.api#documentation": "

Represents the contributor insights action.

", + "smithy.api#required": {} + } + }, + "ContributorInsightsMode": { + "target": "com.amazonaws.dynamodb#ContributorInsightsMode", + "traits": { + "smithy.api#documentation": "

Specifies whether to track all access and throttled events or throttled events only for\n the DynamoDB table or index.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#UpdateContributorInsightsOutput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the table.

" + } + }, + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index, if applicable.

" + } + }, + "ContributorInsightsStatus": { + "target": "com.amazonaws.dynamodb#ContributorInsightsStatus", + "traits": { + "smithy.api#documentation": "

The status of contributor insights

" + } + }, + "ContributorInsightsMode": { + "target": "com.amazonaws.dynamodb#ContributorInsightsMode", + "traits": { + "smithy.api#documentation": "

The updated mode of CloudWatch Contributor Insights that determines whether to monitor\n all access and throttled events or to track throttled events exclusively.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#UpdateExpression": { + "type": "string" + }, + "com.amazonaws.dynamodb#UpdateGlobalSecondaryIndexAction": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the global secondary index to be updated.

", + "smithy.api#required": {} + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "traits": { + "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary\n index.

\n

For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "

Updates the maximum number of read and write units for the specified global secondary\n index. If you use this parameter, you must specify MaxReadRequestUnits,\n MaxWriteRequestUnits, or both.

" + } + }, + "WarmThroughput": { + "target": "com.amazonaws.dynamodb#WarmThroughput", + "traits": { + "smithy.api#documentation": "

Represents the warm throughput value of the new provisioned throughput settings to be\n applied to a global secondary index.

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

Represents the new provisioned throughput settings to be applied to a global secondary\n index.

" + } + }, + "com.amazonaws.dynamodb#UpdateGlobalTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#UpdateGlobalTableInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#UpdateGlobalTableOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#GlobalTableNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ReplicaAlreadyExistsException" + }, + { + "target": "com.amazonaws.dynamodb#ReplicaNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#TableNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Adds or removes replicas in the specified global table. The global table must already\n exist to be able to use this operation. Any replica to be added must be empty, have the\n same name as the global table, have the same key schema, have DynamoDB Streams enabled,\n and have the same provisioned and maximum write capacity units.

\n \n

This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

\n

To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

\n \n \n

If you are using global tables Version\n 2019.11.21 (Current) you can use UpdateTable instead.

\n

Although you can use UpdateGlobalTable to add replicas and remove\n replicas in a single request, for simplicity we recommend that you issue separate\n requests for adding or removing replicas.

\n \n

If global secondary indexes are specified, then the following conditions must also be\n met:

\n " + } + }, + "com.amazonaws.dynamodb#UpdateGlobalTableInput": { + "type": "structure", + "members": { + "GlobalTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The global table name.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "ReplicaUpdates": { + "target": "com.amazonaws.dynamodb#ReplicaUpdateList", + "traits": { + "smithy.api#documentation": "

A list of Regions that should be added or removed from the global table.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#UpdateGlobalTableOutput": { + "type": "structure", + "members": { + "GlobalTableDescription": { + "target": "com.amazonaws.dynamodb#GlobalTableDescription", + "traits": { + "smithy.api#documentation": "

Contains the details of the global table.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#UpdateGlobalTableSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#UpdateGlobalTableSettingsInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#UpdateGlobalTableSettingsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#GlobalTableNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#IndexNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ReplicaNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Updates settings for a global table.

\n \n

This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

\n

To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

\n " + } + }, + "com.amazonaws.dynamodb#UpdateGlobalTableSettingsInput": { + "type": "structure", + "members": { + "GlobalTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the global table

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "GlobalTableBillingMode": { + "target": "com.amazonaws.dynamodb#BillingMode", + "traits": { + "smithy.api#documentation": "

The billing mode of the global table. If GlobalTableBillingMode is not\n specified, the global table defaults to PROVISIONED capacity billing\n mode.

\n " + } + }, + "GlobalTableProvisionedWriteCapacityUnits": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException.\n

" + } + }, + "GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate", + "traits": { + "smithy.api#documentation": "

Auto scaling settings for managing provisioned write capacity for the global\n table.

" + } + }, + "GlobalTableGlobalSecondaryIndexSettingsUpdate": { + "target": "com.amazonaws.dynamodb#GlobalTableGlobalSecondaryIndexSettingsUpdateList", + "traits": { + "smithy.api#documentation": "

Represents the settings of a global secondary index for a global table that will be\n modified.

" + } + }, + "ReplicaSettingsUpdate": { + "target": "com.amazonaws.dynamodb#ReplicaSettingsUpdateList", + "traits": { + "smithy.api#documentation": "

Represents the settings for a global table in a Region that will be modified.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#UpdateGlobalTableSettingsOutput": { + "type": "structure", + "members": { + "GlobalTableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The name of the global table.

" + } + }, + "ReplicaSettings": { + "target": "com.amazonaws.dynamodb#ReplicaSettingsDescriptionList", + "traits": { + "smithy.api#documentation": "

The Region-specific settings for the global table.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#UpdateItem": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#UpdateItemInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#UpdateItemOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#ConditionalCheckFailedException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#ItemCollectionSizeLimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ReplicatedWriteConflictException" + }, + { + "target": "com.amazonaws.dynamodb#RequestLimitExceeded" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#ThrottlingException" + }, + { + "target": "com.amazonaws.dynamodb#TransactionConflictException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Edits an existing item's attributes, or adds a new item to the table if it does not\n already exist. You can put, delete, or add attribute values. You can also perform a\n conditional update on an existing item (insert a new attribute name-value pair if it\n doesn't exist, or replace an existing name-value pair if it has certain expected\n attribute values).

\n

You can also return the item's attribute values in the same UpdateItem\n operation using the ReturnValues parameter.

", + "smithy.api#examples": [ + { + "title": "To update an item in a table", + "documentation": "This example updates an item in the Music table. It adds a new attribute (Year) and modifies the AlbumTitle attribute. All of the attributes in the item, as they appear after the update, are returned in the response.", + "input": { + "TableName": "Music", + "Key": { + "Artist": { + "S": "Acme Band" + }, + "SongTitle": { + "S": "Happy Day" + } + }, + "UpdateExpression": "SET #Y = :y, #AT = :t", + "ExpressionAttributeNames": { + "#Y": "Year", + "#AT": "AlbumTitle" + }, + "ExpressionAttributeValues": { + ":y": { + "N": "2015" + }, + ":t": { + "S": "Louder Than Ever" + } + }, + "ReturnValues": "ALL_NEW" + }, + "output": { + "Attributes": { + "AlbumTitle": { + "S": "Louder Than Ever" + }, + "Artist": { + "S": "Acme Band" + }, + "Year": { + "N": "2015" + }, + "SongTitle": { + "S": "Happy Day" + } + } + } + } + ] + } + }, + "com.amazonaws.dynamodb#UpdateItemInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table containing the item to update. You can also provide the\n Amazon Resource Name (ARN) of the table in this parameter.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "Key": { + "target": "com.amazonaws.dynamodb#Key", + "traits": { + "smithy.api#documentation": "

The primary key of the item to be updated. Each element consists of an attribute name\n and a value for that attribute.

\n

For the primary key, you must provide all of the attributes. For example, with a\n simple primary key, you only need to provide a value for the partition key. For a\n composite primary key, you must provide values for both the partition key and the sort\n key.

", + "smithy.api#required": {} + } + }, + "AttributeUpdates": { + "target": "com.amazonaws.dynamodb#AttributeUpdates", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use UpdateExpression instead. For more\n information, see AttributeUpdates in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "Expected": { + "target": "com.amazonaws.dynamodb#ExpectedAttributeMap", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more\n information, see Expected in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ConditionalOperator": { + "target": "com.amazonaws.dynamodb#ConditionalOperator", + "traits": { + "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more\n information, see ConditionalOperator in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ReturnValues": { + "target": "com.amazonaws.dynamodb#ReturnValue", + "traits": { + "smithy.api#documentation": "

Use ReturnValues if you want to get the item attributes as they appear\n before or after they are successfully updated. For UpdateItem, the valid\n values are:

\n \n

There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

\n

The values returned are strongly consistent.

" + } + }, + "ReturnConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity" + }, + "ReturnItemCollectionMetrics": { + "target": "com.amazonaws.dynamodb#ReturnItemCollectionMetrics", + "traits": { + "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to SIZE,\n the response includes statistics about item collections, if any, that were modified\n during the operation are returned in the response. If set to NONE (the\n default), no statistics are returned.

" + } + }, + "UpdateExpression": { + "target": "com.amazonaws.dynamodb#UpdateExpression", + "traits": { + "smithy.api#documentation": "

An expression that defines one or more attributes to be updated, the action to be\n performed on them, and new values for them.

\n

The following action values are available for UpdateExpression.

\n \n

You can have many actions in a single expression, such as the following: SET\n a=:value1, b=:value2 DELETE :value3, :value4, :value5\n

\n

For more information on update expressions, see Modifying\n Items and Attributes in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ConditionExpression": { + "target": "com.amazonaws.dynamodb#ConditionExpression", + "traits": { + "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional update to\n succeed.

\n

An expression can contain any of the following:

\n \n

For more information about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ExpressionAttributeNames": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", + "traits": { + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide.) To work around this, you could specify the following for\n ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.

\n \n

For more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ExpressionAttributeValues": { + "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", + "traits": { + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as\n follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},\n \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "ReturnValuesOnConditionCheckFailure": { + "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", + "traits": { + "smithy.api#documentation": "

An optional parameter that returns the item attributes for an UpdateItem\n operation that failed a condition check.

\n

There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

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

Represents the input of an UpdateItem operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#UpdateItemOutput": { + "type": "structure", + "members": { + "Attributes": { + "target": "com.amazonaws.dynamodb#AttributeMap", + "traits": { + "smithy.api#documentation": "

A map of attribute values as they appear before or after the UpdateItem\n operation, as determined by the ReturnValues parameter.

\n

The Attributes map is only present if the update was successful and\n ReturnValues was specified as something other than NONE in\n the request. Each element represents one attribute.

" + } + }, + "ConsumedCapacity": { + "target": "com.amazonaws.dynamodb#ConsumedCapacity", + "traits": { + "smithy.api#documentation": "

The capacity units consumed by the UpdateItem operation. The data\n returned includes the total provisioned throughput consumed, along with statistics for\n the table and any indexes involved in the operation. ConsumedCapacity is\n only returned if the ReturnConsumedCapacity parameter was specified. For\n more information, see Capacity unity consumption for write operations in the Amazon\n DynamoDB Developer Guide.

\n

If the table has vector indexes, the response includes a\n VectorIndexes field with VectorWriteRequestBytes consumed\n for each affected vector index.

" + } + }, + "ItemCollectionMetrics": { + "target": "com.amazonaws.dynamodb#ItemCollectionMetrics", + "traits": { + "smithy.api#documentation": "

Information about item collections, if any, that were affected by the\n UpdateItem operation. ItemCollectionMetrics is only\n returned if the ReturnItemCollectionMetrics parameter was specified. If the\n table does not have any local secondary indexes, this information is not returned in the\n response.

\n

Each ItemCollectionMetrics element consists of:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the output of an UpdateItem operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#UpdateKinesisStreamingConfiguration": { + "type": "structure", + "members": { + "ApproximateCreationDateTimePrecision": { + "target": "com.amazonaws.dynamodb#ApproximateCreationDateTimePrecision", + "traits": { + "smithy.api#documentation": "

Enables updating the precision of Kinesis data stream timestamp.

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

Enables updating the configuration for Kinesis Streaming.

" + } + }, + "com.amazonaws.dynamodb#UpdateKinesisStreamingDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#UpdateKinesisStreamingDestinationInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#UpdateKinesisStreamingDestinationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

The command to update the Kinesis stream destination.

" + } + }, + "com.amazonaws.dynamodb#UpdateKinesisStreamingDestinationInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The table name for the Kinesis streaming destination input. You can also provide the\n ARN of the table in this parameter.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "StreamArn": { + "target": "com.amazonaws.dynamodb#StreamArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the Kinesis stream input.

", + "smithy.api#required": {} + } + }, + "UpdateKinesisStreamingConfiguration": { + "target": "com.amazonaws.dynamodb#UpdateKinesisStreamingConfiguration", + "traits": { + "smithy.api#documentation": "

The command to update the Kinesis stream configuration.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#UpdateKinesisStreamingDestinationOutput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableName", + "traits": { + "smithy.api#documentation": "

The table name for the Kinesis streaming destination output.

" + } + }, + "StreamArn": { + "target": "com.amazonaws.dynamodb#StreamArn", + "traits": { + "smithy.api#documentation": "

The ARN for the Kinesis stream input.

" + } + }, + "DestinationStatus": { + "target": "com.amazonaws.dynamodb#DestinationStatus", + "traits": { + "smithy.api#documentation": "

The status of the attempt to update the Kinesis streaming destination output.

" + } + }, + "UpdateKinesisStreamingConfiguration": { + "target": "com.amazonaws.dynamodb#UpdateKinesisStreamingConfiguration", + "traits": { + "smithy.api#documentation": "

The command to update the Kinesis streaming destination configuration.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#UpdateReplicationGroupMemberAction": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.dynamodb#RegionName", + "traits": { + "smithy.api#documentation": "

The Region where the replica exists.

", + "smithy.api#required": {} + } + }, + "KMSMasterKeyId": { + "target": "com.amazonaws.dynamodb#KMSMasterKeyId", + "traits": { + "smithy.api#documentation": "

The KMS key of the replica that should be used for KMS\n encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or\n alias ARN. Note that you should only provide this parameter if the key is different from\n the default DynamoDB KMS key alias/aws/dynamodb.

" + } + }, + "ProvisionedThroughputOverride": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughputOverride", + "traits": { + "smithy.api#documentation": "

Replica-specific provisioned throughput. If not specified, uses the source table's\n provisioned throughput settings.

" + } + }, + "OnDemandThroughputOverride": { + "target": "com.amazonaws.dynamodb#OnDemandThroughputOverride", + "traits": { + "smithy.api#documentation": "

Overrides the maximum on-demand throughput for the replica table.

" + } + }, + "GlobalSecondaryIndexes": { + "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexList", + "traits": { + "smithy.api#documentation": "

Replica-specific global secondary index settings.

" + } + }, + "TableClassOverride": { + "target": "com.amazonaws.dynamodb#TableClass", + "traits": { + "smithy.api#documentation": "

Replica-specific table class. If not specified, uses the source table's table\n class.

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

Represents a replica to be modified.

" + } + }, + "com.amazonaws.dynamodb#UpdateTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#UpdateTableInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#UpdateTableOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB\n Streams settings for a given table.

\n

You can only perform one of the following operations at once:

\n \n

\n UpdateTable is an asynchronous operation; while it's executing, the table\n status changes from ACTIVE to UPDATING. While it's\n UPDATING, you can't issue another UpdateTable request.\n When the table returns to the ACTIVE state, the UpdateTable\n operation is complete.

" + } + }, + "com.amazonaws.dynamodb#UpdateTableInput": { + "type": "structure", + "members": { + "AttributeDefinitions": { + "target": "com.amazonaws.dynamodb#AttributeDefinitions", + "traits": { + "smithy.api#documentation": "

An array of attributes that describe the key schema for the table and indexes. If you\n are adding a new global secondary index to the table, AttributeDefinitions\n must include the key element(s) of the new index.

" + } + }, + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table\n in this parameter.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "BillingMode": { + "target": "com.amazonaws.dynamodb#BillingMode", + "traits": { + "smithy.api#documentation": "

Controls how you are charged for read and write throughput and how you manage\n capacity. When switching from pay-per-request to provisioned capacity, initial\n provisioned capacity values must be set. The initial provisioned capacity values are\n estimated based on the consumed read and write capacity of your table and global\n secondary indexes over the past 30 minutes.

\n " + } + }, + "ProvisionedThroughput": { + "target": "com.amazonaws.dynamodb#ProvisionedThroughput", + "traits": { + "smithy.api#documentation": "

The new provisioned throughput settings for the specified table or index.

" + } + }, + "GlobalSecondaryIndexUpdates": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexUpdateList", + "traits": { + "smithy.api#documentation": "

An array of one or more global secondary indexes for the table. For each index in the\n array, you can request one action:

\n \n

You can create or delete only one global secondary index per UpdateTable\n operation.

\n

For more information, see Managing Global\n Secondary Indexes in the Amazon DynamoDB Developer\n Guide.

" + } + }, + "StreamSpecification": { + "target": "com.amazonaws.dynamodb#StreamSpecification", + "traits": { + "smithy.api#documentation": "

Represents the DynamoDB Streams configuration for the table.

\n \n

You receive a ValidationException if you try to enable a stream on a\n table that already has a stream, or if you try to disable a stream on a table that\n doesn't have a stream.

\n " + } + }, + "SSESpecification": { + "target": "com.amazonaws.dynamodb#SSESpecification", + "traits": { + "smithy.api#documentation": "

The new server-side encryption settings for the specified table.

" + } + }, + "ReplicaUpdates": { + "target": "com.amazonaws.dynamodb#ReplicationGroupUpdateList", + "traits": { + "smithy.api#documentation": "

A list of replica update actions (create, delete, or update) for the table.

" + } + }, + "TableClass": { + "target": "com.amazonaws.dynamodb#TableClass", + "traits": { + "smithy.api#documentation": "

The table class of the table to be updated. Valid values are STANDARD and\n STANDARD_INFREQUENT_ACCESS.

" + } + }, + "DeletionProtectionEnabled": { + "target": "com.amazonaws.dynamodb#DeletionProtectionEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether deletion protection is to be enabled (true) or disabled (false) on\n the table.

" + } + }, + "MultiRegionConsistency": { + "target": "com.amazonaws.dynamodb#MultiRegionConsistency", + "traits": { + "smithy.api#documentation": "

Specifies the consistency mode for a new global table. This parameter is only valid\n when you create a global table by specifying one or more Create actions in the ReplicaUpdates action list.

\n

You can specify one of the following consistency modes:

\n \n

If you don't specify this field, the global table consistency mode defaults to\n EVENTUAL. For more information about global tables consistency modes,\n see \n Consistency modes in DynamoDB developer guide.

" + } + }, + "GlobalTableWitnessUpdates": { + "target": "com.amazonaws.dynamodb#GlobalTableWitnessGroupUpdateList", + "traits": { + "smithy.api#documentation": "

A list of witness updates for a MRSC global table. A witness provides a cost-effective\n alternative to a full replica in a MRSC global table by maintaining replicated change\n data written to global table replicas. You cannot perform read or write operations on a\n witness. For each witness, you can request one action:

\n \n

You can create or delete only one witness per UpdateTable\n operation.

\n

For more information, see Multi-Region strong consistency (MRSC) in the Amazon DynamoDB\n Developer Guide

" + } + }, + "OnDemandThroughput": { + "target": "com.amazonaws.dynamodb#OnDemandThroughput", + "traits": { + "smithy.api#documentation": "

Updates the maximum number of read and write units for the specified table in\n on-demand capacity mode. If you use this parameter, you must specify\n MaxReadRequestUnits, MaxWriteRequestUnits, or both.

" + } + }, + "WarmThroughput": { + "target": "com.amazonaws.dynamodb#WarmThroughput", + "traits": { + "smithy.api#documentation": "

Represents the warm throughput (in read units per second and write units per second)\n for updating a table.

" + } + }, + "GlobalTableSettingsReplicationMode": { + "target": "com.amazonaws.dynamodb#GlobalTableSettingsReplicationMode", + "traits": { + "smithy.api#documentation": "

Controls the settings replication mode for a global table replica. This attribute can be defined\n using UpdateTable operation only on a regional table with values:

\n " + } + }, + "VectorIndexUpdates": { + "target": "com.amazonaws.dynamodb#VectorIndexUpdateList", + "traits": { + "smithy.api#documentation": "

A list of vector indexes to be added to or removed from the table. You can add or\n remove one vector index for each UpdateTable operation.

\n

To add a vector index, specify IndexName,\n VectorAttribute, Dimensions,\n DistanceFunction, and Projection. To remove a vector\n index, specify only the IndexName.

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

Represents the input of an UpdateTable operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#UpdateTableOutput": { + "type": "structure", + "members": { + "TableDescription": { + "target": "com.amazonaws.dynamodb#TableDescription", + "traits": { + "smithy.api#documentation": "

Represents the properties of the table.

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

Represents the output of an UpdateTable operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#UpdateTableReplicaAutoScaling": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#UpdateTableReplicaAutoScalingInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#UpdateTableReplicaAutoScalingOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates auto scaling settings on your global tables at once.

" + } + }, + "com.amazonaws.dynamodb#UpdateTableReplicaAutoScalingInput": { + "type": "structure", + "members": { + "GlobalSecondaryIndexUpdates": { + "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexAutoScalingUpdateList", + "traits": { + "smithy.api#documentation": "

Represents the auto scaling settings of the global secondary indexes of the replica to\n be updated.

" + } + }, + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the global table to be updated. You can also provide the Amazon Resource Name (ARN) of the\n table in this parameter.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "ProvisionedWriteCapacityAutoScalingUpdate": { + "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate" + }, + "ReplicaUpdates": { + "target": "com.amazonaws.dynamodb#ReplicaAutoScalingUpdateList", + "traits": { + "smithy.api#documentation": "

Represents the auto scaling settings of replicas of the table that will be\n modified.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#UpdateTableReplicaAutoScalingOutput": { + "type": "structure", + "members": { + "TableAutoScalingDescription": { + "target": "com.amazonaws.dynamodb#TableAutoScalingDescription", + "traits": { + "smithy.api#documentation": "

Returns information about the auto scaling settings of a table with replicas.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#UpdateTimeToLive": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#UpdateTimeToLiveInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#UpdateTimeToLiveOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceInUseException" + }, + { + "target": "com.amazonaws.dynamodb#ResourceNotFoundException" + } + ], + "traits": { + "aws.api#clientDiscoveredEndpoint": { + "required": false + }, + "smithy.api#documentation": "

The UpdateTimeToLive method enables or disables Time to Live (TTL) for\n the specified table. A successful UpdateTimeToLive call returns the current\n TimeToLiveSpecification. It can take up to one hour for the change to\n fully process. Any additional UpdateTimeToLive calls for the same table\n during this one hour duration result in a ValidationException.

\n

TTL compares the current time in epoch time format to the time stored in the TTL\n attribute of an item. If the epoch time value stored in the attribute is less than the\n current time, the item is marked as expired and subsequently deleted.

\n \n

The epoch time format is the number of seconds elapsed since 12:00:00 AM January\n 1, 1970 UTC.

\n \n

DynamoDB deletes expired items on a best-effort basis to ensure availability of\n throughput for other data operations.

\n \n

DynamoDB typically deletes expired items within two days of expiration. The exact\n duration within which an item gets deleted after expiration is specific to the\n nature of the workload. Items that have expired and not been deleted will still show\n up in reads, queries, and scans.

\n \n

As items are deleted, they are removed from any local secondary index and global\n secondary index immediately in the same eventually consistent way as a standard delete\n operation.

\n

For more information, see Time To Live in the\n Amazon DynamoDB Developer Guide.

" + } + }, + "com.amazonaws.dynamodb#UpdateTimeToLiveInput": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "

The name of the table to be configured. You can also provide the Amazon Resource Name (ARN) of the\n table in this parameter.

", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceArn" + } + } + }, + "TimeToLiveSpecification": { + "target": "com.amazonaws.dynamodb#TimeToLiveSpecification", + "traits": { + "smithy.api#documentation": "

Represents the settings used to enable or disable Time to Live for the specified\n table.

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

Represents the input of an UpdateTimeToLive operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.dynamodb#UpdateTimeToLiveOutput": { + "type": "structure", + "members": { + "TimeToLiveSpecification": { + "target": "com.amazonaws.dynamodb#TimeToLiveSpecification", + "traits": { + "smithy.api#documentation": "

Represents the output of an UpdateTimeToLive operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dynamodb#VectorAttributeDefinition": { + "type": "structure", + "members": { + "AttributeName": { + "target": "com.amazonaws.dynamodb#VectorAttributeName", + "traits": { + "smithy.api#documentation": "

The name of the vector attribute.

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

The definition of a vector attribute for a vector index.

" + } + }, + "com.amazonaws.dynamodb#VectorAttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.dynamodb#VectorCapacity": { + "type": "structure", + "members": { + "VectorSearchRequestBytes": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityUnits", + "traits": { + "smithy.api#documentation": "

The number of vector search request bytes consumed by a\n SearchVectors operation.

" + } + }, + "VectorWriteRequestBytes": { + "target": "com.amazonaws.dynamodb#ConsumedCapacityUnits", + "traits": { + "smithy.api#documentation": "

The number of vector write request bytes consumed when writing to a vector index.\n Reported for write operations that modify attributes indexed by a vector\n index.

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

The consumed capacity for vector index operations, including vector search request bytes\n and vector write request bytes.

" + } + }, + "com.amazonaws.dynamodb#VectorDistanceFunction": { + "type": "enum", + "members": { + "COSINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COSINE" + } + }, + "DOT_PRODUCT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOT_PRODUCT" + } + }, + "EUCLIDEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EUCLIDEAN" + } + } + } + }, + "com.amazonaws.dynamodb#VectorIndex": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the vector index.

", + "smithy.api#required": {} + } + }, + "VectorAttribute": { + "target": "com.amazonaws.dynamodb#VectorAttributeDefinition", + "traits": { + "smithy.api#documentation": "

The vector attribute configuration for the index.

", + "smithy.api#required": {} + } + }, + "SearchSchema": { + "target": "com.amazonaws.dynamodb#SearchSchema", + "traits": { + "smithy.api#documentation": "

The search schema that defines partition key and inline filter attributes for\n the vector index.

" + } + }, + "Projection": { + "target": "com.amazonaws.dynamodb#Projection", + "traits": { + "smithy.api#documentation": "

Specifies attributes that are copied (projected) from the table into the vector\n index.

", + "smithy.api#required": {} + } + }, + "Dimensions": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The number of dimensions in each vector.

", + "smithy.api#required": {} + } + }, + "DistanceFunction": { + "target": "com.amazonaws.dynamodb#VectorDistanceFunction", + "traits": { + "smithy.api#documentation": "

The distance function used to calculate similarity between vectors. Valid values:\n COSINE, EUCLIDEAN, DOT_PRODUCT.

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

Contains the configuration settings for a vector index, including the index name,\n vector attribute, dimensions, distance function, search schema, and\n projection.

" + } + }, + "com.amazonaws.dynamodb#VectorIndexDescription": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the vector index.

" + } + }, + "SearchSchema": { + "target": "com.amazonaws.dynamodb#SearchSchema", + "traits": { + "smithy.api#documentation": "

The search schema that defines partition key and inline filter attributes for\n the vector index.

" + } + }, + "Projection": { + "target": "com.amazonaws.dynamodb#Projection", + "traits": { + "smithy.api#documentation": "

Specifies attributes that are copied (projected) from the table into the vector\n index.

" + } + }, + "VectorAttribute": { + "target": "com.amazonaws.dynamodb#VectorAttributeDefinition", + "traits": { + "smithy.api#documentation": "

The vector attribute configuration for the index.

" + } + }, + "Dimensions": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The number of dimensions in each vector.

" + } + }, + "DistanceFunction": { + "target": "com.amazonaws.dynamodb#VectorDistanceFunction", + "traits": { + "smithy.api#documentation": "

The distance function used to calculate similarity between vectors.

" + } + }, + "IndexStatus": { + "target": "com.amazonaws.dynamodb#IndexStatus", + "traits": { + "smithy.api#documentation": "

The current state of the vector index:

\n " + } + }, + "Backfilling": { + "target": "com.amazonaws.dynamodb#Backfilling", + "traits": { + "smithy.api#documentation": "

Specifies whether the index is currently backfilling. During backfill,\n SearchVectors operations might return incomplete results.

" + } + }, + "IndexSizeBytes": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

The total size of the vector index, in bytes. Amazon DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this\n value.

" + } + }, + "ItemCount": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

The number of items indexed in the vector index. Amazon DynamoDB updates this\n value approximately every six hours. Recent changes might not be reflected in\n this value.

" + } + }, + "IndexArn": { + "target": "com.amazonaws.dynamodb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the vector index.

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

Contains the current state and configuration of a vector index, including its\n status, size, item count, and the settings specified when the index was\n created.

" + } + }, + "com.amazonaws.dynamodb#VectorIndexDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#VectorIndexDescription" + } + }, + "com.amazonaws.dynamodb#VectorIndexInfo": { + "type": "structure", + "members": { + "IndexName": { + "target": "com.amazonaws.dynamodb#IndexName", + "traits": { + "smithy.api#documentation": "

The name of the vector index.

" + } + }, + "VectorAttribute": { + "target": "com.amazonaws.dynamodb#VectorAttributeDefinition", + "traits": { + "smithy.api#documentation": "

The vector attribute configuration for the index.

" + } + }, + "SearchSchema": { + "target": "com.amazonaws.dynamodb#SearchSchema", + "traits": { + "smithy.api#documentation": "

The search schema that defines partition key and inline filter attributes for\n the vector index.

" + } + }, + "Projection": { + "target": "com.amazonaws.dynamodb#Projection", + "traits": { + "smithy.api#documentation": "

Specifies attributes that are copied (projected) from the table into the vector\n index.

" + } + }, + "Dimensions": { + "target": "com.amazonaws.dynamodb#PositiveLongObject", + "traits": { + "smithy.api#documentation": "

The number of dimensions in each vector.

" + } + }, + "DistanceFunction": { + "target": "com.amazonaws.dynamodb#VectorDistanceFunction", + "traits": { + "smithy.api#documentation": "

The distance function used to calculate similarity between vectors.

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

Contains the configuration of a vector index as it existed at the time a backup\n was created.

" + } + }, + "com.amazonaws.dynamodb#VectorIndexList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#VectorIndex" + } + }, + "com.amazonaws.dynamodb#VectorIndexUpdate": { + "type": "structure", + "members": { + "Create": { + "target": "com.amazonaws.dynamodb#CreateVectorIndexAction", + "traits": { + "smithy.api#documentation": "

The configuration for creating a new vector index on the table.

" + } + }, + "Delete": { + "target": "com.amazonaws.dynamodb#DeleteVectorIndexAction", + "traits": { + "smithy.api#documentation": "

The configuration for deleting an existing vector index from the table.

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

A vector index to be added to or removed from a table.

" + } + }, + "com.amazonaws.dynamodb#VectorIndexUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#VectorIndexUpdate" + } + }, + "com.amazonaws.dynamodb#VectorIndexes": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#VectorIndexInfo" + } + }, + "com.amazonaws.dynamodb#VectorIndexesCapacityMap": { + "type": "map", + "key": { + "target": "com.amazonaws.dynamodb#IndexName" + }, + "value": { + "target": "com.amazonaws.dynamodb#VectorCapacity" + } + }, + "com.amazonaws.dynamodb#WarmThroughput": { + "type": "structure", + "members": { + "ReadUnitsPerSecond": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

Represents the number of read operations your base table can instantaneously\n support.

" + } + }, + "WriteUnitsPerSecond": { + "target": "com.amazonaws.dynamodb#LongObject", + "traits": { + "smithy.api#documentation": "

Represents the number of write operations your base table can instantaneously\n support.

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

Provides visibility into the number of read and write operations your table or\n secondary index can instantaneously support. The settings can be modified using the\n UpdateTable operation to meet the throughput requirements of an\n upcoming peak event.

" + } + }, + "com.amazonaws.dynamodb#WitnessStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + } + } + }, + "com.amazonaws.dynamodb#WriteRequest": { + "type": "structure", + "members": { + "PutRequest": { + "target": "com.amazonaws.dynamodb#PutRequest", + "traits": { + "smithy.api#documentation": "

A request to perform a PutItem operation.

" + } + }, + "DeleteRequest": { + "target": "com.amazonaws.dynamodb#DeleteRequest", + "traits": { + "smithy.api#documentation": "

A request to perform a DeleteItem operation.

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

Represents an operation to perform - either DeleteItem or\n PutItem. You can only request one of these operations, not both, in a\n single WriteRequest. If you do need to perform both of these operations,\n you need to provide two separate WriteRequest objects.

" + } + }, + "com.amazonaws.dynamodb#WriteRequests": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#WriteRequest" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + } + } +} diff --git a/codegen/aws-models/secrets-manager.json b/codegen/aws-models/secrets-manager.json new file mode 100644 index 0000000..c99769a --- /dev/null +++ b/codegen/aws-models/secrets-manager.json @@ -0,0 +1,5137 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.secretsmanager#APIErrorListType": { + "type": "list", + "member": { + "target": "com.amazonaws.secretsmanager#APIErrorType" + } + }, + "com.amazonaws.secretsmanager#APIErrorType": { + "type": "structure", + "members": { + "SecretId": { + "target": "com.amazonaws.secretsmanager#SecretIdType", + "traits": { + "smithy.api#documentation": "

The ARN or name of the secret.

" + } + }, + "ErrorCode": { + "target": "com.amazonaws.secretsmanager#ErrorCode", + "traits": { + "smithy.api#documentation": "

The error Secrets Manager encountered while retrieving an individual secret as part of BatchGetSecretValue, for example\n ResourceNotFoundException,InvalidParameterException,\n InvalidRequestException, DecryptionFailure, or\n AccessDeniedException.

" + } + }, + "Message": { + "target": "com.amazonaws.secretsmanager#ErrorMessage", + "traits": { + "smithy.api#documentation": "

A message describing the error.

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

The error Secrets Manager encountered while retrieving an individual secret as part of BatchGetSecretValue.

" + } + }, + "com.amazonaws.secretsmanager#AddReplicaRegionListType": { + "type": "list", + "member": { + "target": "com.amazonaws.secretsmanager#ReplicaRegionType" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.secretsmanager#AutomaticallyRotateAfterDaysType": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.secretsmanager#BatchGetSecretValue": { + "type": "operation", + "input": { + "target": "com.amazonaws.secretsmanager#BatchGetSecretValueRequest" + }, + "output": { + "target": "com.amazonaws.secretsmanager#BatchGetSecretValueResponse" + }, + "errors": [ + { + "target": "com.amazonaws.secretsmanager#DecryptionFailure" + }, + { + "target": "com.amazonaws.secretsmanager#InternalServiceError" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidParameterException" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidRequestException" + }, + { + "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the contents of the encrypted fields SecretString or\n SecretBinary for up to 20 secrets. To retrieve a single secret, call\n GetSecretValue.

\n

To choose which secrets to retrieve, you can specify a list of secrets by name or ARN,\n or you can use filters. If Secrets Manager encounters errors such as\n AccessDeniedException while attempting to retrieve any of the secrets,\n you can see the errors in Errors in the response.

\n

Secrets Manager generates CloudTrail\n GetSecretValue log entries for each secret you request when you call this\n action. Do not include sensitive information in request parameters because it might be\n logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions: \n secretsmanager:BatchGetSecretValue, and you must have\n secretsmanager:GetSecretValue for each secret. If you use filters, you\n must also have secretsmanager:ListSecrets. If the secrets are encrypted\n using customer-managed keys instead of the Amazon Web Services managed key\n aws/secretsmanager, then you also need kms:Decrypt\n permissions for the keys. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", + "smithy.api#examples": [ + { + "title": "To retrieve the secret values for a group of secrets listed by name", + "documentation": "The following example gets the values for three secrets.", + "input": { + "SecretIdList": [ + "MySecret1", + "MySecret2", + "MySecret3" + ] + }, + "output": { + "SecretValues": [ + { + "ARN": "®ion-arn;&asm-service-name;:us-west-2:&ExampleAccountId;:secret:MySecret1-a1b2c3", + "CreatedDate": 1.700591229801E9, + "Name": "MySecret1", + "SecretString": "{\"username\":\"diego_ramirez\",\"password\":\"EXAMPLE-PASSWORD\",\"engine\":\"mysql\",\"host\":\"secretsmanagertutorial.cluster.us-west-2.rds.amazonaws.com\",\"port\":3306,\"dbClusterIdentifier\":\"secretsmanagertutorial\"}", + "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa", + "VersionStages": [ + "AWSCURRENT" + ] + }, + { + "ARN": "®ion-arn;&asm-service-name;:us-west-2:&ExampleAccountId;:secret:MySecret2-a1b2c3", + "CreatedDate": 1.699911394105E9, + "Name": "MySecret2", + "SecretString": "{\"username\":\"akua_mansa\",\"password\":\"EXAMPLE-PASSWORD\"", + "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLEbbbbb", + "VersionStages": [ + "AWSCURRENT" + ] + }, + { + "ARN": "®ion-arn;&asm-service-name;:us-west-2:&ExampleAccountId;:secret:MySecret3-a1b2c3", + "CreatedDate": 1.699911394105E9, + "Name": "MySecret3", + "SecretString": "{\"username\":\"jie_liu\",\"password\":\"EXAMPLE-PASSWORD\"", + "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLEccccc", + "VersionStages": [ + "AWSCURRENT" + ] + } + ], + "Errors": [] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.secretsmanager#BatchGetSecretValueRequest": { + "type": "structure", + "members": { + "SecretIdList": { + "target": "com.amazonaws.secretsmanager#SecretIdListType", + "traits": { + "smithy.api#documentation": "

The ARN or names of the secrets to retrieve. You must include Filters or\n SecretIdList, but not both.

" + } + }, + "Filters": { + "target": "com.amazonaws.secretsmanager#FiltersListType", + "traits": { + "smithy.api#documentation": "

The filters to choose which secrets to retrieve. You must include Filters\n or SecretIdList, but not both.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.secretsmanager#MaxResultsBatchType", + "traits": { + "smithy.api#documentation": "

The number of results to include in the response.

\n

If there are more results available, in the response, Secrets Manager includes\n NextToken. To get the next results, call\n BatchGetSecretValue again with the value from NextToken.\n To use this parameter, you must also use the Filters parameter.

" + } + }, + "NextToken": { + "target": "com.amazonaws.secretsmanager#NextTokenType", + "traits": { + "smithy.api#documentation": "

A token that indicates where the output should continue from, if a previous call did\n not show all results. To get the next results, call BatchGetSecretValue\n again with this value.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.secretsmanager#BatchGetSecretValueResponse": { + "type": "structure", + "members": { + "SecretValues": { + "target": "com.amazonaws.secretsmanager#SecretValuesType", + "traits": { + "smithy.api#documentation": "

A list of secret values.

" + } + }, + "NextToken": { + "target": "com.amazonaws.secretsmanager#NextTokenType", + "traits": { + "smithy.api#documentation": "

Secrets Manager includes this value if there's more output available than what is included in\n the current response. This can occur even when the response includes no values at all,\n such as when you ask for a filtered view of a long list. To get the next results, call\n BatchGetSecretValue again with this value.

" + } + }, + "Errors": { + "target": "com.amazonaws.secretsmanager#APIErrorListType", + "traits": { + "smithy.api#documentation": "

A list of errors Secrets Manager encountered while attempting to retrieve individual\n secrets.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.secretsmanager#BooleanType": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.secretsmanager#CancelRotateSecret": { + "type": "operation", + "input": { + "target": "com.amazonaws.secretsmanager#CancelRotateSecretRequest" + }, + "output": { + "target": "com.amazonaws.secretsmanager#CancelRotateSecretResponse" + }, + "errors": [ + { + "target": "com.amazonaws.secretsmanager#InternalServiceError" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidParameterException" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidRequestException" + }, + { + "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Turns off automatic rotation, and if a rotation is currently in progress, cancels the\n rotation.

\n

If you cancel a rotation in progress, it can leave the VersionStage\n labels in an unexpected state. You might need to remove the staging label\n AWSPENDING from the partially created version. You also need to\n determine whether to roll back to the previous version of the secret by moving the\n staging label AWSCURRENT to the version that has AWSPENDING.\n To determine which version has a specific staging label, call ListSecretVersionIds. Then use UpdateSecretVersionStage to change staging labels. For more information, see How rotation\n works.

\n

To turn on automatic rotation again, call RotateSecret.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:CancelRotateSecret. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", + "smithy.api#examples": [ + { + "title": "To cancel scheduled rotation for a secret", + "documentation": "The following example shows how to cancel rotation for a secret. The operation sets the RotationEnabled field to false and cancels all scheduled rotations. To resume scheduled rotations, you must re-enable rotation by calling the rotate-secret operation.", + "input": { + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "Name" + } + } + ] + } + }, + "com.amazonaws.secretsmanager#CancelRotateSecretRequest": { + "type": "structure", + "members": { + "SecretId": { + "target": "com.amazonaws.secretsmanager#SecretIdType", + "traits": { + "smithy.api#documentation": "

The ARN or name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.secretsmanager#CancelRotateSecretResponse": { + "type": "structure", + "members": { + "ARN": { + "target": "com.amazonaws.secretsmanager#SecretARNType", + "traits": { + "smithy.api#documentation": "

The ARN of the secret.

" + } + }, + "Name": { + "target": "com.amazonaws.secretsmanager#SecretNameType", + "traits": { + "smithy.api#documentation": "

The name of the secret.

" + } + }, + "VersionId": { + "target": "com.amazonaws.secretsmanager#SecretVersionIdType", + "traits": { + "smithy.api#documentation": "

The unique identifier of the version of the secret created during the rotation. This\n version might not be complete, and should be evaluated for possible deletion. We\n recommend that you remove the VersionStage value AWSPENDING\n from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation\n can block you from starting future rotations.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.secretsmanager#ClientRequestTokenType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 32, + "max": 64 + } + } + }, + "com.amazonaws.secretsmanager#CreateSecret": { + "type": "operation", + "input": { + "target": "com.amazonaws.secretsmanager#CreateSecretRequest" + }, + "output": { + "target": "com.amazonaws.secretsmanager#CreateSecretResponse" + }, + "errors": [ + { + "target": "com.amazonaws.secretsmanager#DecryptionFailure" + }, + { + "target": "com.amazonaws.secretsmanager#EncryptionFailure" + }, + { + "target": "com.amazonaws.secretsmanager#InternalServiceError" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidParameterException" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidRequestException" + }, + { + "target": "com.amazonaws.secretsmanager#LimitExceededException" + }, + { + "target": "com.amazonaws.secretsmanager#MalformedPolicyDocumentException" + }, + { + "target": "com.amazonaws.secretsmanager#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.secretsmanager#ResourceExistsException" + }, + { + "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new secret. A secret can be a password, a set of\n credentials such as a user name and password, an OAuth token, or other secret\n information that you store in an encrypted form in Secrets Manager. The secret also includes the\n connection information to access a database or other service, which Secrets Manager doesn't\n encrypt. A secret in Secrets Manager consists of both the protected secret data and the important\n information needed to manage the secret.

\n

For secrets that use managed rotation, you need to create the\n secret through the managing service. For more information, see Secrets Manager secrets\n managed by other Amazon Web Services services.

\n

For information about creating a secret in the console, see Create a\n secret.

\n

To create a secret, you can provide the secret value to be encrypted in either the\n SecretString parameter or the SecretBinary parameter, but\n not both. If you include SecretString or SecretBinary then\n Secrets Manager creates an initial secret version and automatically attaches the staging label\n AWSCURRENT to it.

\n

For database credentials you want to rotate, for Secrets Manager to be able to rotate the\n secret, you must make sure the JSON you store in the SecretString matches\n the JSON\n structure of a database secret.

\n

If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key\n aws/secretsmanager. If this key doesn't already exist in your account,\n then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account\n automatically have access to use aws/secretsmanager. Creating\n aws/secretsmanager can result in a one-time significant delay in\n returning the result.

\n

If the secret is in a different Amazon Web Services account from the credentials calling the API,\n then you can't use aws/secretsmanager to encrypt the secret, and you must\n create and use a customer managed KMS key.

\n

Secrets Manager generates a CloudTrail log entry when you call this action.\n Do not include sensitive information in request parameters except\n SecretBinary or SecretString because it might be logged.\n For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:CreateSecret. If you include tags in the\n secret, you also need secretsmanager:TagResource. To add replica Regions,\n you must also have secretsmanager:ReplicateSecretToRegions.\n For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

\n

To encrypt the secret with a KMS key other than aws/secretsmanager, you\n need kms:GenerateDataKey and kms:Decrypt permission to the\n key.

\n \n

When you enter commands in a command shell, there is a risk of the command history being accessed or utilities having access to your command parameters. This is a concern if the command includes the value of a secret. Learn how to Mitigate the risks of using command-line tools to store Secrets Manager secrets.

\n ", + "smithy.api#examples": [ + { + "title": "To create a basic secret", + "documentation": "The following example shows how to create a secret. The credentials stored in the encrypted secret value are retrieved from a file on disk named mycreds.json.", + "input": { + "Name": "MyTestDatabaseSecret", + "Description": "My test database secret created with the CLI", + "SecretString": "{\"username\":\"david\",\"password\":\"EXAMPLE-PASSWORD\"}", + "ClientRequestToken": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1" + } + } + ] + } + }, + "com.amazonaws.secretsmanager#CreateSecretRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.secretsmanager#NameType", + "traits": { + "smithy.api#documentation": "

The name of the new secret.

\n

The secret name can contain ASCII letters, numbers, and the following characters:\n /_+=.@-

\n

Do not end your secret name with a hyphen followed by six characters. If you do so,\n you risk confusion and unexpected results when searching for a secret by partial ARN.\n Secrets Manager automatically adds a hyphen and six random characters after the secret name at the\n end of the ARN.

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.secretsmanager#ClientRequestTokenType", + "traits": { + "smithy.api#documentation": "

If you include SecretString or SecretBinary, then Secrets Manager\n creates an initial version for the secret, and this parameter specifies the unique\n identifier for the new version.

\n \n

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.

\n \n

If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it in the request.

\n

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.

\n \n

This value becomes the VersionId of the new version.

", + "smithy.api#idempotencyToken": {} + } + }, + "Description": { + "target": "com.amazonaws.secretsmanager#DescriptionType", + "traits": { + "smithy.api#documentation": "

The description of the secret.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.secretsmanager#KmsKeyIdType", + "traits": { + "smithy.api#documentation": "

The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value\n in the secret. An alias is always prefixed by alias/, for example\n alias/aws/secretsmanager. For more information, see About\n aliases.

\n

To use a KMS key in a different account, use the key ARN or the alias ARN.

\n

If you don't specify this value, then Secrets Manager uses the key\n aws/secretsmanager. If that key doesn't yet exist, then Secrets Manager creates\n it for you automatically the first time it encrypts the secret value.

\n

If the secret is in a different Amazon Web Services account from the credentials calling the API,\n then you can't use aws/secretsmanager to encrypt the secret, and you must\n create and use a customer managed KMS key.

" + } + }, + "SecretBinary": { + "target": "com.amazonaws.secretsmanager#SecretBinaryType", + "traits": { + "smithy.api#documentation": "

The binary data to encrypt and store in the new version of the secret. We recommend\n that you store your binary data in a file and then pass the contents of the file as a\n parameter.

\n

Either SecretString or SecretBinary must have a value, but\n not both.

\n

This parameter is not available in the Secrets Manager console.

\n

Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

" + } + }, + "SecretString": { + "target": "com.amazonaws.secretsmanager#SecretStringType", + "traits": { + "smithy.api#documentation": "

The text data to encrypt and store in this new version of the secret. We recommend you\n use a JSON structure of key/value pairs for your secret value.

\n

Either SecretString or SecretBinary must have a value, but\n not both.

\n

If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret\n text in only the SecretString parameter. The Secrets Manager console stores the\n information as a JSON structure of key/value pairs that a Lambda rotation function can\n parse.

\n

Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

" + } + }, + "Tags": { + "target": "com.amazonaws.secretsmanager#TagListType", + "traits": { + "smithy.api#documentation": "

A list of tags to attach to the secret. Each tag is a key and value pair of strings in\n a JSON text string, for example:

\n

\n [{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]\n

\n

Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag\n from one with key \"abc\".

\n

If you check tags in permissions policies as part of your security strategy, then\n adding or removing a tag can change permissions. If the completion of this operation\n would result in you losing your permissions for this secret, then Secrets Manager blocks the\n operation and returns an Access Denied error. For more information, see\n Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.

\n

For information about how to format a JSON parameter for the various command line tool\n environments, see Using JSON for\n Parameters. If your command-line tool or SDK requires quotation marks around\n the parameter, you should use single quotes to avoid confusion with the double quotes\n required in the JSON text.

\n

For tag quotas and naming restrictions, see Service quotas for\n Tagging in the Amazon Web Services General Reference guide.

" + } + }, + "AddReplicaRegions": { + "target": "com.amazonaws.secretsmanager#AddReplicaRegionListType", + "traits": { + "smithy.api#documentation": "

A list of Regions and KMS keys to replicate secrets.

" + } + }, + "ForceOverwriteReplicaSecret": { + "target": "com.amazonaws.secretsmanager#BooleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether to overwrite a secret with the same name in the destination Region.\n By default, secrets aren't overwritten.

" + } + }, + "Type": { + "target": "com.amazonaws.secretsmanager#MedeaTypeType", + "traits": { + "smithy.api#documentation": "

The exact string that identifies the partner that holds the external secret. For more\n information, see Using Secrets Manager managed external secrets.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.secretsmanager#CreateSecretResponse": { + "type": "structure", + "members": { + "ARN": { + "target": "com.amazonaws.secretsmanager#SecretARNType", + "traits": { + "smithy.api#documentation": "

The ARN of the new secret. The ARN includes the name of the secret followed by six\n random characters. This ensures that if you create a new secret with the same name as a\n deleted secret, then users with access to the old secret don't get access to the new\n secret because the ARNs are different.

" + } + }, + "Name": { + "target": "com.amazonaws.secretsmanager#SecretNameType", + "traits": { + "smithy.api#documentation": "

The name of the new secret.

" + } + }, + "VersionId": { + "target": "com.amazonaws.secretsmanager#SecretVersionIdType", + "traits": { + "smithy.api#documentation": "

The unique identifier associated with the version of the new secret.

" + } + }, + "ReplicationStatus": { + "target": "com.amazonaws.secretsmanager#ReplicationStatusListType", + "traits": { + "smithy.api#documentation": "

A list of the replicas of this secret and their status:

\n " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.secretsmanager#CreatedDateType": { + "type": "timestamp" + }, + "com.amazonaws.secretsmanager#DecryptionFailure": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.secretsmanager#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Secrets Manager can't decrypt the protected secret text using the provided KMS key.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.secretsmanager#DeleteResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.secretsmanager#DeleteResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.secretsmanager#DeleteResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.secretsmanager#InternalServiceError" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidParameterException" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidRequestException" + }, + { + "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the resource-based permission policy attached to the secret. To attach a\n policy to a secret, use PutResourcePolicy.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:DeleteResourcePolicy. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", + "smithy.api#examples": [ + { + "title": "To delete the resource-based policy attached to a secret", + "documentation": "The following example shows how to delete the resource-based policy that is attached to a secret.", + "input": { + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + } + } + ] + } + }, + "com.amazonaws.secretsmanager#DeleteResourcePolicyRequest": { + "type": "structure", + "members": { + "SecretId": { + "target": "com.amazonaws.secretsmanager#SecretIdType", + "traits": { + "smithy.api#documentation": "

The ARN or name of the secret to delete the attached resource-based policy for.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.secretsmanager#DeleteResourcePolicyResponse": { + "type": "structure", + "members": { + "ARN": { + "target": "com.amazonaws.secretsmanager#SecretARNType", + "traits": { + "smithy.api#documentation": "

The ARN of the secret that the resource-based policy was deleted for.

" + } + }, + "Name": { + "target": "com.amazonaws.secretsmanager#NameType", + "traits": { + "smithy.api#documentation": "

The name of the secret that the resource-based policy was deleted for.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.secretsmanager#DeleteSecret": { + "type": "operation", + "input": { + "target": "com.amazonaws.secretsmanager#DeleteSecretRequest" + }, + "output": { + "target": "com.amazonaws.secretsmanager#DeleteSecretResponse" + }, + "errors": [ + { + "target": "com.amazonaws.secretsmanager#InternalServiceError" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidParameterException" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidRequestException" + }, + { + "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a secret and all of its versions. You can specify a recovery window during\n which you can restore the secret. The minimum recovery window is 7 days. The default\n recovery window is 30 days. Secrets Manager attaches a DeletionDate stamp to the\n secret that specifies the end of the recovery window. At the end of the recovery window,\n Secrets Manager deletes the secret permanently.

\n

You can't delete a primary secret that is replicated to other Regions. You must first\n delete the replicas using RemoveRegionsFromReplication, and then\n delete the primary secret. When you delete a replica, it is deleted immediately.

\n

You can't directly delete a version of a secret. Instead, you remove all staging\n labels from the version using UpdateSecretVersionStage. This marks the\n version as deprecated, and then Secrets Manager can automatically delete the version in the\n background.

\n

To determine whether an application still uses a secret, you can create an Amazon CloudWatch alarm\n to alert you to any attempts to access a secret during the recovery window. For more\n information, see \n Monitor secrets scheduled for deletion.

\n

Secrets Manager performs the permanent secret deletion at the end of the waiting period as a\n background task with low priority. There is no guarantee of a specific time after the\n recovery window for the permanent delete to occur.

\n

At any time before recovery window ends, you can use RestoreSecret\n to remove the DeletionDate and cancel the deletion of the secret.

\n

When a secret is scheduled for deletion, you cannot retrieve the secret value. You\n must first cancel the deletion with RestoreSecret and then you can\n retrieve the secret.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:DeleteSecret. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

" + } + }, + "com.amazonaws.secretsmanager#DeleteSecretRequest": { + "type": "structure", + "members": { + "SecretId": { + "target": "com.amazonaws.secretsmanager#SecretIdType", + "traits": { + "smithy.api#documentation": "

The ARN or name of the secret to delete.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", + "smithy.api#required": {} + } + }, + "RecoveryWindowInDays": { + "target": "com.amazonaws.secretsmanager#RecoveryWindowInDaysType", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The number of days from 7 to 30 that Secrets Manager waits before permanently deleting the\n secret. You can't use both this parameter and ForceDeleteWithoutRecovery in\n the same call. If you don't use either, then by default Secrets Manager uses a 30 day recovery\n window.

" + } + }, + "ForceDeleteWithoutRecovery": { + "target": "com.amazonaws.secretsmanager#BooleanType", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Specifies whether to delete the secret without any recovery window. You can't use both\n this parameter and RecoveryWindowInDays in the same call. If you don't use\n either, then by default Secrets Manager uses a 30 day recovery window.

\n

Secrets Manager performs the actual deletion with an asynchronous background process, so there\n might be a short delay before the secret is permanently deleted. If you delete a secret\n and then immediately create a secret with the same name, use appropriate back off and\n retry logic.

\n

If you forcibly delete an already deleted or nonexistent secret, the operation does\n not return ResourceNotFoundException.

\n \n

Use this parameter with caution. This parameter causes the operation to skip the\n normal recovery window before the permanent deletion that Secrets Manager would normally\n impose with the RecoveryWindowInDays parameter. If you delete a secret\n with the ForceDeleteWithoutRecovery parameter, then you have no\n opportunity to recover the secret. You lose the secret permanently.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.secretsmanager#DeleteSecretResponse": { + "type": "structure", + "members": { + "ARN": { + "target": "com.amazonaws.secretsmanager#SecretARNType", + "traits": { + "smithy.api#documentation": "

The ARN of the secret.

" + } + }, + "Name": { + "target": "com.amazonaws.secretsmanager#SecretNameType", + "traits": { + "smithy.api#documentation": "

The name of the secret.

" + } + }, + "DeletionDate": { + "target": "com.amazonaws.secretsmanager#DeletionDateType", + "traits": { + "smithy.api#documentation": "

The date and time after which this secret Secrets Manager can permanently delete this secret,\n and it can no longer be restored. This value is the date and time of the delete request\n plus the number of days in RecoveryWindowInDays.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.secretsmanager#DeletedDateType": { + "type": "timestamp" + }, + "com.amazonaws.secretsmanager#DeletionDateType": { + "type": "timestamp" + }, + "com.amazonaws.secretsmanager#DescribeSecret": { + "type": "operation", + "input": { + "target": "com.amazonaws.secretsmanager#DescribeSecretRequest" + }, + "output": { + "target": "com.amazonaws.secretsmanager#DescribeSecretResponse" + }, + "errors": [ + { + "target": "com.amazonaws.secretsmanager#InternalServiceError" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidParameterException" + }, + { + "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the details of a secret. It does not include the encrypted secret value.\n Secrets Manager only returns fields that have a value in the response.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:DescribeSecret. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", + "smithy.test#smokeTests": [ + { + "id": "DescribeSecretFailure", + "params": { + "SecretId": "fake-secret-id" + }, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "failure": {} + } + } + ] + } + }, + "com.amazonaws.secretsmanager#DescribeSecretRequest": { + "type": "structure", + "members": { + "SecretId": { + "target": "com.amazonaws.secretsmanager#SecretIdType", + "traits": { + "smithy.api#documentation": "

The ARN or name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.secretsmanager#DescribeSecretResponse": { + "type": "structure", + "members": { + "ARN": { + "target": "com.amazonaws.secretsmanager#SecretARNType", + "traits": { + "smithy.api#documentation": "

The ARN of the secret.

" + } + }, + "Name": { + "target": "com.amazonaws.secretsmanager#SecretNameType", + "traits": { + "smithy.api#documentation": "

The name of the secret.

" + } + }, + "Type": { + "target": "com.amazonaws.secretsmanager#MedeaTypeType", + "traits": { + "smithy.api#documentation": "

The exact string that identifies the partner that holds the external secret. For more\n information, see Using Secrets Manager managed external secrets.

" + } + }, + "Description": { + "target": "com.amazonaws.secretsmanager#DescriptionType", + "traits": { + "smithy.api#documentation": "

The description of the secret.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.secretsmanager#KmsKeyIdType", + "traits": { + "smithy.api#documentation": "

The key ID or alias ARN of the KMS key that Secrets Manager uses to encrypt the secret value.\n If the secret is encrypted with the Amazon Web Services managed key\n aws/secretsmanager, this field is omitted. Secrets created using the\n console use an KMS key ID.

" + } + }, + "RotationEnabled": { + "target": "com.amazonaws.secretsmanager#RotationEnabledType", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Specifies whether automatic rotation is turned on for this secret. If the secret has\n never been configured for rotation, Secrets Manager returns null.

\n

To turn on rotation, use RotateSecret. To turn off rotation, use\n CancelRotateSecret.

" + } + }, + "RotationLambdaARN": { + "target": "com.amazonaws.secretsmanager#RotationLambdaARNType", + "traits": { + "smithy.api#documentation": "

The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.

" + } + }, + "RotationRules": { + "target": "com.amazonaws.secretsmanager#RotationRulesType", + "traits": { + "smithy.api#documentation": "

The rotation schedule and Lambda function for this secret. If the secret previously had\n rotation turned on, but it is now turned off, this field shows the previous rotation\n schedule and rotation function. If the secret never had rotation turned on, this field\n is omitted.

" + } + }, + "ExternalSecretRotationMetadata": { + "target": "com.amazonaws.secretsmanager#ExternalSecretRotationMetadataType", + "traits": { + "smithy.api#documentation": "

The metadata needed to successfully rotate a managed external secret. A list of key\n value pairs in JSON format specified by the partner. For more information about the\n required information, see Managed external secrets partners.

" + } + }, + "ExternalSecretRotationRoleArn": { + "target": "com.amazonaws.secretsmanager#RoleARNType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that allows Secrets Manager to rotate a secret held\n by a third-party partner. For more information, see Security and\n permissions.

" + } + }, + "LastRotatedDate": { + "target": "com.amazonaws.secretsmanager#LastRotatedDateType", + "traits": { + "smithy.api#documentation": "

The last date and time that Secrets Manager rotated the secret. If the secret isn't configured\n for rotation or rotation has been disabled, Secrets Manager returns null.

" + } + }, + "LastChangedDate": { + "target": "com.amazonaws.secretsmanager#LastChangedDateType", + "traits": { + "smithy.api#documentation": "

The last date and time that this secret was modified in any way.

" + } + }, + "LastAccessedDate": { + "target": "com.amazonaws.secretsmanager#LastAccessedDateType", + "traits": { + "smithy.api#documentation": "

The date that the secret was last accessed in the Region. This field is omitted if the\n secret has never been retrieved in the Region.

" + } + }, + "DeletedDate": { + "target": "com.amazonaws.secretsmanager#DeletedDateType", + "traits": { + "smithy.api#documentation": "

The date the secret is scheduled for deletion. If it is not scheduled for deletion,\n this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at\n least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes\n the secret, including all of its versions.

\n

If a secret is scheduled for deletion, then its details, including the encrypted\n secret value, is not accessible. To cancel a scheduled deletion and restore access to\n the secret, use RestoreSecret.

" + } + }, + "NextRotationDate": { + "target": "com.amazonaws.secretsmanager#NextRotationDateType", + "traits": { + "smithy.api#documentation": "

The next rotation is scheduled to occur on or before this date. If the secret isn't\n configured for rotation or rotation has been disabled, Secrets Manager returns null. If rotation\n fails, Secrets Manager retries the entire rotation process multiple times. If rotation\n is unsuccessful, this date may be in the past.

\n

This date represents the latest date that rotation will occur, but it is not an\n approximate rotation date. In some cases, for example if you turn off automatic rotation\n and then turn it back on, the next rotation may occur much sooner than this date.

" + } + }, + "Tags": { + "target": "com.amazonaws.secretsmanager#TagListType", + "traits": { + "smithy.api#documentation": "

The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.

" + } + }, + "VersionIdsToStages": { + "target": "com.amazonaws.secretsmanager#SecretVersionsToStagesMapType", + "traits": { + "smithy.api#documentation": "

A list of the versions of the secret that have staging labels attached. Versions that\n don't have staging labels are considered deprecated and Secrets Manager can delete them.

\n

Secrets Manager uses staging labels to indicate the status of a secret version during rotation.\n The three staging labels for rotation are:

\n \n

For more information about rotation and staging labels, see How rotation works.

" + } + }, + "OwningService": { + "target": "com.amazonaws.secretsmanager#OwningServiceType", + "traits": { + "smithy.api#documentation": "

The ID of the service that created this secret. For more information, see Secrets managed by\n other Amazon Web Services services.

" + } + }, + "CreatedDate": { + "target": "com.amazonaws.secretsmanager#TimestampType", + "traits": { + "smithy.api#documentation": "

The date the secret was created.

" + } + }, + "PrimaryRegion": { + "target": "com.amazonaws.secretsmanager#RegionType", + "traits": { + "smithy.api#documentation": "

The Region the secret is in. If a secret is replicated to other Regions, the replicas\n are listed in ReplicationStatus.

" + } + }, + "ReplicationStatus": { + "target": "com.amazonaws.secretsmanager#ReplicationStatusListType", + "traits": { + "smithy.api#documentation": "

A list of the replicas of this secret and their status:

\n " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.secretsmanager#DescriptionType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, + "com.amazonaws.secretsmanager#DurationType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 3 + }, + "smithy.api#pattern": "^[0-9]+h$" + } + }, + "com.amazonaws.secretsmanager#EncryptionFailure": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.secretsmanager#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the\n KMS key is available, enabled, and not in an invalid state. For more\n information, see Key state: Effect on your KMS key.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.secretsmanager#ErrorCode": { + "type": "string" + }, + "com.amazonaws.secretsmanager#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.secretsmanager#ExcludeCharactersType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + } + } + }, + "com.amazonaws.secretsmanager#ExcludeLowercaseType": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.secretsmanager#ExcludeNumbersType": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.secretsmanager#ExcludePunctuationType": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.secretsmanager#ExcludeUppercaseType": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.secretsmanager#ExternalSecretRotationMetadataItem": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.secretsmanager#ExternalSecretRotationMetadataItemKeyType", + "traits": { + "smithy.api#documentation": "

The key that identifies the item.

" + } + }, + "Value": { + "target": "com.amazonaws.secretsmanager#ExternalSecretRotationMetadataItemValueType", + "traits": { + "smithy.api#documentation": "

The value of the specified item.

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

The metadata needed to successfully rotate a managed external secret. A list of key\n value pairs in JSON format specified by the partner. For more information, see Managed\n external secret partners.

" + } + }, + "com.amazonaws.secretsmanager#ExternalSecretRotationMetadataItemKeyType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.secretsmanager#ExternalSecretRotationMetadataItemValueType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.secretsmanager#ExternalSecretRotationMetadataType": { + "type": "list", + "member": { + "target": "com.amazonaws.secretsmanager#ExternalSecretRotationMetadataItem" + } + }, + "com.amazonaws.secretsmanager#Filter": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.secretsmanager#FilterNameStringType", + "traits": { + "smithy.api#documentation": "

The following are keys you can use:

\n " + } + }, + "Values": { + "target": "com.amazonaws.secretsmanager#FilterValuesStringList", + "traits": { + "smithy.api#documentation": "

The keyword to filter for.

\n

You can prefix your search value with an exclamation mark (!) in order to\n perform negation filters.

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

Allows you to add filters when you use the search function in Secrets Manager. For more\n information, see Find secrets in\n Secrets Manager.

" + } + }, + "com.amazonaws.secretsmanager#FilterNameStringType": { + "type": "enum", + "members": { + "description": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "description" + } + }, + "name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "name" + } + }, + "tag_key": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tag-key" + } + }, + "tag_value": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tag-value" + } + }, + "primary_region": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "primary-region" + } + }, + "owning_service": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "owning-service" + } + }, + "all": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "all" + } + } + } + }, + "com.amazonaws.secretsmanager#FilterValueStringType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^\\!?[a-zA-Z0-9 :_@\\/\\+\\=\\.\\-\\!]*$" + } + }, + "com.amazonaws.secretsmanager#FilterValuesStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.secretsmanager#FilterValueStringType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.secretsmanager#FiltersListType": { + "type": "list", + "member": { + "target": "com.amazonaws.secretsmanager#Filter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.secretsmanager#GetRandomPassword": { + "type": "operation", + "input": { + "target": "com.amazonaws.secretsmanager#GetRandomPasswordRequest" + }, + "output": { + "target": "com.amazonaws.secretsmanager#GetRandomPasswordResponse" + }, + "errors": [ + { + "target": "com.amazonaws.secretsmanager#InternalServiceError" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidParameterException" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

Generates a random password. We recommend that you specify the maximum length and\n include every character type that the system you are generating a password for can\n support. By default, Secrets Manager uses uppercase and lowercase letters, numbers, and the\n following characters in passwords:\n !\\\"#$%&'()*+,-./:;<=>?@[\\\\]^_`{|}~\n

\n

Secrets Manager generates a CloudTrail log entry when you call this\n action.

\n

\n Required permissions:\n \n secretsmanager:GetRandomPassword. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", + "smithy.api#examples": [ + { + "title": "To generate a random password", + "documentation": "The following example shows how to request a randomly generated password. This example includes the optional flags to require spaces and at least one character of each included type. It specifies a length of 20 characters.", + "input": { + "PasswordLength": 20, + "IncludeSpace": true, + "RequireEachIncludedType": true + }, + "output": { + "RandomPassword": "EXAMPLE-PASSWORD" + } + } + ] + } + }, + "com.amazonaws.secretsmanager#GetRandomPasswordRequest": { + "type": "structure", + "members": { + "PasswordLength": { + "target": "com.amazonaws.secretsmanager#PasswordLengthType", + "traits": { + "smithy.api#documentation": "

The length of the password. If you don't include this parameter, the default length is\n 32 characters.

" + } + }, + "ExcludeCharacters": { + "target": "com.amazonaws.secretsmanager#ExcludeCharactersType", + "traits": { + "smithy.api#documentation": "

A string of the characters that you don't want in the password.

" + } + }, + "ExcludeNumbers": { + "target": "com.amazonaws.secretsmanager#ExcludeNumbersType", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Specifies whether to exclude numbers from the password. If you don't include this\n switch, the password can contain numbers.

" + } + }, + "ExcludePunctuation": { + "target": "com.amazonaws.secretsmanager#ExcludePunctuationType", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Specifies whether to exclude the following punctuation characters from the password:\n ! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | }\n ~. If you don't include this switch, the password can contain\n punctuation.

" + } + }, + "ExcludeUppercase": { + "target": "com.amazonaws.secretsmanager#ExcludeUppercaseType", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Specifies whether to exclude uppercase letters from the password. If you don't include\n this switch, the password can contain uppercase letters.

" + } + }, + "ExcludeLowercase": { + "target": "com.amazonaws.secretsmanager#ExcludeLowercaseType", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Specifies whether to exclude lowercase letters from the password. If you don't include\n this switch, the password can contain lowercase letters.

" + } + }, + "IncludeSpace": { + "target": "com.amazonaws.secretsmanager#IncludeSpaceType", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Specifies whether to include the space character. If you include this switch, the\n password can contain space characters.

" + } + }, + "RequireEachIncludedType": { + "target": "com.amazonaws.secretsmanager#RequireEachIncludedTypeType", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Specifies whether to include at least one upper and lowercase letter, one number, and\n one punctuation. If you don't include this switch, the password contains at least one of\n every character type.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.secretsmanager#GetRandomPasswordResponse": { + "type": "structure", + "members": { + "RandomPassword": { + "target": "com.amazonaws.secretsmanager#RandomPasswordType", + "traits": { + "smithy.api#documentation": "

A string with the password.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.secretsmanager#GetResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.secretsmanager#GetResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.secretsmanager#GetResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.secretsmanager#InternalServiceError" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidParameterException" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidRequestException" + }, + { + "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the JSON text of the resource-based policy document attached to the secret.\n For more information about permissions policies attached to a secret, see Permissions policies attached to a secret.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:GetResourcePolicy. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", + "smithy.api#examples": [ + { + "title": "To retrieve the resource-based policy attached to a secret", + "documentation": "The following example shows how to retrieve the resource-based policy that is attached to a secret.", + "input": { + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "ResourcePolicy": "{\n\"Version\":\"2012-10-17\",\n\"Statement\":[{\n\"Effect\":\"Allow\",\n\"Principal\":{\n\"AWS\":\"arn:aws:iam::123456789012:root\"\n},\n\"Action\":\"secretsmanager:GetSecretValue\",\n\"Resource\":\"*\"\n}]\n}" + } + } + ] + } + }, + "com.amazonaws.secretsmanager#GetResourcePolicyRequest": { + "type": "structure", + "members": { + "SecretId": { + "target": "com.amazonaws.secretsmanager#SecretIdType", + "traits": { + "smithy.api#documentation": "

The ARN or name of the secret to retrieve the attached resource-based policy\n for.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.secretsmanager#GetResourcePolicyResponse": { + "type": "structure", + "members": { + "ARN": { + "target": "com.amazonaws.secretsmanager#SecretARNType", + "traits": { + "smithy.api#documentation": "

The ARN of the secret that the resource-based policy was retrieved for.

" + } + }, + "Name": { + "target": "com.amazonaws.secretsmanager#NameType", + "traits": { + "smithy.api#documentation": "

The name of the secret that the resource-based policy was retrieved for.

" + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.secretsmanager#NonEmptyResourcePolicyType", + "traits": { + "smithy.api#documentation": "

A JSON-formatted string that contains the permissions policy attached to the secret.\n For more information about permissions policies, see Authentication and access\n control for Secrets Manager.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.secretsmanager#GetSecretValue": { + "type": "operation", + "input": { + "target": "com.amazonaws.secretsmanager#GetSecretValueRequest" + }, + "output": { + "target": "com.amazonaws.secretsmanager#GetSecretValueResponse" + }, + "errors": [ + { + "target": "com.amazonaws.secretsmanager#DecryptionFailure" + }, + { + "target": "com.amazonaws.secretsmanager#InternalServiceError" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidParameterException" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidRequestException" + }, + { + "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the contents of the encrypted fields SecretString or\n SecretBinary from the specified version of a secret, whichever contains\n content.

\n

To retrieve the values for a group of secrets, call BatchGetSecretValue.

\n

We recommend that you cache your secret values by using client-side caching. Caching\n secrets improves speed and reduces your costs. For more information, see Cache secrets for your applications.

\n

To retrieve the previous version of a secret, use VersionStage and\n specify AWSPREVIOUS. To revert to the previous version of a secret, call UpdateSecretVersionStage.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:GetSecretValue. If the secret is encrypted\n using a customer-managed key instead of the Amazon Web Services managed key\n aws/secretsmanager, then you also need kms:Decrypt\n permissions for that key. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", + "smithy.api#examples": [ + { + "title": "To retrieve the encrypted secret value of a secret", + "documentation": "The following example shows how to retrieve a secret string value.", + "input": { + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "CreatedDate": 1.523477145713E9, + "Name": "MyTestDatabaseSecret", + "SecretString": "{\n \"username\":\"david\",\n \"password\":\"EXAMPLE-PASSWORD\"\n}\n", + "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", + "VersionStages": [ + "AWSPREVIOUS" + ] + } + } + ] + } + }, + "com.amazonaws.secretsmanager#GetSecretValueRequest": { + "type": "structure", + "members": { + "SecretId": { + "target": "com.amazonaws.secretsmanager#SecretIdType", + "traits": { + "smithy.api#documentation": "

The ARN or name of the secret to retrieve. To retrieve a secret from another account,\n you must use an ARN.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", + "smithy.api#required": {} + } + }, + "VersionId": { + "target": "com.amazonaws.secretsmanager#SecretVersionIdType", + "traits": { + "smithy.api#documentation": "

The unique identifier of the version of the secret to retrieve. If you include both\n this parameter and VersionStage, the two parameters must refer to the same\n secret version. If you don't specify either a VersionStage or\n VersionId, then Secrets Manager returns the AWSCURRENT\n version.

\n

This value is typically a UUID-type\n value with 32 hexadecimal digits.

" + } + }, + "VersionStage": { + "target": "com.amazonaws.secretsmanager#SecretVersionStageType", + "traits": { + "smithy.api#documentation": "

The staging label of the version of the secret to retrieve.

\n

Secrets Manager uses staging labels to keep track of different versions during the rotation\n process. If you include both this parameter and VersionId, the two\n parameters must refer to the same secret version. If you don't specify either a\n VersionStage or VersionId, Secrets Manager returns the\n AWSCURRENT version.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.secretsmanager#GetSecretValueResponse": { + "type": "structure", + "members": { + "ARN": { + "target": "com.amazonaws.secretsmanager#SecretARNType", + "traits": { + "smithy.api#documentation": "

The ARN of the secret.

" + } + }, + "Name": { + "target": "com.amazonaws.secretsmanager#SecretNameType", + "traits": { + "smithy.api#documentation": "

The friendly name of the secret.

" + } + }, + "VersionId": { + "target": "com.amazonaws.secretsmanager#SecretVersionIdType", + "traits": { + "smithy.api#documentation": "

The unique identifier of this version of the secret.

" + } + }, + "SecretBinary": { + "target": "com.amazonaws.secretsmanager#SecretBinaryType", + "traits": { + "smithy.api#documentation": "

The decrypted secret value, if the secret value was originally provided as binary data\n in the form of a byte array. When you retrieve a SecretBinary using the\n HTTP API, the Python SDK, or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it\n is not encoded.

\n

If the secret was created by using the Secrets Manager console, or if the secret value was\n originally provided as a string, then this field is omitted. The secret value appears in\n SecretString instead.

\n

Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

" + } + }, + "SecretString": { + "target": "com.amazonaws.secretsmanager#SecretStringType", + "traits": { + "smithy.api#documentation": "

The decrypted secret value, if the secret value was originally provided as a string or\n through the Secrets Manager console.

\n

If this secret was created by using the console, then Secrets Manager stores the information as\n a JSON structure of key/value pairs.

\n

Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

" + } + }, + "VersionStages": { + "target": "com.amazonaws.secretsmanager#SecretVersionStagesType", + "traits": { + "smithy.api#documentation": "

A list of all of the staging labels currently attached to this version of the\n secret.

" + } + }, + "CreatedDate": { + "target": "com.amazonaws.secretsmanager#CreatedDateType", + "traits": { + "smithy.api#documentation": "

The date and time that this version of the secret was created. If you don't specify\n which version in VersionId or VersionStage, then Secrets Manager uses\n the AWSCURRENT version.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.secretsmanager#IncludeSpaceType": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.secretsmanager#InternalServiceError": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.secretsmanager#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

An error occurred on the server side.

", + "smithy.api#error": "server" + } + }, + "com.amazonaws.secretsmanager#InvalidNextTokenException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.secretsmanager#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The NextToken value is invalid.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.secretsmanager#InvalidParameterException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.secretsmanager#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The parameter name or value is invalid.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.secretsmanager#InvalidRequestException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.secretsmanager#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

A parameter value is not valid for the current state of the\n resource.

\n

Possible causes:

\n ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.secretsmanager#KmsKeyIdListType": { + "type": "list", + "member": { + "target": "com.amazonaws.secretsmanager#KmsKeyIdType" + } + }, + "com.amazonaws.secretsmanager#KmsKeyIdType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, + "com.amazonaws.secretsmanager#LastAccessedDateType": { + "type": "timestamp" + }, + "com.amazonaws.secretsmanager#LastChangedDateType": { + "type": "timestamp" + }, + "com.amazonaws.secretsmanager#LastRotatedDateType": { + "type": "timestamp" + }, + "com.amazonaws.secretsmanager#LimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.secretsmanager#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The request failed because it would exceed one of the Secrets Manager quotas.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.secretsmanager#ListSecretVersionIds": { + "type": "operation", + "input": { + "target": "com.amazonaws.secretsmanager#ListSecretVersionIdsRequest" + }, + "output": { + "target": "com.amazonaws.secretsmanager#ListSecretVersionIdsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.secretsmanager#InternalServiceError" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidParameterException" + }, + { + "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the versions of a secret. Secrets Manager uses staging labels to indicate the different\n versions of a secret. For more information, see Secrets Manager\n concepts: Versions.

\n

To list the secrets in the account, use ListSecrets.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:ListSecretVersionIds. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", + "smithy.api#examples": [ + { + "title": "To list all of the secret versions associated with a secret", + "documentation": "The following example shows how to retrieve a list of all of the versions of a secret, including those without any staging labels.", + "input": { + "SecretId": "MyTestDatabaseSecret", + "IncludeDeprecated": true + }, + "output": { + "Versions": [ + { + "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE", + "VersionStages": [ + "AWSPREVIOUS" + ], + "CreatedDate": 1.523477145713E9 + }, + { + "VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", + "VersionStages": [ + "AWSCURRENT" + ], + "CreatedDate": 1.523486221391E9 + }, + { + "CreatedDate": 1.51197446236E9, + "VersionId": "EXAMPLE3-90ab-cdef-fedc-ba987EXAMPLE;" + } + ], + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.secretsmanager#ListSecretVersionIdsRequest": { + "type": "structure", + "members": { + "SecretId": { + "target": "com.amazonaws.secretsmanager#SecretIdType", + "traits": { + "smithy.api#documentation": "

The ARN or name of the secret whose versions you want to list.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.secretsmanager#MaxResultsType", + "traits": { + "smithy.api#documentation": "

The number of results to include in the response.

\n

If there are more results available, in the response, Secrets Manager includes\n NextToken. To get the next results, call\n ListSecretVersionIds again with the value from NextToken.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.secretsmanager#NextTokenType", + "traits": { + "smithy.api#documentation": "

A token that indicates where the output should continue from, if a previous call did\n not show all results. To get the next results, call ListSecretVersionIds\n again with this value.

" + } + }, + "IncludeDeprecated": { + "target": "com.amazonaws.secretsmanager#BooleanType", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Specifies whether to include versions of secrets that don't have any staging labels\n attached to them. Versions without staging labels are considered deprecated and are\n subject to deletion by Secrets Manager. By default, versions without staging labels aren't\n included.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.secretsmanager#ListSecretVersionIdsResponse": { + "type": "structure", + "members": { + "Versions": { + "target": "com.amazonaws.secretsmanager#SecretVersionsListType", + "traits": { + "smithy.api#documentation": "

A list of the versions of the secret.

" + } + }, + "NextToken": { + "target": "com.amazonaws.secretsmanager#NextTokenType", + "traits": { + "smithy.api#documentation": "

Secrets Manager includes this value if there's more output available than what is included in\n the current response. This can occur even when the response includes no values at all,\n such as when you ask for a filtered view of a long list. To get the next results, call\n ListSecretVersionIds again with this value.

" + } + }, + "ARN": { + "target": "com.amazonaws.secretsmanager#SecretARNType", + "traits": { + "smithy.api#documentation": "

The ARN of the secret.

" + } + }, + "Name": { + "target": "com.amazonaws.secretsmanager#SecretNameType", + "traits": { + "smithy.api#documentation": "

The name of the secret.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.secretsmanager#ListSecrets": { + "type": "operation", + "input": { + "target": "com.amazonaws.secretsmanager#ListSecretsRequest" + }, + "output": { + "target": "com.amazonaws.secretsmanager#ListSecretsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.secretsmanager#InternalServiceError" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidParameterException" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets\n that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager\n console.

\n

All Secrets Manager operations are eventually consistent. ListSecrets might not\n reflect changes from the last five minutes. You can get more recent information for a\n specific secret by calling DescribeSecret.

\n

To list the versions of a secret, use ListSecretVersionIds.

\n

To retrieve the values for the secrets, call BatchGetSecretValue or\n GetSecretValue.

\n

For information about finding secrets in the console, see Find secrets in\n Secrets Manager.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:ListSecrets. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", + "smithy.api#examples": [ + { + "title": "To list the secrets in your account", + "documentation": "The following example shows how to list all of the secrets in your account.", + "output": { + "SecretList": [ + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "Description": "My test database secret", + "LastChangedDate": 1.523477145729E9, + "SecretVersionsToStages": { + "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE": [ + "AWSCURRENT" + ] + } + }, + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret1-d4e5f6", + "Name": "MyTestDatabaseSecret1", + "Description": "Another secret created for a different database", + "LastChangedDate": 1.523482025685E9, + "SecretVersionsToStages": { + "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE": [ + "AWSCURRENT" + ] + } + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + }, + "smithy.test#smokeTests": [ + { + "id": "ListSecretsSuccess", + "params": {}, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] + } + }, + "com.amazonaws.secretsmanager#ListSecretsRequest": { + "type": "structure", + "members": { + "IncludePlannedDeletion": { + "target": "com.amazonaws.secretsmanager#BooleanType", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Specifies whether to include secrets scheduled for deletion. By default, secrets\n scheduled for deletion aren't included.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.secretsmanager#MaxResultsType", + "traits": { + "smithy.api#documentation": "

The number of results to include in the response.

\n

If there are more results available, in the response, Secrets Manager includes\n NextToken. To get the next results, call ListSecrets again\n with the value from NextToken.

" + } + }, + "NextToken": { + "target": "com.amazonaws.secretsmanager#NextTokenType", + "traits": { + "smithy.api#documentation": "

A token that indicates where the output should continue from, if a previous call did\n not show all results. To get the next results, call ListSecrets again with\n this value.

" + } + }, + "Filters": { + "target": "com.amazonaws.secretsmanager#FiltersListType", + "traits": { + "smithy.api#documentation": "

The filters to apply to the list of secrets.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.secretsmanager#SortOrderType", + "traits": { + "smithy.api#documentation": "

Secrets are listed by CreatedDate.

" + } + }, + "SortBy": { + "target": "com.amazonaws.secretsmanager#SortByType", + "traits": { + "smithy.api#documentation": "

If not specified, secrets are listed by CreatedDate.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.secretsmanager#ListSecretsResponse": { + "type": "structure", + "members": { + "SecretList": { + "target": "com.amazonaws.secretsmanager#SecretListType", + "traits": { + "smithy.api#documentation": "

A list of the secrets in the account.

" + } + }, + "NextToken": { + "target": "com.amazonaws.secretsmanager#NextTokenType", + "traits": { + "smithy.api#documentation": "

Secrets Manager includes this value if there's more output available than what is included in\n the current response. This can occur even when the response includes no values at all,\n such as when you ask for a filtered view of a long list. To get the next results, call\n ListSecrets again with this value.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.secretsmanager#MalformedPolicyDocumentException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.secretsmanager#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The resource policy has syntax errors.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.secretsmanager#MaxResultsBatchType": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.secretsmanager#MaxResultsType": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.secretsmanager#MedeaTypeType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.secretsmanager#NameType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.secretsmanager#NextRotationDateType": { + "type": "timestamp" + }, + "com.amazonaws.secretsmanager#NextTokenType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "com.amazonaws.secretsmanager#NonEmptyResourcePolicyType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20480 + } + } + }, + "com.amazonaws.secretsmanager#OwningServiceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.secretsmanager#PasswordLengthType": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 4096 + } + } + }, + "com.amazonaws.secretsmanager#PreconditionNotMetException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.secretsmanager#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The request failed because you did not complete all the prerequisite steps.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.secretsmanager#PublicPolicyException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.secretsmanager#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The BlockPublicPolicy parameter is set to true, and the resource policy did not prevent broad access to the secret.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.secretsmanager#PutResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.secretsmanager#PutResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.secretsmanager#PutResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.secretsmanager#InternalServiceError" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidParameterException" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidRequestException" + }, + { + "target": "com.amazonaws.secretsmanager#MalformedPolicyDocumentException" + }, + { + "target": "com.amazonaws.secretsmanager#PublicPolicyException" + }, + { + "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Attaches a resource-based permission policy to a secret. A resource-based policy is\n optional. For more information, see Authentication and access control for Secrets Manager\n

\n

For information about attaching a policy in the console, see Attach a permissions policy to a secret.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:PutResourcePolicy. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", + "smithy.api#examples": [ + { + "title": "To add a resource-based policy to a secret", + "documentation": "The following example shows how to add a resource-based policy to a secret.", + "input": { + "SecretId": "MyTestDatabaseSecret", + "ResourcePolicy": "{\n\"Version\":\"2012-10-17\",\n\"Statement\":[{\n\"Effect\":\"Allow\",\n\"Principal\":{\n\"AWS\":\"arn:aws:iam::123456789012:root\"\n},\n\"Action\":\"secretsmanager:GetSecretValue\",\n\"Resource\":\"*\"\n}]\n}" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + } + } + ] + } + }, + "com.amazonaws.secretsmanager#PutResourcePolicyRequest": { + "type": "structure", + "members": { + "SecretId": { + "target": "com.amazonaws.secretsmanager#SecretIdType", + "traits": { + "smithy.api#documentation": "

The ARN or name of the secret to attach the resource-based policy.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", + "smithy.api#required": {} + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.secretsmanager#NonEmptyResourcePolicyType", + "traits": { + "smithy.api#documentation": "

A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see\n Permissions policy examples.

", + "smithy.api#required": {} + } + }, + "BlockPublicPolicy": { + "target": "com.amazonaws.secretsmanager#BooleanType", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Specifies whether to block resource-based policies that allow broad access to the\n secret, for example those that use a wildcard for the principal. By default, public\n policies aren't blocked.

\n \n

Resource policy validation and the BlockPublicPolicy parameter help protect your\n resources by preventing public access from being granted through the resource\n policies that are directly attached to your secrets. In addition to using these\n features, carefully inspect the following policies to confirm that they do not grant\n public access:

\n \n

To review permissions to your secrets, see Determine who has permissions to your secrets.

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.secretsmanager#PutResourcePolicyResponse": { + "type": "structure", + "members": { + "ARN": { + "target": "com.amazonaws.secretsmanager#SecretARNType", + "traits": { + "smithy.api#documentation": "

The ARN of the secret.

" + } + }, + "Name": { + "target": "com.amazonaws.secretsmanager#NameType", + "traits": { + "smithy.api#documentation": "

The name of the secret.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.secretsmanager#PutSecretValue": { + "type": "operation", + "input": { + "target": "com.amazonaws.secretsmanager#PutSecretValueRequest" + }, + "output": { + "target": "com.amazonaws.secretsmanager#PutSecretValueResponse" + }, + "errors": [ + { + "target": "com.amazonaws.secretsmanager#DecryptionFailure" + }, + { + "target": "com.amazonaws.secretsmanager#EncryptionFailure" + }, + { + "target": "com.amazonaws.secretsmanager#InternalServiceError" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidParameterException" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidRequestException" + }, + { + "target": "com.amazonaws.secretsmanager#LimitExceededException" + }, + { + "target": "com.amazonaws.secretsmanager#ResourceExistsException" + }, + { + "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new version of your secret by creating a new encrypted value and attaching\n it to the secret. version can contain a new SecretString value or a new\n SecretBinary value.

\n

Do not call PutSecretValue at a sustained rate of more than once every 10\n minutes. When you update the secret value, Secrets Manager creates a new version of the secret.\n Secrets Manager keeps 100 of the most recent versions, but it keeps all\n secret versions created in the last 24 hours. If you call PutSecretValue\n more than once every 10 minutes, you will create more versions than Secrets Manager removes, and\n you will reach the quota for secret versions.

\n

You can specify the staging labels to attach to the new version in\n VersionStages. If you don't include VersionStages, then\n Secrets Manager automatically moves the staging label AWSCURRENT to this version. If\n this operation creates the first version for the secret, then Secrets Manager automatically\n attaches the staging label AWSCURRENT to it. If this operation moves the\n staging label AWSCURRENT from another version to this version, then Secrets Manager\n also automatically moves the staging label AWSPREVIOUS to the version that\n AWSCURRENT was removed from.

\n

This operation is idempotent. If you call this operation with a\n ClientRequestToken that matches an existing version's VersionId, and\n you specify the same secret data, the operation succeeds but does nothing. However, if\n the secret data is different, then the operation fails because you can't modify an\n existing version; you can only create new ones.

\n

Secrets Manager generates a CloudTrail log entry when you call this action.\n Do not include sensitive information in request parameters except\n SecretBinary, SecretString, or RotationToken\n because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:PutSecretValue. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

\n \n

When you enter commands in a command shell, there is a risk of the command history being accessed or utilities having access to your command parameters. This is a concern if the command includes the value of a secret. Learn how to Mitigate the risks of using command-line tools to store Secrets Manager secrets.

\n ", + "smithy.api#examples": [ + { + "title": "To store a secret value in a new version of a secret", + "documentation": "The following example shows how to create a new version of the secret. Alternatively, you can use the update-secret command.", + "input": { + "SecretId": "MyTestDatabaseSecret", + "SecretString": "{\"username\":\"david\",\"password\":\"EXAMPLE-PASSWORD\"}", + "ClientRequestToken": "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", + "VersionStages": [ + "AWSCURRENT" + ] + } + } + ] + } + }, + "com.amazonaws.secretsmanager#PutSecretValueRequest": { + "type": "structure", + "members": { + "SecretId": { + "target": "com.amazonaws.secretsmanager#SecretIdType", + "traits": { + "smithy.api#documentation": "

The ARN or name of the secret to add a new version to.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

\n

If the secret doesn't already exist, use CreateSecret instead.

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.secretsmanager#ClientRequestTokenType", + "traits": { + "smithy.api#documentation": "

A unique identifier for the new version of the secret.

\n \n

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.

\n \n

If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it in the request.

\n

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.

\n \n

This value becomes the VersionId of the new version.

", + "smithy.api#idempotencyToken": {} + } + }, + "SecretBinary": { + "target": "com.amazonaws.secretsmanager#SecretBinaryType", + "traits": { + "smithy.api#documentation": "

The binary data to encrypt and store in the new version of the secret. To use this\n parameter in the command-line tools, we recommend that you store your binary data in a\n file and then pass the contents of the file as a parameter.

\n

You must include SecretBinary or SecretString, but not\n both.

\n

You can't access this value from the Secrets Manager console.

\n

Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

" + } + }, + "SecretString": { + "target": "com.amazonaws.secretsmanager#SecretStringType", + "traits": { + "smithy.api#documentation": "

The text to encrypt and store in the new version of the secret.

\n

You must include SecretBinary or SecretString, but not\n both.

\n

We recommend you create the secret string as JSON key/value pairs, as shown in the\n example.

\n

Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

" + } + }, + "VersionStages": { + "target": "com.amazonaws.secretsmanager#SecretVersionStagesType", + "traits": { + "smithy.api#documentation": "

A list of staging labels to attach to this version of the secret. Secrets Manager uses staging\n labels to track versions of a secret through the rotation process.

\n

If you specify a staging label that's already associated with a different version of\n the same secret, then Secrets Manager removes the label from the other version and attaches it to\n this version. If you specify AWSCURRENT, and it is already attached to\n another version, then Secrets Manager also moves the staging label AWSPREVIOUS to the\n version that AWSCURRENT was removed from.

\n

If you don't include VersionStages, then Secrets Manager automatically moves the\n staging label AWSCURRENT to this version.

" + } + }, + "RotationToken": { + "target": "com.amazonaws.secretsmanager#RotationTokenType", + "traits": { + "smithy.api#documentation": "

A unique identifier that indicates the source of the request. Required for secret\n rotations using an IAM assumed role or cross-account rotation, in which you rotate a\n secret in one account by using a Lambda rotation function in another account. In both\n cases, the rotation function assumes an IAM role to call Secrets Manager, and then Secrets Manager validates\n the identity using the token. For more information, see How rotation\n works and Rotation by Lambda\n functions.

\n

Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.secretsmanager#PutSecretValueResponse": { + "type": "structure", + "members": { + "ARN": { + "target": "com.amazonaws.secretsmanager#SecretARNType", + "traits": { + "smithy.api#documentation": "

The ARN of the secret.

" + } + }, + "Name": { + "target": "com.amazonaws.secretsmanager#SecretNameType", + "traits": { + "smithy.api#documentation": "

The name of the secret.

" + } + }, + "VersionId": { + "target": "com.amazonaws.secretsmanager#SecretVersionIdType", + "traits": { + "smithy.api#documentation": "

The unique identifier of the version of the secret.

" + } + }, + "VersionStages": { + "target": "com.amazonaws.secretsmanager#SecretVersionStagesType", + "traits": { + "smithy.api#documentation": "

The list of staging labels that are currently attached to this version of the secret.\n Secrets Manager uses staging labels to track a version as it progresses through the secret\n rotation process.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.secretsmanager#RandomPasswordType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.secretsmanager#RecoveryWindowInDaysType": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.secretsmanager#RegionType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^([a-z]+-)+\\d+$" + } + }, + "com.amazonaws.secretsmanager#RemoveRegionsFromReplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.secretsmanager#RemoveRegionsFromReplicationRequest" + }, + "output": { + "target": "com.amazonaws.secretsmanager#RemoveRegionsFromReplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.secretsmanager#InternalServiceError" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidParameterException" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidRequestException" + }, + { + "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

For a secret that is replicated to other Regions, deletes the secret replicas from the\n Regions you specify.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:RemoveRegionsFromReplication.\n For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

" + } + }, + "com.amazonaws.secretsmanager#RemoveRegionsFromReplicationRequest": { + "type": "structure", + "members": { + "SecretId": { + "target": "com.amazonaws.secretsmanager#SecretIdType", + "traits": { + "smithy.api#documentation": "

The ARN or name of the secret.

", + "smithy.api#required": {} + } + }, + "RemoveReplicaRegions": { + "target": "com.amazonaws.secretsmanager#RemoveReplicaRegionListType", + "traits": { + "smithy.api#documentation": "

The Regions of the replicas to remove.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.secretsmanager#RemoveRegionsFromReplicationResponse": { + "type": "structure", + "members": { + "ARN": { + "target": "com.amazonaws.secretsmanager#SecretARNType", + "traits": { + "smithy.api#documentation": "

The ARN of the primary secret.

" + } + }, + "ReplicationStatus": { + "target": "com.amazonaws.secretsmanager#ReplicationStatusListType", + "traits": { + "smithy.api#documentation": "

The status of replicas for this secret after you remove Regions.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.secretsmanager#RemoveReplicaRegionListType": { + "type": "list", + "member": { + "target": "com.amazonaws.secretsmanager#RegionType" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.secretsmanager#ReplicaRegionType": { + "type": "structure", + "members": { + "Region": { + "target": "com.amazonaws.secretsmanager#RegionType", + "traits": { + "smithy.api#documentation": "

A Region code. For a list of Region codes, see Name and code of\n Regions.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.secretsmanager#KmsKeyIdType", + "traits": { + "smithy.api#documentation": "

The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include\n this field, Secrets Manager uses aws/secretsmanager.

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

A custom type that specifies a Region and the KmsKeyId for a\n replica secret.

" + } + }, + "com.amazonaws.secretsmanager#ReplicateSecretToRegions": { + "type": "operation", + "input": { + "target": "com.amazonaws.secretsmanager#ReplicateSecretToRegionsRequest" + }, + "output": { + "target": "com.amazonaws.secretsmanager#ReplicateSecretToRegionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.secretsmanager#InternalServiceError" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidParameterException" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidRequestException" + }, + { + "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Replicates the secret to a new Regions. See Multi-Region secrets.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:ReplicateSecretToRegions. If the primary\n secret is encrypted with a KMS key other than aws/secretsmanager, you also\n need kms:Decrypt permission to the key. To encrypt the replicated secret\n with a KMS key other than aws/secretsmanager, you need\n kms:GenerateDataKey and kms:Encrypt to the key.\n For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", + "smithy.api#examples": [ + { + "title": "Example", + "documentation": "The following example replicates a secret to eu-west-3. The replica is encrypted with the AWS managed key aws/secretsmanager.", + "input": { + "SecretId": "MyTestSecret", + "AddReplicaRegions": [ + { + "Region": "eu-west-3" + } + ], + "ForceOverwriteReplicaSecret": true + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-1a2b3c", + "ReplicationStatus": [ + { + "Region": "eu-west-3", + "KmsKeyId": "alias/aws/secretsmanager", + "Status": "InProgress" + } + ] + } + } + ] + } + }, + "com.amazonaws.secretsmanager#ReplicateSecretToRegionsRequest": { + "type": "structure", + "members": { + "SecretId": { + "target": "com.amazonaws.secretsmanager#SecretIdType", + "traits": { + "smithy.api#documentation": "

The ARN or name of the secret to replicate.

", + "smithy.api#required": {} + } + }, + "AddReplicaRegions": { + "target": "com.amazonaws.secretsmanager#AddReplicaRegionListType", + "traits": { + "smithy.api#documentation": "

A list of Regions in which to replicate the secret.

", + "smithy.api#required": {} + } + }, + "ForceOverwriteReplicaSecret": { + "target": "com.amazonaws.secretsmanager#BooleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether to overwrite a secret with the same name in the destination Region.\n By default, secrets aren't overwritten.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.secretsmanager#ReplicateSecretToRegionsResponse": { + "type": "structure", + "members": { + "ARN": { + "target": "com.amazonaws.secretsmanager#SecretARNType", + "traits": { + "smithy.api#documentation": "

The ARN of the primary secret.

" + } + }, + "ReplicationStatus": { + "target": "com.amazonaws.secretsmanager#ReplicationStatusListType", + "traits": { + "smithy.api#documentation": "

The status of replication.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.secretsmanager#ReplicationStatusListType": { + "type": "list", + "member": { + "target": "com.amazonaws.secretsmanager#ReplicationStatusType" + } + }, + "com.amazonaws.secretsmanager#ReplicationStatusType": { + "type": "structure", + "members": { + "Region": { + "target": "com.amazonaws.secretsmanager#RegionType", + "traits": { + "smithy.api#documentation": "

The Region where replication occurs.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.secretsmanager#KmsKeyIdType", + "traits": { + "smithy.api#documentation": "

Can be an ARN, Key ID, or Alias.

" + } + }, + "Status": { + "target": "com.amazonaws.secretsmanager#StatusType", + "traits": { + "smithy.api#documentation": "

The status can be InProgress, Failed, or\n InSync.

" + } + }, + "StatusMessage": { + "target": "com.amazonaws.secretsmanager#StatusMessageType", + "traits": { + "smithy.api#documentation": "

Status message such as \"Secret with this name already exists in this\n region\".

" + } + }, + "LastAccessedDate": { + "target": "com.amazonaws.secretsmanager#LastAccessedDateType", + "traits": { + "smithy.api#documentation": "

The date that the secret was last accessed in the Region. This field is omitted if the\n secret has never been retrieved in the Region.

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

A replication object consisting of a RegionReplicationStatus object and\n includes a Region, KMSKeyId, status, and status message.

" + } + }, + "com.amazonaws.secretsmanager#RequireEachIncludedTypeType": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.secretsmanager#ResourceExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.secretsmanager#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

A resource with the ID you requested already exists.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.secretsmanager#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.secretsmanager#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Secrets Manager can't find the resource that you asked for.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.secretsmanager#RestoreSecret": { + "type": "operation", + "input": { + "target": "com.amazonaws.secretsmanager#RestoreSecretRequest" + }, + "output": { + "target": "com.amazonaws.secretsmanager#RestoreSecretResponse" + }, + "errors": [ + { + "target": "com.amazonaws.secretsmanager#InternalServiceError" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidParameterException" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidRequestException" + }, + { + "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels the scheduled deletion of a secret by removing the DeletedDate\n time stamp. You can access a secret again after it has been restored.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:RestoreSecret. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", + "smithy.api#examples": [ + { + "title": "To restore a previously deleted secret", + "documentation": "The following example shows how to restore a secret that you previously scheduled for deletion.", + "input": { + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + } + } + ] + } + }, + "com.amazonaws.secretsmanager#RestoreSecretRequest": { + "type": "structure", + "members": { + "SecretId": { + "target": "com.amazonaws.secretsmanager#SecretIdType", + "traits": { + "smithy.api#documentation": "

The ARN or name of the secret to restore.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.secretsmanager#RestoreSecretResponse": { + "type": "structure", + "members": { + "ARN": { + "target": "com.amazonaws.secretsmanager#SecretARNType", + "traits": { + "smithy.api#documentation": "

The ARN of the secret that was restored.

" + } + }, + "Name": { + "target": "com.amazonaws.secretsmanager#SecretNameType", + "traits": { + "smithy.api#documentation": "

The name of the secret that was restored.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.secretsmanager#RoleARNType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + } + } + }, + "com.amazonaws.secretsmanager#RotateSecret": { + "type": "operation", + "input": { + "target": "com.amazonaws.secretsmanager#RotateSecretRequest" + }, + "output": { + "target": "com.amazonaws.secretsmanager#RotateSecretResponse" + }, + "errors": [ + { + "target": "com.amazonaws.secretsmanager#InternalServiceError" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidParameterException" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidRequestException" + }, + { + "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Configures and starts the asynchronous process of rotating the secret. For information\n about rotation, see Rotate secrets\n in the Secrets Manager User Guide. If you include the configuration\n parameters, the operation sets the values for the secret and then immediately starts a\n rotation. If you don't include the configuration parameters, the operation starts a\n rotation with the values already stored in the secret.

\n

When rotation is successful, the AWSPENDING staging label might be\n attached to the same version as the AWSCURRENT version, or it might not be\n attached to any version. If the AWSPENDING staging label is present but not\n attached to the same version as AWSCURRENT, then any later invocation of\n RotateSecret assumes that a previous rotation request is still in\n progress and returns an error. When rotation is unsuccessful, the\n AWSPENDING staging label might be attached to an empty secret version.\n For more information, see Troubleshoot\n rotation in the Secrets Manager User Guide.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:RotateSecret. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager. You also\n need lambda:InvokeFunction permissions on the rotation function. For more\n information, see Permissions for rotation.

", + "smithy.api#examples": [ + { + "title": "To configure rotation for a secret", + "documentation": "The following example configures rotation for a secret using a cron expression. The first rotation happens immediately after the changes are stored in the secret. The rotation schedule is the first and 15th day of every month. The rotation window begins at 4:00 PM UTC and ends at 6:00 PM.", + "input": { + "SecretId": "MyTestDatabaseSecret", + "RotationLambdaARN": "arn:aws:lambda:us-west-2:123456789012:function:MyTestDatabaseRotationLambda", + "RotationRules": { + "ScheduleExpression": "cron(0 16 1,15 * ? *)", + "Duration": "2h" + } + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2" + } + }, + { + "title": "To request an immediate rotation for a secret", + "documentation": "The following example requests an immediate invocation of the secret's Lambda rotation function. It assumes that the specified secret already has rotation configured. The rotation function runs asynchronously in the background.", + "input": { + "SecretId": "MyTestDatabaseSecret" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2" + } + } + ] + } + }, + "com.amazonaws.secretsmanager#RotateSecretRequest": { + "type": "structure", + "members": { + "SecretId": { + "target": "com.amazonaws.secretsmanager#SecretIdType", + "traits": { + "smithy.api#documentation": "

The ARN or name of the secret to rotate.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.secretsmanager#ClientRequestTokenType", + "traits": { + "smithy.api#documentation": "

A unique identifier for the new version of the secret. You only need to specify this\n value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't\n attempt to create a secret version twice.

\n \n

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.

\n \n

If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it in the request.

\n

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.

", + "smithy.api#idempotencyToken": {} + } + }, + "RotationLambdaARN": { + "target": "com.amazonaws.secretsmanager#RotationLambdaARNType", + "traits": { + "smithy.api#documentation": "

For secrets that use a Lambda rotation function to rotate, the ARN of the Lambda\n rotation function.

\n

For secrets that use managed rotation, omit this field. For more\n information, see Managed\n rotation in the Secrets Manager User Guide.

" + } + }, + "RotationRules": { + "target": "com.amazonaws.secretsmanager#RotationRulesType", + "traits": { + "smithy.api#documentation": "

A structure that defines the rotation configuration for this secret.

\n \n

When changing an existing rotation schedule and setting\n RotateImmediately to false:

\n \n " + } + }, + "ExternalSecretRotationMetadata": { + "target": "com.amazonaws.secretsmanager#ExternalSecretRotationMetadataType", + "traits": { + "smithy.api#documentation": "

The metadata needed to successfully rotate a managed external secret. A list of key\n value pairs in JSON format specified by the partner. For more information about the\n required information, see Using Secrets Manager managed external secrets\n

" + } + }, + "ExternalSecretRotationRoleArn": { + "target": "com.amazonaws.secretsmanager#RoleARNType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that allows Secrets Manager to rotate a secret held\n by a third-party partner. For more information, see Security and\n permissions.

" + } + }, + "RotateImmediately": { + "target": "com.amazonaws.secretsmanager#BooleanType", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Specifies whether to rotate the secret immediately or wait until the next scheduled\n rotation window. The rotation schedule is defined in RotateSecretRequest$RotationRules.

\n

The default for RotateImmediately is true. If you don't\n specify this value, Secrets Manager rotates the secret immediately.

\n

If you set RotateImmediately to false, Secrets Manager tests\n the rotation configuration by running the \n testSecret step of the Lambda rotation function. This test\n creates an AWSPENDING version of the secret and then removes it.

\n

When changing an existing rotation schedule and setting RotateImmediately\n to false:

\n \n

Rotation is an asynchronous process. For more information, see How rotation works.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.secretsmanager#RotateSecretResponse": { + "type": "structure", + "members": { + "ARN": { + "target": "com.amazonaws.secretsmanager#SecretARNType", + "traits": { + "smithy.api#documentation": "

The ARN of the secret.

" + } + }, + "Name": { + "target": "com.amazonaws.secretsmanager#SecretNameType", + "traits": { + "smithy.api#documentation": "

The name of the secret.

" + } + }, + "VersionId": { + "target": "com.amazonaws.secretsmanager#SecretVersionIdType", + "traits": { + "smithy.api#documentation": "

The ID of the new version of the secret.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.secretsmanager#RotationEnabledType": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.secretsmanager#RotationLambdaARNType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, + "com.amazonaws.secretsmanager#RotationRulesType": { + "type": "structure", + "members": { + "AutomaticallyAfterDays": { + "target": "com.amazonaws.secretsmanager#AutomaticallyRotateAfterDaysType", + "traits": { + "smithy.api#documentation": "

The number of days between rotations of the secret. You can use this value to check\n that your secret meets your compliance guidelines for how often secrets must be rotated.\n If you use this field to set the rotation schedule, Secrets Manager calculates the next rotation\n date based on the previous rotation. Manually updating the secret value by calling\n PutSecretValue or UpdateSecret is considered a valid\n rotation.

\n

In DescribeSecret and ListSecrets, this value is calculated\n from the rotation schedule after every successful rotation. In\n RotateSecret, you can set the rotation schedule in\n RotationRules with AutomaticallyAfterDays or\n ScheduleExpression, but not both. To set a rotation schedule in hours,\n use ScheduleExpression.

" + } + }, + "Duration": { + "target": "com.amazonaws.secretsmanager#DurationType", + "traits": { + "smithy.api#documentation": "

The length of the rotation window in hours, for example 3h for a three\n hour window. Secrets Manager rotates your secret at any time during this window. The window must\n not extend into the next rotation window or the next UTC day. The window starts\n according to the ScheduleExpression. If you don't specify a\n Duration, for a ScheduleExpression in hours, the window\n automatically closes after one hour. For a ScheduleExpression in days, the\n window automatically closes at the end of the UTC day. For more information, including\n examples, see Schedule\n expressions in Secrets Manager rotation in the Secrets Manager Users\n Guide.

" + } + }, + "ScheduleExpression": { + "target": "com.amazonaws.secretsmanager#ScheduleExpressionType", + "traits": { + "smithy.api#documentation": "

A cron() or rate() expression that defines the schedule for\n rotating your secret. Secrets Manager rotation schedules use UTC time zone. Secrets Manager rotates your\n secret any time during a rotation window.

\n

Secrets Manager rate() expressions represent the interval in hours or days that you\n want to rotate your secret, for example rate(12 hours) or rate(10\n days). You can rotate a secret as often as every four hours. If you use a\n rate() expression, the rotation window starts at midnight. For a rate\n in hours, the default rotation window closes after one hour. For a rate in days, the\n default rotation window closes at the end of the day. You can set the\n Duration to change the rotation window. The rotation window must not\n extend into the next UTC day or into the next rotation window.

\n

You can use a cron() expression to create a rotation schedule that is\n more detailed than a rotation interval. For more information, including examples, see\n Schedule\n expressions in Secrets Manager rotation in the Secrets Manager Users Guide.\n For a cron expression that represents a schedule in hours, the default rotation window\n closes after one hour. For a cron expression that represents a schedule in days, the\n default rotation window closes at the end of the day. You can set the\n Duration to change the rotation window. The rotation window must not\n extend into the next UTC day or into the next rotation window.

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

A structure that defines the rotation configuration for the secret.

" + } + }, + "com.amazonaws.secretsmanager#RotationTokenType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.secretsmanager#ScheduleExpressionType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[0-9A-Za-z\\(\\)#\\?\\*\\-\\/, ]+$" + } + }, + "com.amazonaws.secretsmanager#SecretARNType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + } + } + }, + "com.amazonaws.secretsmanager#SecretBinaryType": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 65536 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.secretsmanager#SecretIdListType": { + "type": "list", + "member": { + "target": "com.amazonaws.secretsmanager#SecretIdType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.secretsmanager#SecretIdType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.secretsmanager#SecretListEntry": { + "type": "structure", + "members": { + "ARN": { + "target": "com.amazonaws.secretsmanager#SecretARNType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secret.

" + } + }, + "Name": { + "target": "com.amazonaws.secretsmanager#SecretNameType", + "traits": { + "smithy.api#documentation": "

The friendly name of the secret.

" + } + }, + "Type": { + "target": "com.amazonaws.secretsmanager#MedeaTypeType", + "traits": { + "smithy.api#documentation": "

The exact string that identifies the third-party partner that holds the external\n secret. For more information, see Managed external secret\n partners.

" + } + }, + "Description": { + "target": "com.amazonaws.secretsmanager#DescriptionType", + "traits": { + "smithy.api#documentation": "

The user-provided description of the secret.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.secretsmanager#KmsKeyIdType", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is\n encrypted with the Amazon Web Services managed key aws/secretsmanager, this\n field is omitted.

" + } + }, + "RotationEnabled": { + "target": "com.amazonaws.secretsmanager#RotationEnabledType", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Indicates whether automatic, scheduled rotation is enabled for this secret.

" + } + }, + "RotationLambdaARN": { + "target": "com.amazonaws.secretsmanager#RotationLambdaARNType", + "traits": { + "smithy.api#documentation": "

The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret\n either automatically per the schedule or manually by a call to \n RotateSecret\n .

" + } + }, + "RotationRules": { + "target": "com.amazonaws.secretsmanager#RotationRulesType", + "traits": { + "smithy.api#documentation": "

A structure that defines the rotation configuration for the secret.

" + } + }, + "ExternalSecretRotationMetadata": { + "target": "com.amazonaws.secretsmanager#ExternalSecretRotationMetadataType", + "traits": { + "smithy.api#documentation": "

The metadata needed to successfully rotate a managed external secret. A list of key\n value pairs in JSON format specified by the partner. For more information about the\n required information, see Managed external secrets partners.

" + } + }, + "ExternalSecretRotationRoleArn": { + "target": "com.amazonaws.secretsmanager#RoleARNType", + "traits": { + "smithy.api#documentation": "

The role that Secrets Manager assumes to call APIs required to perform the rotation. For more\n information about the required information, see Managed\n external secrets partners.

" + } + }, + "LastRotatedDate": { + "target": "com.amazonaws.secretsmanager#LastRotatedDateType", + "traits": { + "smithy.api#documentation": "

The most recent date and time that the Secrets Manager rotation process was\n successfully completed. This value is null if the secret hasn't ever rotated.

" + } + }, + "LastChangedDate": { + "target": "com.amazonaws.secretsmanager#LastChangedDateType", + "traits": { + "smithy.api#documentation": "

The last date and time that this secret was modified in any way.

" + } + }, + "LastAccessedDate": { + "target": "com.amazonaws.secretsmanager#LastAccessedDateType", + "traits": { + "smithy.api#documentation": "

The date that the secret was last accessed in the Region. This field is omitted if the\n secret has never been retrieved in the Region.

" + } + }, + "DeletedDate": { + "target": "com.amazonaws.secretsmanager#DeletedDateType", + "traits": { + "smithy.api#documentation": "

The date and time the deletion of the secret occurred. Not present on active secrets.\n The secret can be recovered until the number of days in the recovery window has passed,\n as specified in the RecoveryWindowInDays parameter of the \n DeleteSecret\n operation.

" + } + }, + "NextRotationDate": { + "target": "com.amazonaws.secretsmanager#NextRotationDateType", + "traits": { + "smithy.api#documentation": "

The next rotation is scheduled to occur on or before this date. If the secret isn't\n configured for rotation or rotation has been disabled, Secrets Manager returns null.

" + } + }, + "Tags": { + "target": "com.amazonaws.secretsmanager#TagListType", + "traits": { + "smithy.api#documentation": "

The list of user-defined tags associated with the secret. To add tags to a secret, use\n \n TagResource\n . To remove tags, use \n UntagResource\n .

" + } + }, + "SecretVersionsToStages": { + "target": "com.amazonaws.secretsmanager#SecretVersionsToStagesMapType", + "traits": { + "smithy.api#documentation": "

A list of all of the currently assigned SecretVersionStage staging labels\n and the SecretVersionId attached to each one. Staging labels are used to\n keep track of the different versions during the rotation process.

\n \n

A version that does not have any SecretVersionStage is considered\n deprecated and subject to deletion. Such versions are not included in this\n list.

\n " + } + }, + "OwningService": { + "target": "com.amazonaws.secretsmanager#OwningServiceType", + "traits": { + "smithy.api#documentation": "

Returns the name of the service that created the secret.

" + } + }, + "CreatedDate": { + "target": "com.amazonaws.secretsmanager#TimestampType", + "traits": { + "smithy.api#documentation": "

The date and time when a secret was created.

" + } + }, + "PrimaryRegion": { + "target": "com.amazonaws.secretsmanager#RegionType", + "traits": { + "smithy.api#documentation": "

The Region where Secrets Manager originated the secret.

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

A structure that contains the details about a secret. It does not include the\n encrypted SecretString and SecretBinary values. To get those\n values, use GetSecretValue .

" + } + }, + "com.amazonaws.secretsmanager#SecretListType": { + "type": "list", + "member": { + "target": "com.amazonaws.secretsmanager#SecretListEntry" + } + }, + "com.amazonaws.secretsmanager#SecretNameType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.secretsmanager#SecretStringType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 65536 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.secretsmanager#SecretValueEntry": { + "type": "structure", + "members": { + "ARN": { + "target": "com.amazonaws.secretsmanager#SecretARNType", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secret.

" + } + }, + "Name": { + "target": "com.amazonaws.secretsmanager#SecretNameType", + "traits": { + "smithy.api#documentation": "

The friendly name of the secret.

" + } + }, + "VersionId": { + "target": "com.amazonaws.secretsmanager#SecretVersionIdType", + "traits": { + "smithy.api#documentation": "

The unique version identifier of this version of the secret.

" + } + }, + "SecretBinary": { + "target": "com.amazonaws.secretsmanager#SecretBinaryType", + "traits": { + "smithy.api#documentation": "

The decrypted secret value, if the secret value was originally provided as binary data\n in the form of a byte array. The parameter represents the binary data as a base64-encoded\n string.

" + } + }, + "SecretString": { + "target": "com.amazonaws.secretsmanager#SecretStringType", + "traits": { + "smithy.api#documentation": "

The decrypted secret value, if the secret value was originally provided as a string or\n through the Secrets Manager console.

" + } + }, + "VersionStages": { + "target": "com.amazonaws.secretsmanager#SecretVersionStagesType", + "traits": { + "smithy.api#documentation": "

A list of all of the staging labels currently attached to this version of the\n secret.

" + } + }, + "CreatedDate": { + "target": "com.amazonaws.secretsmanager#CreatedDateType", + "traits": { + "smithy.api#documentation": "

The date the secret was created.

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

A structure that contains the secret value and other details for a secret.

" + } + }, + "com.amazonaws.secretsmanager#SecretValuesType": { + "type": "list", + "member": { + "target": "com.amazonaws.secretsmanager#SecretValueEntry" + } + }, + "com.amazonaws.secretsmanager#SecretVersionIdType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 32, + "max": 64 + } + } + }, + "com.amazonaws.secretsmanager#SecretVersionStageType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.secretsmanager#SecretVersionStagesType": { + "type": "list", + "member": { + "target": "com.amazonaws.secretsmanager#SecretVersionStageType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.secretsmanager#SecretVersionsListEntry": { + "type": "structure", + "members": { + "VersionId": { + "target": "com.amazonaws.secretsmanager#SecretVersionIdType", + "traits": { + "smithy.api#documentation": "

The unique version identifier of this version of the secret.

" + } + }, + "VersionStages": { + "target": "com.amazonaws.secretsmanager#SecretVersionStagesType", + "traits": { + "smithy.api#documentation": "

An array of staging labels that are currently associated with this version of the\n secret.

" + } + }, + "LastAccessedDate": { + "target": "com.amazonaws.secretsmanager#LastAccessedDateType", + "traits": { + "smithy.api#documentation": "

The date that this version of the secret was last accessed. Note that the resolution\n of this field is at the date level and does not include the time.

" + } + }, + "CreatedDate": { + "target": "com.amazonaws.secretsmanager#CreatedDateType", + "traits": { + "smithy.api#documentation": "

The date and time this version of the secret was created.

" + } + }, + "KmsKeyIds": { + "target": "com.amazonaws.secretsmanager#KmsKeyIdListType", + "traits": { + "smithy.api#documentation": "

The KMS keys used to encrypt the secret version.

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

A structure that contains information about one version of a secret.

" + } + }, + "com.amazonaws.secretsmanager#SecretVersionsListType": { + "type": "list", + "member": { + "target": "com.amazonaws.secretsmanager#SecretVersionsListEntry" + } + }, + "com.amazonaws.secretsmanager#SecretVersionsToStagesMapType": { + "type": "map", + "key": { + "target": "com.amazonaws.secretsmanager#SecretVersionIdType" + }, + "value": { + "target": "com.amazonaws.secretsmanager#SecretVersionStagesType" + } + }, + "com.amazonaws.secretsmanager#SortByType": { + "type": "enum", + "members": { + "created_date": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "created-date" + } + }, + "last_accessed_date": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "last-accessed-date" + } + }, + "last_changed_date": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "last-changed-date" + } + }, + "name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "name" + } + } + } + }, + "com.amazonaws.secretsmanager#SortOrderType": { + "type": "enum", + "members": { + "asc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "asc" + } + }, + "desc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "desc" + } + } + } + }, + "com.amazonaws.secretsmanager#StatusMessageType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "com.amazonaws.secretsmanager#StatusType": { + "type": "enum", + "members": { + "InSync": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InSync" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "InProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + } + } + }, + "com.amazonaws.secretsmanager#StopReplicationToReplica": { + "type": "operation", + "input": { + "target": "com.amazonaws.secretsmanager#StopReplicationToReplicaRequest" + }, + "output": { + "target": "com.amazonaws.secretsmanager#StopReplicationToReplicaResponse" + }, + "errors": [ + { + "target": "com.amazonaws.secretsmanager#InternalServiceError" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidParameterException" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidRequestException" + }, + { + "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the link between the replica secret and the primary secret and promotes the\n replica to a primary secret in the replica Region.

\n

You must call this operation from the Region in which you want to promote the replica\n to a primary secret.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:StopReplicationToReplica. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

" + } + }, + "com.amazonaws.secretsmanager#StopReplicationToReplicaRequest": { + "type": "structure", + "members": { + "SecretId": { + "target": "com.amazonaws.secretsmanager#SecretIdType", + "traits": { + "smithy.api#documentation": "

The name of the secret or the replica ARN. The replica ARN is the same as the original\n primary secret ARN expect the Region is changed to the replica Region.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.secretsmanager#StopReplicationToReplicaResponse": { + "type": "structure", + "members": { + "ARN": { + "target": "com.amazonaws.secretsmanager#SecretARNType", + "traits": { + "smithy.api#documentation": "

The ARN of the promoted secret. The ARN is the same as the original primary secret\n except the Region is changed.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.secretsmanager#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.secretsmanager#TagKeyType", + "traits": { + "smithy.api#documentation": "

The key identifier, or name, of the tag.

" + } + }, + "Value": { + "target": "com.amazonaws.secretsmanager#TagValueType", + "traits": { + "smithy.api#documentation": "

The string value associated with the key of the tag.

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

A structure that contains information about a tag.

" + } + }, + "com.amazonaws.secretsmanager#TagKeyListType": { + "type": "list", + "member": { + "target": "com.amazonaws.secretsmanager#TagKeyType" + } + }, + "com.amazonaws.secretsmanager#TagKeyType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.secretsmanager#TagListType": { + "type": "list", + "member": { + "target": "com.amazonaws.secretsmanager#Tag" + } + }, + "com.amazonaws.secretsmanager#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.secretsmanager#TagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.secretsmanager#InternalServiceError" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidParameterException" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidRequestException" + }, + { + "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of\n the secret's metadata. They are not associated with specific versions of the secret.\n This operation appends tags to the existing list of tags.

\n

For tag quotas and naming restrictions, see Service quotas for\n Tagging in the Amazon Web Services General Reference guide.

\n \n

If you use tags as part of your security strategy, then adding or removing a tag\n can change permissions. If successfully completing this operation would result in\n you losing your permissions for this secret, then the operation is blocked and\n returns an Access Denied error.

\n \n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:TagResource. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", + "smithy.api#examples": [ + { + "title": "To add tags to a secret", + "documentation": "The following example shows how to attach two tags each with a Key and Value to a secret. There is no output from this API. To see the result, use the DescribeSecret operation.", + "input": { + "SecretId": "MyExampleSecret", + "Tags": [ + { + "Key": "FirstTag", + "Value": "SomeValue" + }, + { + "Key": "SecondTag", + "Value": "AnotherValue" + } + ] + } + } + ] + } + }, + "com.amazonaws.secretsmanager#TagResourceRequest": { + "type": "structure", + "members": { + "SecretId": { + "target": "com.amazonaws.secretsmanager#SecretIdType", + "traits": { + "smithy.api#documentation": "

The identifier for the secret to attach tags to. You can specify either the Amazon\n Resource Name (ARN) or the friendly name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.secretsmanager#TagListType", + "traits": { + "smithy.api#documentation": "

The tags to attach to the secret as a JSON text string argument. Each element in the\n list consists of a Key and a Value.

\n

For storing multiple values, we recommend that you use a JSON text\n string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI\n in the Amazon Web Services CLI User Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.secretsmanager#TagValueType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.secretsmanager#TimestampType": { + "type": "timestamp" + }, + "com.amazonaws.secretsmanager#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.secretsmanager#UntagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.secretsmanager#InternalServiceError" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidParameterException" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidRequestException" + }, + { + "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes specific tags from a secret.

\n

This operation is idempotent. If a requested tag is not attached to the secret, no\n error is returned and the secret metadata is unchanged.

\n \n

If you use tags as part of your security strategy, then removing a tag can change\n permissions. If successfully completing this operation would result in you losing\n your permissions for this secret, then the operation is blocked and returns an\n Access Denied error.

\n \n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:UntagResource. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", + "smithy.api#examples": [ + { + "title": "To remove tags from a secret", + "documentation": "The following example shows how to remove two tags from a secret's metadata. For each, both the tag and the associated value are removed. There is no output from this API. To see the result, use the DescribeSecret operation.", + "input": { + "SecretId": "MyTestDatabaseSecret", + "TagKeys": [ + "FirstTag", + "SecondTag" + ] + } + } + ] + } + }, + "com.amazonaws.secretsmanager#UntagResourceRequest": { + "type": "structure", + "members": { + "SecretId": { + "target": "com.amazonaws.secretsmanager#SecretIdType", + "traits": { + "smithy.api#documentation": "

The ARN or name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.secretsmanager#TagKeyListType", + "traits": { + "smithy.api#documentation": "

A list of tag key names to remove from the secret. You don't specify the value. Both\n the key and its associated value are removed.

\n

This parameter requires a JSON text string argument.

\n

For storing multiple values, we recommend that you use a JSON text\n string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI\n in the Amazon Web Services CLI User Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.secretsmanager#UpdateSecret": { + "type": "operation", + "input": { + "target": "com.amazonaws.secretsmanager#UpdateSecretRequest" + }, + "output": { + "target": "com.amazonaws.secretsmanager#UpdateSecretResponse" + }, + "errors": [ + { + "target": "com.amazonaws.secretsmanager#DecryptionFailure" + }, + { + "target": "com.amazonaws.secretsmanager#EncryptionFailure" + }, + { + "target": "com.amazonaws.secretsmanager#InternalServiceError" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidParameterException" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidRequestException" + }, + { + "target": "com.amazonaws.secretsmanager#LimitExceededException" + }, + { + "target": "com.amazonaws.secretsmanager#MalformedPolicyDocumentException" + }, + { + "target": "com.amazonaws.secretsmanager#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.secretsmanager#ResourceExistsException" + }, + { + "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the details of a secret, including metadata and the secret value. To change\n the secret value, you can also use PutSecretValue.

\n

To change the rotation configuration of a secret, use RotateSecret\n instead.

\n

To change a secret so that it is managed by another service, you need to recreate the\n secret in that service. See Secrets Manager secrets\n managed by other Amazon Web Services services.

\n

We recommend you avoid calling UpdateSecret at a sustained rate of more\n than once every 10 minutes. When you call UpdateSecret to update the secret\n value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when\n there are more than 100, but it does not remove versions created less than 24 hours ago.\n If you update the secret value more than once every 10 minutes, you create more versions\n than Secrets Manager removes, and you will reach the quota for secret versions.

\n

If you include SecretString or SecretBinary to create a new\n secret version, Secrets Manager automatically moves the staging label AWSCURRENT to\n the new version. Then it attaches the label AWSPREVIOUS to the version that\n AWSCURRENT was removed from.

\n

If you call this operation with a ClientRequestToken that matches an\n existing version's VersionId, the operation results in an error. You can't\n modify an existing version, you can only create a new version. To remove a version,\n remove all staging labels from it. See UpdateSecretVersionStage.

\n

Secrets Manager generates a CloudTrail log entry when you call this action.\n Do not include sensitive information in request parameters except\n SecretBinary or SecretString because it might be logged.\n For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:UpdateSecret. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager. If you use a\n customer managed key, you must also have kms:GenerateDataKey,\n kms:Encrypt, and kms:Decrypt permissions on the key. If\n you change the KMS key and you don't have kms:Encrypt permission to the new\n key, Secrets Manager does not re-encrypt existing secret versions with the new key. For more\n information, see Secret encryption\n and decryption.

\n \n

When you enter commands in a command shell, there is a risk of the command history being accessed or utilities having access to your command parameters. This is a concern if the command includes the value of a secret. Learn how to Mitigate the risks of using command-line tools to store Secrets Manager secrets.

\n ", + "smithy.api#examples": [ + { + "title": "To create a new version of the encrypted secret value", + "documentation": "The following example shows how to create a new version of the secret by updating the SecretString field. Alternatively, you can use the put-secret-value operation.", + "input": { + "SecretId": "MyTestDatabaseSecret", + "SecretString": "{JSON STRING WITH CREDENTIALS}" + }, + "output": { + "ARN": "aws:arn:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE" + } + }, + { + "title": "To update the description of a secret", + "documentation": "The following example shows how to modify the description of a secret.", + "input": { + "SecretId": "MyTestDatabaseSecret", + "Description": "This is a new description for the secret.", + "ClientRequestToken": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + } + }, + { + "title": "To update the KMS key associated with a secret", + "documentation": "This example shows how to update the KMS customer managed key (CMK) used to encrypt the secret value. The KMS CMK must be in the same region as the secret.", + "input": { + "SecretId": "MyTestDatabaseSecret", + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + } + } + ] + } + }, + "com.amazonaws.secretsmanager#UpdateSecretRequest": { + "type": "structure", + "members": { + "SecretId": { + "target": "com.amazonaws.secretsmanager#SecretIdType", + "traits": { + "smithy.api#documentation": "

The ARN or name of the secret.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.secretsmanager#ClientRequestTokenType", + "traits": { + "smithy.api#documentation": "

If you include SecretString or SecretBinary, then Secrets Manager\n creates a new version for the secret, and this parameter specifies the unique identifier\n for the new version.

\n \n

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.

\n \n

If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it in the request.

\n

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.

", + "smithy.api#idempotencyToken": {} + } + }, + "Description": { + "target": "com.amazonaws.secretsmanager#DescriptionType", + "traits": { + "smithy.api#documentation": "

The description of the secret.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.secretsmanager#KmsKeyIdType", + "traits": { + "smithy.api#documentation": "

The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new\n secret versions as well as any existing versions with the staging labels\n AWSCURRENT, AWSPENDING, or AWSPREVIOUS. If\n you don't have kms:Encrypt permission to the new key, Secrets Manager does not\n re-encrypt existing secret versions with the new key. For more information about\n versions and staging labels, see Concepts:\n Version.

\n

A key alias is always prefixed by alias/, for example\n alias/aws/secretsmanager. For more information, see About\n aliases.

\n

If you set this to an empty string, Secrets Manager uses the Amazon Web Services managed key\n aws/secretsmanager. If this key doesn't already exist in your account,\n then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account\n automatically have access to use aws/secretsmanager. Creating\n aws/secretsmanager can result in a one-time significant delay in\n returning the result.

\n \n

You can only use the Amazon Web Services managed key\n aws/secretsmanager if you call this operation using credentials from\n the same Amazon Web Services account that owns the secret. If the secret is in a different\n account, then you must use a customer managed key and provide the ARN of that\n KMS key in this field. The user making the call must have\n permissions to both the secret and the KMS key in their respective\n accounts.

\n " + } + }, + "SecretBinary": { + "target": "com.amazonaws.secretsmanager#SecretBinaryType", + "traits": { + "smithy.api#documentation": "

The binary data to encrypt and store in the new version of the secret. We recommend\n that you store your binary data in a file and then pass the contents of the file as a\n parameter.

\n

Either SecretBinary or SecretString must have a value, but\n not both.

\n

You can't access this parameter in the Secrets Manager console.

\n

Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

" + } + }, + "SecretString": { + "target": "com.amazonaws.secretsmanager#SecretStringType", + "traits": { + "smithy.api#documentation": "

The text data to encrypt and store in the new version of the secret. We recommend you\n use a JSON structure of key/value pairs for your secret value.

\n

Either SecretBinary or SecretString must have a value, but\n not both.

\n

Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

" + } + }, + "Type": { + "target": "com.amazonaws.secretsmanager#MedeaTypeType", + "traits": { + "smithy.api#documentation": "

The exact string that identifies the third-party partner that holds the external\n secret. For more information, see Managed external secret\n partners.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.secretsmanager#UpdateSecretResponse": { + "type": "structure", + "members": { + "ARN": { + "target": "com.amazonaws.secretsmanager#SecretARNType", + "traits": { + "smithy.api#documentation": "

The ARN of the secret that was updated.

" + } + }, + "Name": { + "target": "com.amazonaws.secretsmanager#SecretNameType", + "traits": { + "smithy.api#documentation": "

The name of the secret that was updated.

" + } + }, + "VersionId": { + "target": "com.amazonaws.secretsmanager#SecretVersionIdType", + "traits": { + "smithy.api#documentation": "

If Secrets Manager created a new version of the secret during this operation, then\n VersionId contains the unique identifier of the new version.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.secretsmanager#UpdateSecretVersionStage": { + "type": "operation", + "input": { + "target": "com.amazonaws.secretsmanager#UpdateSecretVersionStageRequest" + }, + "output": { + "target": "com.amazonaws.secretsmanager#UpdateSecretVersionStageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.secretsmanager#InternalServiceError" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidParameterException" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidRequestException" + }, + { + "target": "com.amazonaws.secretsmanager#LimitExceededException" + }, + { + "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging\n labels to track a version as it progresses through the secret rotation process. Each\n staging label can be attached to only one version at a time. To add a staging label to a\n version when it is already attached to another version, Secrets Manager first removes it from the\n other version first and then attaches it to this one. For more information about\n versions and staging labels, see Concepts:\n Version.

\n

The staging labels that you specify in the VersionStage parameter are\n added to the existing list of staging labels for the version.

\n

You can move the AWSCURRENT staging label to this version by including it\n in this call.

\n \n

Whenever you move AWSCURRENT, Secrets Manager automatically moves the label\n AWSPREVIOUS to the version that AWSCURRENT was removed\n from.

\n \n

If this action results in the last label being removed from a version, then the\n version is considered to be 'deprecated' and can be deleted by Secrets Manager.

\n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:UpdateSecretVersionStage. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", + "smithy.api#examples": [ + { + "title": "To add a staging label attached to a version of a secret", + "documentation": "The following example shows you how to add a staging label to a version of a secret. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version.", + "input": { + "SecretId": "MyTestDatabaseSecret", + "VersionStage": "STAGINGLABEL1", + "MoveToVersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + } + }, + { + "title": "To delete a staging label attached to a version of a secret", + "documentation": "The following example shows you how to delete a staging label that is attached to a version of a secret. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version.", + "input": { + "SecretId": "MyTestDatabaseSecret", + "VersionStage": "STAGINGLABEL1", + "RemoveFromVersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + } + }, + { + "title": "To move a staging label from one version of a secret to another", + "documentation": "The following example shows you how to move a staging label that is attached to one version of a secret to a different version. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version.", + "input": { + "SecretId": "MyTestDatabaseSecret", + "VersionStage": "AWSCURRENT", + "RemoveFromVersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", + "MoveToVersionId": "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2" + }, + "output": { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + } + } + ] + } + }, + "com.amazonaws.secretsmanager#UpdateSecretVersionStageRequest": { + "type": "structure", + "members": { + "SecretId": { + "target": "com.amazonaws.secretsmanager#SecretIdType", + "traits": { + "smithy.api#documentation": "

The ARN or the name of the secret with the version and staging labelsto modify.

\n

For an ARN, we recommend that you specify a complete ARN rather\n than a partial ARN. See Finding a secret from a partial ARN.

", + "smithy.api#required": {} + } + }, + "VersionStage": { + "target": "com.amazonaws.secretsmanager#SecretVersionStageType", + "traits": { + "smithy.api#documentation": "

The staging label to add to this version.

", + "smithy.api#required": {} + } + }, + "RemoveFromVersionId": { + "target": "com.amazonaws.secretsmanager#SecretVersionIdType", + "traits": { + "smithy.api#documentation": "

The ID of the version that the staging label is to be removed from. If the staging\n label you are trying to attach to one version is already attached to a different\n version, then you must include this parameter and specify the version that the label is\n to be removed from. If the label is attached and you either do not specify this\n parameter, or the version ID does not match, then the operation fails.

" + } + }, + "MoveToVersionId": { + "target": "com.amazonaws.secretsmanager#SecretVersionIdType", + "traits": { + "smithy.api#documentation": "

The ID of the version to add the staging label to. To remove a label from a version,\n then do not specify this parameter.

\n

If the staging label is already attached to a different version of the secret, then\n you must also specify the RemoveFromVersionId parameter.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.secretsmanager#UpdateSecretVersionStageResponse": { + "type": "structure", + "members": { + "ARN": { + "target": "com.amazonaws.secretsmanager#SecretARNType", + "traits": { + "smithy.api#documentation": "

The ARN of the secret that was updated.

" + } + }, + "Name": { + "target": "com.amazonaws.secretsmanager#SecretNameType", + "traits": { + "smithy.api#documentation": "

The name of the secret that was updated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.secretsmanager#ValidateResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.secretsmanager#ValidateResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.secretsmanager#ValidateResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.secretsmanager#InternalServiceError" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidParameterException" + }, + { + "target": "com.amazonaws.secretsmanager#InvalidRequestException" + }, + { + "target": "com.amazonaws.secretsmanager#MalformedPolicyDocumentException" + }, + { + "target": "com.amazonaws.secretsmanager#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Validates that a resource policy does not grant a wide range of principals access to\n your secret. A resource-based policy is optional for secrets.

\n

The API performs three checks when validating the policy:

\n \n

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

\n

\n Required permissions:\n \n secretsmanager:ValidateResourcePolicy and\n secretsmanager:PutResourcePolicy. For more information, see \n IAM policy actions for Secrets Manager and Authentication\n and access control in Secrets Manager.

", + "smithy.api#examples": [ + { + "title": "To validate a resource-based policy to a secret", + "documentation": "The following example shows how to validate a resource-based policy to a secret.", + "input": { + "SecretId": "MyTestDatabaseSecret", + "ResourcePolicy": "{\n\"Version\":\"2012-10-17\",\n\"Statement\":[{\n\"Effect\":\"Allow\",\n\"Principal\":{\n\"AWS\":\"arn:aws:iam::123456789012:root\"\n},\n\"Action\":\"secretsmanager:GetSecretValue\",\n\"Resource\":\"*\"\n}]\n}" + }, + "output": { + "PolicyValidationPassed": true, + "ValidationErrors": [] + } + } + ] + } + }, + "com.amazonaws.secretsmanager#ValidateResourcePolicyRequest": { + "type": "structure", + "members": { + "SecretId": { + "target": "com.amazonaws.secretsmanager#SecretIdType", + "traits": { + "smithy.api#documentation": "

The ARN or name of the secret with the resource-based policy you want to\n validate.

" + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.secretsmanager#NonEmptyResourcePolicyType", + "traits": { + "smithy.api#documentation": "

A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in\n the string identifies who can access or manage this secret and its versions. For example\n policies, see Permissions\n policy examples.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.secretsmanager#ValidateResourcePolicyResponse": { + "type": "structure", + "members": { + "PolicyValidationPassed": { + "target": "com.amazonaws.secretsmanager#BooleanType", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

True if your policy passes validation, otherwise false.

" + } + }, + "ValidationErrors": { + "target": "com.amazonaws.secretsmanager#ValidationErrorsType", + "traits": { + "smithy.api#documentation": "

Validation errors if your policy didn't pass validation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.secretsmanager#ValidationErrorsEntry": { + "type": "structure", + "members": { + "CheckName": { + "target": "com.amazonaws.secretsmanager#NameType", + "traits": { + "smithy.api#documentation": "

Checks the name of the policy.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.secretsmanager#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Displays error messages if validation encounters problems during validation of the\n resource policy.

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

Displays errors that occurred during validation of the resource policy.

" + } + }, + "com.amazonaws.secretsmanager#ValidationErrorsType": { + "type": "list", + "member": { + "target": "com.amazonaws.secretsmanager#ValidationErrorsEntry" + } + }, + "com.amazonaws.secretsmanager#secretsmanager": { + "type": "service", + "version": "2017-10-17", + "operations": [ + { + "target": "com.amazonaws.secretsmanager#BatchGetSecretValue" + }, + { + "target": "com.amazonaws.secretsmanager#CancelRotateSecret" + }, + { + "target": "com.amazonaws.secretsmanager#CreateSecret" + }, + { + "target": "com.amazonaws.secretsmanager#DeleteResourcePolicy" + }, + { + "target": "com.amazonaws.secretsmanager#DeleteSecret" + }, + { + "target": "com.amazonaws.secretsmanager#DescribeSecret" + }, + { + "target": "com.amazonaws.secretsmanager#GetRandomPassword" + }, + { + "target": "com.amazonaws.secretsmanager#GetResourcePolicy" + }, + { + "target": "com.amazonaws.secretsmanager#GetSecretValue" + }, + { + "target": "com.amazonaws.secretsmanager#ListSecrets" + }, + { + "target": "com.amazonaws.secretsmanager#ListSecretVersionIds" + }, + { + "target": "com.amazonaws.secretsmanager#PutResourcePolicy" + }, + { + "target": "com.amazonaws.secretsmanager#PutSecretValue" + }, + { + "target": "com.amazonaws.secretsmanager#RemoveRegionsFromReplication" + }, + { + "target": "com.amazonaws.secretsmanager#ReplicateSecretToRegions" + }, + { + "target": "com.amazonaws.secretsmanager#RestoreSecret" + }, + { + "target": "com.amazonaws.secretsmanager#RotateSecret" + }, + { + "target": "com.amazonaws.secretsmanager#StopReplicationToReplica" + }, + { + "target": "com.amazonaws.secretsmanager#TagResource" + }, + { + "target": "com.amazonaws.secretsmanager#UntagResource" + }, + { + "target": "com.amazonaws.secretsmanager#UpdateSecret" + }, + { + "target": "com.amazonaws.secretsmanager#UpdateSecretVersionStage" + }, + { + "target": "com.amazonaws.secretsmanager#ValidateResourcePolicy" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Secrets Manager", + "arnNamespace": "secretsmanager", + "cloudFormationName": "SecretsManager", + "cloudTrailEventSource": "secretsmanager.amazonaws.com", + "docId": "secretsmanager-2017-10-17", + "endpointPrefix": "secretsmanager" + }, + "aws.auth#sigv4": { + "name": "secretsmanager" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Amazon Web Services Secrets Manager\n

Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.

\n

This guide provides descriptions of the Secrets Manager API. For more information about using this\n service, see the Amazon Web Services Secrets Manager User Guide.

\n

\n API Version\n

\n

This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.

\n

For a list of endpoints, see Amazon Web Services Secrets Manager \n endpoints.

\n

\n Support and Feedback for Amazon Web Services Secrets Manager\n

\n

We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more\n information about the Amazon Web Services Discussion Forums, see Forums\n Help.

\n

\n Logging API Requests\n

\n

Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services\n account and delivers log files to an Amazon S3 bucket. By using information that's collected\n by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the\n request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services\n CloudTrail, see Logging\n Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide.\n To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.

", + "smithy.api#title": "AWS Secrets Manager", + "smithy.rules#endpointBdd": { + "version": "1.1", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "string" + }, + "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" + } + }, + "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 + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-cn" + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + } + ], + "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://secretsmanager-fips.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://secretsmanager-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "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://secretsmanager-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "https://secretsmanager.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://secretsmanager.{Region}.amazonaws.com.cn", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://secretsmanager.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "https://secretsmanager.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "root": 2, + "nodeCount": 18, + "nodes": "/////wAAAAH/////AAAAAAAAABEAAAADAAAAAQAAAAQF9eEOAAAAAgAAAAUF9eEOAAAAAwAAAAsAAAAGAAAABAAAAAcF9eENAAAABQAAAAgF9eEMAAAABwX14QkAAAAJAAAACAX14QoAAAAKAAAACQX14QkF9eELAAAABAAAAA0AAAAMAAAABgX14QcF9eEIAAAABQAAAA4F9eEGAAAABgAAAA8F9eEGAAAABwX14QQAAAAQAAAACQX14QQF9eEFAAAAAwX14QEAAAASAAAABAX14QIF9eED" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "string" + }, + "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" + } + }, + "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": [ + { + "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" + }, + { + "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": [ + { + "fn": "stringEquals", + "argv": [ + "aws", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://secretsmanager-fips.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-us-gov", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://secretsmanager-fips.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://secretsmanager-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "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 + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://secretsmanager-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "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": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://secretsmanager.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-cn", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://secretsmanager.{Region}.amazonaws.com.cn", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-us-gov", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://secretsmanager.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://secretsmanager.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "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://secretsmanager.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager-fips.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://secretsmanager-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": { + "url": "https://secretsmanager.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + } + } +} diff --git a/codegen/aws-models/sqs.json b/codegen/aws-models/sqs.json new file mode 100644 index 0000000..9aadd79 --- /dev/null +++ b/codegen/aws-models/sqs.json @@ -0,0 +1,4361 @@ +{ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.sqs#AWSAccountIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#String" + } + }, + "com.amazonaws.sqs#ActionNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#String" + } + }, + "com.amazonaws.sqs#AddPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#AddPermissionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#OverLimit" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Adds a permission to a queue for a specific principal. This allows sharing\n access to the queue.

\n

When you create a queue, you have full control access rights for the queue. Only you,\n the owner of the queue, can grant or deny permissions to the queue. For more information\n about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS\n Developer Guide.

\n \n \n \n \n

Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.

\n " + } + }, + "com.amazonaws.sqs#AddPermissionRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon SQS queue to which permissions are added.

\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "Label": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The unique identification of the permission you're setting (for example,\n AliceSendMessage). Maximum 80 characters. Allowed characters include\n alphanumeric characters, hyphens (-), and underscores\n (_).

", + "smithy.api#required": {} + } + }, + "AWSAccountIds": { + "target": "com.amazonaws.sqs#AWSAccountIdList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account numbers of the principals who are to receive\n permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer\n Guide.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "AWSAccountId" + } + }, + "Actions": { + "target": "com.amazonaws.sqs#ActionNameList", + "traits": { + "smithy.api#documentation": "

The action the client wants to allow for the specified principal. Valid values: the\n name of any action or *.

\n

For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service\n Resource in the Amazon SQS Developer Guide.

\n

Specifying SendMessage, DeleteMessage, or\n ChangeMessageVisibility for ActionName.n also grants\n permissions for the corresponding batch versions of those actions:\n SendMessageBatch, DeleteMessageBatch, and\n ChangeMessageVisibilityBatch.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "ActionName" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#AmazonSQS": { + "type": "service", + "version": "2012-11-05", + "operations": [ + { + "target": "com.amazonaws.sqs#AddPermission" + }, + { + "target": "com.amazonaws.sqs#CancelMessageMoveTask" + }, + { + "target": "com.amazonaws.sqs#ChangeMessageVisibility" + }, + { + "target": "com.amazonaws.sqs#ChangeMessageVisibilityBatch" + }, + { + "target": "com.amazonaws.sqs#CreateQueue" + }, + { + "target": "com.amazonaws.sqs#DeleteMessage" + }, + { + "target": "com.amazonaws.sqs#DeleteMessageBatch" + }, + { + "target": "com.amazonaws.sqs#DeleteQueue" + }, + { + "target": "com.amazonaws.sqs#GetQueueAttributes" + }, + { + "target": "com.amazonaws.sqs#GetQueueUrl" + }, + { + "target": "com.amazonaws.sqs#ListDeadLetterSourceQueues" + }, + { + "target": "com.amazonaws.sqs#ListMessageMoveTasks" + }, + { + "target": "com.amazonaws.sqs#ListQueues" + }, + { + "target": "com.amazonaws.sqs#ListQueueTags" + }, + { + "target": "com.amazonaws.sqs#PurgeQueue" + }, + { + "target": "com.amazonaws.sqs#ReceiveMessage" + }, + { + "target": "com.amazonaws.sqs#RemovePermission" + }, + { + "target": "com.amazonaws.sqs#SendMessage" + }, + { + "target": "com.amazonaws.sqs#SendMessageBatch" + }, + { + "target": "com.amazonaws.sqs#SetQueueAttributes" + }, + { + "target": "com.amazonaws.sqs#StartMessageMoveTask" + }, + { + "target": "com.amazonaws.sqs#TagQueue" + }, + { + "target": "com.amazonaws.sqs#UntagQueue" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "SQS", + "arnNamespace": "sqs", + "cloudFormationName": "SQS", + "cloudTrailEventSource": "sqs.amazonaws.com", + "endpointPrefix": "sqs" + }, + "aws.auth#sigv4": { + "name": "sqs" + }, + "aws.protocols#awsJson1_0": {}, + "aws.protocols#awsQueryCompatible": {}, + "smithy.api#documentation": "

Welcome to the Amazon SQS API Reference.

\n

Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel\n between applications or microservices. Amazon SQS moves data between distributed application\n components and helps you decouple these components.

\n

For information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer\n Guide.\n

\n

You can use Amazon Web Services SDKs to access\n Amazon SQS using your favorite programming language. The SDKs perform tasks such as the\n following automatically:

\n \n

\n Additional information\n

\n ", + "smithy.api#title": "Amazon Simple Queue Service", + "smithy.rules#endpointBdd": { + "version": "1.1", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "string" + }, + "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" + } + }, + "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 + ] + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + } + ], + "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://sqs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "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://sqs.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://sqs-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "https://sqs.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": "https://sqs.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "root": 2, + "nodeCount": 14, + "nodes": "/////wAAAAH/////AAAAAAAAAA0AAAADAAAAAQAAAAQF9eEMAAAAAgAAAAUF9eEMAAAAAwAAAAgAAAAGAAAABAAAAAcF9eELAAAABQX14QkF9eEKAAAABAAAAAsAAAAJAAAABgAAAAoF9eEIAAAABwX14QYF9eEHAAAABQAAAAwF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAAOAAAABAX14QIF9eED" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "string" + }, + "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" + } + }, + "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": [ + { + "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" + }, + { + "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://sqs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "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 + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + } + ], + "endpoint": { + "url": "https://sqs.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://sqs-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "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": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://sqs.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "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://sqs.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://sqs.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.sqs#AttributeNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#QueueAttributeName" + } + }, + "com.amazonaws.sqs#BatchEntryIdsNotDistinct": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.BatchEntryIdsNotDistinct", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Two or more batch entries in the request have the same Id.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#BatchRequestTooLong": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.BatchRequestTooLong", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The length of all the messages put together is more than the limit.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#BatchResultErrorEntry": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The Id of an entry in a batch request.

", + "smithy.api#required": {} + } + }, + "SenderFault": { + "target": "com.amazonaws.sqs#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the error happened due to the caller of the batch API action.

", + "smithy.api#required": {} + } + }, + "Code": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An error code representing why the action failed on this entry.

", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

A message explaining why the action failed on this entry.

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

Gives a detailed description of the result of an action on each entry in the\n request.

" + } + }, + "com.amazonaws.sqs#BatchResultErrorEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#BatchResultErrorEntry" + } + }, + "com.amazonaws.sqs#Binary": { + "type": "blob" + }, + "com.amazonaws.sqs#BinaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#Binary", + "traits": { + "smithy.api#xmlName": "BinaryListValue" + } + } + }, + "com.amazonaws.sqs#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.sqs#BoxedInteger": { + "type": "integer" + }, + "com.amazonaws.sqs#CancelMessageMoveTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#CancelMessageMoveTaskRequest" + }, + "output": { + "target": "com.amazonaws.sqs#CancelMessageMoveTaskResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels a specified message movement task. A message movement can only be cancelled\n when the current status is RUNNING. Cancelling a message movement task does not revert\n the messages that have already been moved. It can only stop the messages that have not\n been moved yet.

\n \n \n " + } + }, + "com.amazonaws.sqs#CancelMessageMoveTaskRequest": { + "type": "structure", + "members": { + "TaskHandle": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An identifier associated with a message movement task.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#CancelMessageMoveTaskResult": { + "type": "structure", + "members": { + "ApproximateNumberOfMessagesMoved": { + "target": "com.amazonaws.sqs#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The approximate number of messages already moved to the destination queue.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#ChangeMessageVisibility": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#ChangeMessageVisibilityRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#MessageNotInflight" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#ReceiptHandleIsInvalid" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Changes the visibility timeout of a specified message in a queue to a new value. The\n default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The\n maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.

\n

For example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed\n since you received the message, and you send a ChangeMessageVisibility call with\n VisibilityTimeout set to 10 seconds, the 10 seconds begin to count from\n the time that you make the ChangeMessageVisibility call. Thus, any attempt\n to change the visibility timeout or to delete that message 10 seconds after you\n initially change the visibility timeout (a total of 25 seconds) might result in an\n error.

\n

An Amazon SQS message has three basic states:

\n
    \n
  1. \n

    Sent to a queue by a producer.

    \n
    2. \n
  2. \n

    Received from the queue by a consumer.

    \n
    3. \n
  3. \n

    Deleted from the queue.

    \n
    4. \n
\n

A message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages.\n A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of in flight messages.

\n

Limits that apply to in flight messages are unrelated to the unlimited number of stored messages.

\n

For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). \n If you reach this limit, Amazon SQS returns the OverLimit error message.\n To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages.\n To request a limit increase, file a support request.

\n

For FIFO queues, there can be a maximum of 120,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.

\n \n

If you attempt to set the VisibilityTimeout to a value greater than\n the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically\n recalculate and increase the timeout to the maximum remaining time.

\n

Unlike with a queue, when you change the visibility timeout for a specific message\n the timeout value is applied immediately but isn't saved in memory for that message.\n If you don't delete a message after it is received, the visibility timeout for the\n message reverts to the original timeout value (not to the value you set using the\n ChangeMessageVisibility action) the next time the message is\n received.

\n " + } + }, + "com.amazonaws.sqs#ChangeMessageVisibilityBatch": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#ChangeMessageVisibilityBatchRequest" + }, + "output": { + "target": "com.amazonaws.sqs#ChangeMessageVisibilityBatchResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#BatchEntryIdsNotDistinct" + }, + { + "target": "com.amazonaws.sqs#EmptyBatchRequest" + }, + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidBatchEntryId" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#TooManyEntriesInBatchRequest" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Changes the visibility timeout of multiple messages. This is a batch version of\n \n ChangeMessageVisibility. The result of the action\n on each message is reported individually in the response. You can send up to 10\n \n ChangeMessageVisibility\n requests with each\n ChangeMessageVisibilityBatch action.

\n \n

Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

\n " + } + }, + "com.amazonaws.sqs#ChangeMessageVisibilityBatchRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon SQS queue whose messages' visibility is changed.

\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "Entries": { + "target": "com.amazonaws.sqs#ChangeMessageVisibilityBatchRequestEntryList", + "traits": { + "smithy.api#documentation": "

Lists the receipt handles of the messages for which the visibility timeout must be\n changed.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "ChangeMessageVisibilityBatchRequestEntry" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#ChangeMessageVisibilityBatchRequestEntry": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An identifier for this particular receipt handle used to communicate the\n result.

\n \n

The Ids of a batch request need to be unique within a request.

\n

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

\n ", + "smithy.api#required": {} + } + }, + "ReceiptHandle": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

A receipt handle.

", + "smithy.api#required": {} + } + }, + "VisibilityTimeout": { + "target": "com.amazonaws.sqs#NullableInteger", + "traits": { + "smithy.api#documentation": "

The new value (in seconds) for the message's visibility timeout.

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

Encloses a receipt handle and an entry ID for each message in \n ChangeMessageVisibilityBatch.\n

" + } + }, + "com.amazonaws.sqs#ChangeMessageVisibilityBatchRequestEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#ChangeMessageVisibilityBatchRequestEntry" + } + }, + "com.amazonaws.sqs#ChangeMessageVisibilityBatchResult": { + "type": "structure", + "members": { + "Successful": { + "target": "com.amazonaws.sqs#ChangeMessageVisibilityBatchResultEntryList", + "traits": { + "smithy.api#documentation": "

A list of \n ChangeMessageVisibilityBatchResultEntry\n \n items.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "ChangeMessageVisibilityBatchResultEntry" + } + }, + "Failed": { + "target": "com.amazonaws.sqs#BatchResultErrorEntryList", + "traits": { + "smithy.api#documentation": "

A list of \n BatchResultErrorEntry\n items.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "BatchResultErrorEntry" + } + } + }, + "traits": { + "smithy.api#documentation": "

For each message in the batch, the response contains a \n ChangeMessageVisibilityBatchResultEntry\n tag if the message\n succeeds or a \n BatchResultErrorEntry\n tag if the message\n fails.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#ChangeMessageVisibilityBatchResultEntry": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

Represents a message whose visibility timeout has been changed successfully.

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

Encloses the Id of an entry in \n ChangeMessageVisibilityBatch.\n

" + } + }, + "com.amazonaws.sqs#ChangeMessageVisibilityBatchResultEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#ChangeMessageVisibilityBatchResultEntry" + } + }, + "com.amazonaws.sqs#ChangeMessageVisibilityRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon SQS queue whose message's visibility is changed.

\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "ReceiptHandle": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The receipt handle associated with the message, whose visibility timeout is changed.\n This parameter is returned by the \n ReceiveMessage\n \n action.

", + "smithy.api#required": {} + } + }, + "VisibilityTimeout": { + "target": "com.amazonaws.sqs#NullableInteger", + "traits": { + "smithy.api#documentation": "

The new value for the message's visibility timeout (in seconds). Values range:\n 0 to 43200. Maximum: 12 hours.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#CreateQueue": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#CreateQueueRequest" + }, + "output": { + "target": "com.amazonaws.sqs#CreateQueueResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidAttributeName" + }, + { + "target": "com.amazonaws.sqs#InvalidAttributeValue" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDeletedRecently" + }, + { + "target": "com.amazonaws.sqs#QueueNameExists" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new standard or FIFO queue. You can pass one or more attributes in\n the request. Keep the following in mind:

\n \n

To successfully create a new queue, you must provide a queue name that adheres to the\n limits\n related to queues and is unique within the scope of your queues.

\n \n

After you create a queue, you must wait at least one second after the queue is\n created to be able to use the queue.

\n \n

To retrieve the URL of a queue, use the \n GetQueueUrl\n action. This action only requires the \n QueueName\n parameter.

\n

When creating queues, keep the following points in mind:

\n \n \n

Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.

\n " + } + }, + "com.amazonaws.sqs#CreateQueueRequest": { + "type": "structure", + "members": { + "QueueName": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The name of the new queue. The following limits apply to this name:

\n \n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "Attributes": { + "target": "com.amazonaws.sqs#QueueAttributeMap", + "traits": { + "smithy.api#documentation": "

A map of attributes with their corresponding values.

\n

The following lists the names, descriptions, and values of the special request\n parameters that the CreateQueue action uses:

\n \n

The following attributes apply only to dead-letter queues:\n

\n \n \n

The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.

\n \n

The following attributes apply only to server-side-encryption:

\n \n

The following attributes apply only to FIFO (first-in-first-out)\n queues:

\n \n

The following attributes apply only to \nhigh throughput\nfor FIFO queues:

\n \n

To enable high throughput for FIFO queues, do the following:

\n \n

If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.

\n

For information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Attribute" + } + }, + "tags": { + "target": "com.amazonaws.sqs#TagMap", + "traits": { + "smithy.api#documentation": "

Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.

\n

When you use queue tags, keep the following guidelines in mind:

\n \n

For a full list of tag restrictions, see \nQuotas related to queues \nin the Amazon SQS Developer Guide.

\n \n

To be able to tag a queue on creation, you must have the\n sqs:CreateQueue and sqs:TagQueue permissions.

\n

Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.

\n ", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Tag" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#CreateQueueResult": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the created Amazon SQS queue.

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

Returns the QueueUrl attribute of the created queue.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#DeleteMessage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#DeleteMessageRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidIdFormat" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#ReceiptHandleIsInvalid" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified message from the specified queue. To select the message to\n delete, use the ReceiptHandle of the message (not the\n MessageId which you receive when you send the message). Amazon SQS can\n delete a message from a queue even if a visibility timeout setting causes the message to\n be locked by another consumer. Amazon SQS automatically deletes messages left in a queue\n longer than the retention period configured for the queue.

\n \n

Each time you receive a message, meaning when a consumer retrieves a message from\n the queue, it comes with a unique ReceiptHandle. If you receive the\n same message more than once, you will get a different ReceiptHandle\n each time. When you want to delete a message using the DeleteMessage\n action, you must use the ReceiptHandle from the most recent time you\n received the message. If you use an old ReceiptHandle, the request will\n succeed, but the message might not be deleted.

\n

For standard queues, it is possible to receive a message even after you\n delete it. This might happen on rare occasions if one of the servers which stores a\n copy of the message is unavailable when you send the request to delete the message.\n The copy remains on the server and might be returned to you during a subsequent\n receive request. You should ensure that your application is idempotent, so that\n receiving a message more than once does not cause issues.

\n " + } + }, + "com.amazonaws.sqs#DeleteMessageBatch": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#DeleteMessageBatchRequest" + }, + "output": { + "target": "com.amazonaws.sqs#DeleteMessageBatchResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#BatchEntryIdsNotDistinct" + }, + { + "target": "com.amazonaws.sqs#EmptyBatchRequest" + }, + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidBatchEntryId" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#TooManyEntriesInBatchRequest" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes up to ten messages from the specified queue. This is a batch version of\n \n DeleteMessage. The result of the action on each\n message is reported individually in the response.

\n \n

Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

\n " + } + }, + "com.amazonaws.sqs#DeleteMessageBatchRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon SQS queue from which messages are deleted.

\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "Entries": { + "target": "com.amazonaws.sqs#DeleteMessageBatchRequestEntryList", + "traits": { + "smithy.api#documentation": "

Lists the receipt handles for the messages to be deleted.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "DeleteMessageBatchRequestEntry" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#DeleteMessageBatchRequestEntry": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The identifier for this particular receipt handle. This is used to communicate the\n result.

\n \n

The Ids of a batch request need to be unique within a request.

\n

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

\n ", + "smithy.api#required": {} + } + }, + "ReceiptHandle": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

A receipt handle.

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

Encloses a receipt handle and an identifier for it.

" + } + }, + "com.amazonaws.sqs#DeleteMessageBatchRequestEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#DeleteMessageBatchRequestEntry" + } + }, + "com.amazonaws.sqs#DeleteMessageBatchResult": { + "type": "structure", + "members": { + "Successful": { + "target": "com.amazonaws.sqs#DeleteMessageBatchResultEntryList", + "traits": { + "smithy.api#documentation": "

A list of \n DeleteMessageBatchResultEntry\n items.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "DeleteMessageBatchResultEntry" + } + }, + "Failed": { + "target": "com.amazonaws.sqs#BatchResultErrorEntryList", + "traits": { + "smithy.api#documentation": "

A list of \n BatchResultErrorEntry\n items.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "BatchResultErrorEntry" + } + } + }, + "traits": { + "smithy.api#documentation": "

For each message in the batch, the response contains a \n DeleteMessageBatchResultEntry\n tag if the message is deleted\n or a \n BatchResultErrorEntry\n tag if the message can't be\n deleted.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#DeleteMessageBatchResultEntry": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

Represents a successfully deleted message.

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

Encloses the Id of an entry in \n DeleteMessageBatch.\n

" + } + }, + "com.amazonaws.sqs#DeleteMessageBatchResultEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#DeleteMessageBatchResultEntry" + } + }, + "com.amazonaws.sqs#DeleteMessageRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon SQS queue from which messages are deleted.

\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "ReceiptHandle": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The receipt handle associated with the message to delete.

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

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#DeleteQueue": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#DeleteQueueRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the queue specified by the QueueUrl, regardless of the queue's\n contents.

\n \n

Be careful with the DeleteQueue action: When you delete a queue, any\n messages in the queue are no longer available.

\n \n

When you delete a queue, the deletion process takes up to 60 seconds. Requests you\n send involving that queue during the 60 seconds might succeed. For example, a\n \n SendMessage\n request might succeed, but after 60\n seconds the queue and the message you sent no longer exist.

\n

When you delete a queue, you must wait at least 60 seconds before creating a queue\n with the same name.

\n \n

Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.

\n

The delete operation uses the HTTP GET verb.

\n " + } + }, + "com.amazonaws.sqs#DeleteQueueRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon SQS queue to delete.

\n

Queue URLs and names are case-sensitive.

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

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#EmptyBatchRequest": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.EmptyBatchRequest", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The batch request doesn't contain any entries.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#ExceptionMessage": { + "type": "string" + }, + "com.amazonaws.sqs#GetQueueAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#GetQueueAttributesRequest" + }, + "output": { + "target": "com.amazonaws.sqs#GetQueueAttributesResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidAttributeName" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Gets attributes for the specified queue.

\n \n

To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

\n " + } + }, + "com.amazonaws.sqs#GetQueueAttributesRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon SQS queue whose attribute information is retrieved.

\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "AttributeNames": { + "target": "com.amazonaws.sqs#AttributeNameList", + "traits": { + "smithy.api#documentation": "

A list of attributes for which to retrieve information.

\n

The AttributeNames parameter is optional, but if you don't specify values\n for this parameter, the request returns empty results.

\n \n

In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

\n \n

The following attributes are supported:

\n \n

The ApproximateNumberOfMessagesDelayed,\n ApproximateNumberOfMessagesNotVisible, and\n ApproximateNumberOfMessages metrics may not achieve consistency\n until at least 1 minute after the producers stop sending messages. This period is\n required for the queue metadata to reach eventual consistency.

\n \n \n

The following attributes apply only to dead-letter queues:\n

\n \n \n

The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.

\n \n

The following attributes apply only to server-side-encryption:

\n \n

The following attributes apply only to FIFO (first-in-first-out)\n queues:

\n \n

The following attributes apply only to \nhigh throughput\nfor FIFO queues:

\n \n

To enable high throughput for FIFO queues, do the following:

\n \n

If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.

\n

For information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "AttributeName" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#GetQueueAttributesResult": { + "type": "structure", + "members": { + "Attributes": { + "target": "com.amazonaws.sqs#QueueAttributeMap", + "traits": { + "smithy.api#documentation": "

A map of attributes to their respective values.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Attribute" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of returned queue attributes.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#GetQueueUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#GetQueueUrlRequest" + }, + "output": { + "target": "com.amazonaws.sqs#GetQueueUrlResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

The GetQueueUrl API returns the URL of an existing Amazon SQS queue. This is\n useful when you know the queue's name but need to retrieve its URL for further\n operations.

\n

To access a queue owned by another Amazon Web Services account, use the\n QueueOwnerAWSAccountId parameter to specify the account ID of the\n queue's owner. Note that the queue owner must grant you the necessary permissions to\n access the queue. For more information about accessing shared queues, see the\n \n AddPermission\n API or Allow developers to write messages to a shared queue in the Amazon SQS\n Developer Guide.

" + } + }, + "com.amazonaws.sqs#GetQueueUrlRequest": { + "type": "structure", + "members": { + "QueueName": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

(Required) The name of the queue for which you want to fetch the URL. The name can be\n up to 80 characters long and can include alphanumeric characters, hyphens (-), and\n underscores (_). Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "QueueOwnerAWSAccountId": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

(Optional) The Amazon Web Services account ID of the account that created the queue. This is only\n required when you are attempting to access a queue owned by another\n Amazon Web Services account.

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

Retrieves the URL of an existing queue based on its name and, optionally, the Amazon Web Services\n account ID.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#GetQueueUrlResult": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the queue.

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

For more information, see Interpreting Responses in the Amazon SQS Developer\n Guide.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#InvalidAddress": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidAddress", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified ID is invalid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.sqs#InvalidAttributeName": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified attribute doesn't exist.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.sqs#InvalidAttributeValue": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

A queue attribute value is invalid.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.sqs#InvalidBatchEntryId": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.InvalidBatchEntryId", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The Id of a batch entry in a batch request doesn't abide by the\n specification.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#InvalidIdFormat": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#deprecated": { + "message": "exception has been included in ReceiptHandleIsInvalid" + }, + "smithy.api#documentation": "

The specified receipt handle isn't valid for the current version.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.sqs#InvalidMessageContents": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The message contains characters outside the allowed set.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.sqs#InvalidSecurity": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidSecurity", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

The request was not made over HTTPS or did not use SigV4 for signing.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sqs#KmsAccessDenied": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMS.AccessDeniedException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The caller doesn't have the required KMS access.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#KmsDisabled": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMS.DisabledException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was denied due to request throttling.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#KmsInvalidKeyUsage": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMS.InvalidKeyUsageException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected for one of the following reasons:

\n ", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#KmsInvalidState": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMS.InvalidStateException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the state of the specified resource is not valid for\n this request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#KmsNotFound": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMS.NotFoundException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the specified entity or resource could not be found.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#KmsOptInRequired": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMS.OptInRequired", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

The request was rejected because the specified key policy isn't syntactically or\n semantically correct.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sqs#KmsThrottled": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMS.ThrottlingException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Amazon Web Services KMS throttles requests for the following conditions.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#ListDeadLetterSourceQueues": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#ListDeadLetterSourceQueuesRequest" + }, + "output": { + "target": "com.amazonaws.sqs#ListDeadLetterSourceQueuesResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of your queues that have the RedrivePolicy queue attribute\n configured with a dead-letter queue.

\n

The ListDeadLetterSourceQueues methods supports pagination. Set\n parameter MaxResults in the request to specify the maximum number of\n results to be returned in the response. If you do not set MaxResults, the\n response includes a maximum of 1,000 results. If you set MaxResults and\n there are additional results to display, the response includes a value for\n NextToken. Use NextToken as a parameter in your next\n request to ListDeadLetterSourceQueues to receive the next page of results.

\n

For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer\n Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "queueUrls", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sqs#ListDeadLetterSourceQueuesRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of a dead-letter queue.

\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sqs#Token", + "traits": { + "smithy.api#documentation": "

Pagination token to request the next set of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sqs#BoxedInteger", + "traits": { + "smithy.api#documentation": "

Maximum number of results to include in the response. Value range is 1 to 1000. You\n must set MaxResults to receive a value for NextToken in the\n response.

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

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#ListDeadLetterSourceQueuesResult": { + "type": "structure", + "members": { + "queueUrls": { + "target": "com.amazonaws.sqs#QueueUrlList", + "traits": { + "smithy.api#documentation": "

A list of source queue URLs that have the RedrivePolicy queue attribute\n configured with a dead-letter queue.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "QueueUrl" + } + }, + "NextToken": { + "target": "com.amazonaws.sqs#Token", + "traits": { + "smithy.api#documentation": "

Pagination token to include in the next request. Token value is null if\n there are no additional results to request, or if you did not set\n MaxResults in the request.

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

A list of your dead letter source queues.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#ListMessageMoveTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#ListMessageMoveTasksRequest" + }, + "output": { + "target": "com.amazonaws.sqs#ListMessageMoveTasksResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the most recent message movement tasks (up to 10) under a specific source\n queue.

\n \n \n " + } + }, + "com.amazonaws.sqs#ListMessageMoveTasksRequest": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The ARN of the queue whose message movement tasks are to be listed.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.sqs#NullableInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of results to include in the response. The default is 1, which\n provides the most recent message movement task. The upper limit is 10.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#ListMessageMoveTasksResult": { + "type": "structure", + "members": { + "Results": { + "target": "com.amazonaws.sqs#ListMessageMoveTasksResultEntryList", + "traits": { + "smithy.api#documentation": "

A list of message movement tasks and their attributes.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "ListMessageMoveTasksResultEntry" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#xmlName": "ListMessageMoveTasksResult" + } + }, + "com.amazonaws.sqs#ListMessageMoveTasksResultEntry": { + "type": "structure", + "members": { + "TaskHandle": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An identifier associated with a message movement task. When this field is returned in\n the response of the ListMessageMoveTasks action, it is only populated for\n tasks that are in RUNNING status.

" + } + }, + "Status": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The status of the message movement task. Possible values are: RUNNING, COMPLETED,\n CANCELLING, CANCELLED, and FAILED.

" + } + }, + "SourceArn": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The ARN of the queue that contains the messages to be moved to another queue.

" + } + }, + "DestinationArn": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The ARN of the destination queue if it has been specified in the\n StartMessageMoveTask request. If a DestinationArn has not\n been specified in the StartMessageMoveTask request, this field value will\n be NULL.

" + } + }, + "MaxNumberOfMessagesPerSecond": { + "target": "com.amazonaws.sqs#NullableInteger", + "traits": { + "smithy.api#documentation": "

The number of messages to be moved per second (the message movement rate), if it has\n been specified in the StartMessageMoveTask request. If a\n MaxNumberOfMessagesPerSecond has not been specified in the\n StartMessageMoveTask request, this field value will be NULL.

" + } + }, + "ApproximateNumberOfMessagesMoved": { + "target": "com.amazonaws.sqs#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The approximate number of messages already moved to the destination queue.

" + } + }, + "ApproximateNumberOfMessagesToMove": { + "target": "com.amazonaws.sqs#NullableLong", + "traits": { + "smithy.api#documentation": "

The number of messages to be moved from the source queue. This number is obtained at\n the time of starting the message movement task and is only included after the message\n movement task is selected to start.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The task failure reason (only included if the task status is FAILED).

" + } + }, + "StartedTimestamp": { + "target": "com.amazonaws.sqs#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The timestamp of starting the message movement task.

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

Contains the details of a message movement task.

" + } + }, + "com.amazonaws.sqs#ListMessageMoveTasksResultEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#ListMessageMoveTasksResultEntry" + } + }, + "com.amazonaws.sqs#ListQueueTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#ListQueueTagsRequest" + }, + "output": { + "target": "com.amazonaws.sqs#ListQueueTagsResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

List all cost allocation tags added to the specified Amazon SQS queue.\n For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.

\n \n

Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.

\n " + } + }, + "com.amazonaws.sqs#ListQueueTagsRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the queue.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#ListQueueTagsResult": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.sqs#TagMap", + "traits": { + "smithy.api#documentation": "

The list of all tags added to the specified queue.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Tag" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#ListQueues": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#ListQueuesRequest" + }, + "output": { + "target": "com.amazonaws.sqs#ListQueuesResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of your queues in the current region. The response includes a maximum\n of 1,000 results. If you specify a value for the optional QueueNamePrefix\n parameter, only queues with a name that begins with the specified value are\n returned.

\n

The listQueues methods supports pagination. Set parameter\n MaxResults in the request to specify the maximum number of results to\n be returned in the response. If you do not set MaxResults, the response\n includes a maximum of 1,000 results. If you set MaxResults and there are\n additional results to display, the response includes a value for NextToken.\n Use NextToken as a parameter in your next request to\n listQueues to receive the next page of results.

\n \n

Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "QueueUrls", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sqs#ListQueuesRequest": { + "type": "structure", + "members": { + "QueueNamePrefix": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

A string to use for filtering the list results. Only those queues whose name begins\n with the specified string are returned.

\n

Queue URLs and names are case-sensitive.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sqs#Token", + "traits": { + "smithy.api#documentation": "

Pagination token to request the next set of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sqs#BoxedInteger", + "traits": { + "smithy.api#documentation": "

Maximum number of results to include in the response. Value range is 1 to 1000. You\n must set MaxResults to receive a value for NextToken in the\n response.

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

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#ListQueuesResult": { + "type": "structure", + "members": { + "QueueUrls": { + "target": "com.amazonaws.sqs#QueueUrlList", + "traits": { + "smithy.api#documentation": "

A list of queue URLs, up to 1,000 entries, or the value of MaxResults\n that you sent in the request.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "QueueUrl" + } + }, + "NextToken": { + "target": "com.amazonaws.sqs#Token", + "traits": { + "smithy.api#documentation": "

Pagination token to include in the next request. Token value is null if\n there are no additional results to request, or if you did not set\n MaxResults in the request.

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

A list of your queues.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#Long": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.sqs#Message": { + "type": "structure", + "members": { + "MessageId": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

A unique identifier for the message. A MessageIdis considered unique\n across all Amazon Web Services accounts for an extended period of time.

" + } + }, + "ReceiptHandle": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An identifier associated with the act of receiving the message. A new receipt handle\n is returned every time you receive a message. When deleting a message, you provide the\n last received receipt handle to delete the message.

" + } + }, + "MD5OfBody": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An MD5 digest of the non-URL-encoded message body string.

" + } + }, + "Body": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The message's contents (not URL-encoded).

" + } + }, + "Attributes": { + "target": "com.amazonaws.sqs#MessageSystemAttributeMap", + "traits": { + "smithy.api#documentation": "

A map of the attributes requested in \n ReceiveMessage\n to\n their respective values. Supported attributes:

\n \n

\n ApproximateFirstReceiveTimestamp and SentTimestamp are each\n returned as an integer representing the epoch time in\n milliseconds.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Attribute" + } + }, + "MD5OfMessageAttributes": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

" + } + }, + "MessageAttributes": { + "target": "com.amazonaws.sqs#MessageBodyAttributeMap", + "traits": { + "smithy.api#documentation": "

Each message attribute consists of a Name, Type, \nand Value. For more information, see \nAmazon SQS \nmessage attributes in the Amazon SQS Developer Guide.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "MessageAttribute" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Amazon SQS message.

" + } + }, + "com.amazonaws.sqs#MessageAttributeName": { + "type": "string" + }, + "com.amazonaws.sqs#MessageAttributeNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#MessageAttributeName" + } + }, + "com.amazonaws.sqs#MessageAttributeValue": { + "type": "structure", + "members": { + "StringValue": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable\n Characters.

" + } + }, + "BinaryValue": { + "target": "com.amazonaws.sqs#Binary", + "traits": { + "smithy.api#documentation": "

Binary type attributes can store any binary data, such as compressed data, encrypted\n data, or images.

" + } + }, + "StringListValues": { + "target": "com.amazonaws.sqs#StringList", + "traits": { + "smithy.api#documentation": "

Not implemented. Reserved for future use.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "StringListValue" + } + }, + "BinaryListValues": { + "target": "com.amazonaws.sqs#BinaryList", + "traits": { + "smithy.api#documentation": "

Not implemented. Reserved for future use.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "BinaryListValue" + } + }, + "DataType": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

Amazon SQS supports the following logical data types: String,\n Number, and Binary. For the Number data type,\n you must use StringValue.

\n

You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer\n Guide.

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

The user-specified message attribute value. For string data types, the\n Value attribute has the same restrictions on the content as the message\n body. For more information, see \n SendMessage.\n

\n

\n Name, type, value and the message body must not\n be empty or null. All parts of the message attribute, including Name,\n Type, and Value, are part of the message size restriction\n (1 MiB or 1,048,576 bytes).

" + } + }, + "com.amazonaws.sqs#MessageBodyAttributeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#xmlName": "Name" + } + }, + "value": { + "target": "com.amazonaws.sqs#MessageAttributeValue", + "traits": { + "smithy.api#xmlName": "Value" + } + } + }, + "com.amazonaws.sqs#MessageBodySystemAttributeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sqs#MessageSystemAttributeNameForSends", + "traits": { + "smithy.api#xmlName": "Name" + } + }, + "value": { + "target": "com.amazonaws.sqs#MessageSystemAttributeValue", + "traits": { + "smithy.api#xmlName": "Value" + } + } + }, + "com.amazonaws.sqs#MessageList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#Message" + } + }, + "com.amazonaws.sqs#MessageNotInflight": { + "type": "structure", + "members": {}, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.MessageNotInflight", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified message isn't in flight.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#MessageSystemAttributeList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#MessageSystemAttributeName" + } + }, + "com.amazonaws.sqs#MessageSystemAttributeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sqs#MessageSystemAttributeName", + "traits": { + "smithy.api#xmlName": "Name" + } + }, + "value": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#xmlName": "Value" + } + } + }, + "com.amazonaws.sqs#MessageSystemAttributeName": { + "type": "enum", + "members": { + "All": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "All" + } + }, + "SenderId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SenderId" + } + }, + "SentTimestamp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SentTimestamp" + } + }, + "ApproximateReceiveCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ApproximateReceiveCount" + } + }, + "ApproximateFirstReceiveTimestamp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ApproximateFirstReceiveTimestamp" + } + }, + "SequenceNumber": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SequenceNumber" + } + }, + "MessageDeduplicationId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MessageDeduplicationId" + } + }, + "MessageGroupId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MessageGroupId" + } + }, + "AWSTraceHeader": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWSTraceHeader" + } + }, + "DeadLetterQueueSourceArn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeadLetterQueueSourceArn" + } + } + } + }, + "com.amazonaws.sqs#MessageSystemAttributeNameForSends": { + "type": "enum", + "members": { + "AWSTraceHeader": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWSTraceHeader" + } + } + } + }, + "com.amazonaws.sqs#MessageSystemAttributeValue": { + "type": "structure", + "members": { + "StringValue": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable\n Characters.

" + } + }, + "BinaryValue": { + "target": "com.amazonaws.sqs#Binary", + "traits": { + "smithy.api#documentation": "

Binary type attributes can store any binary data, such as compressed data, encrypted\n data, or images.

" + } + }, + "StringListValues": { + "target": "com.amazonaws.sqs#StringList", + "traits": { + "smithy.api#documentation": "

Not implemented. Reserved for future use.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "StringListValue" + } + }, + "BinaryListValues": { + "target": "com.amazonaws.sqs#BinaryList", + "traits": { + "smithy.api#documentation": "

Not implemented. Reserved for future use.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "BinaryListValue" + } + }, + "DataType": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

Amazon SQS supports the following logical data types: String,\n Number, and Binary. For the Number data type,\n you must use StringValue.

\n

You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer\n Guide.

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

The user-specified message system attribute value. For string data types, the\n Value attribute has the same restrictions on the content as the message\n body. For more information, see \n SendMessage.\n

\n

\n Name, type, value and the message body must not\n be empty or null.

" + } + }, + "com.amazonaws.sqs#NullableInteger": { + "type": "integer" + }, + "com.amazonaws.sqs#NullableLong": { + "type": "long" + }, + "com.amazonaws.sqs#OverLimit": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "OverLimit", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

The specified action violates a limit. For example, ReceiveMessage\n returns this error if the maximum number of in flight messages is reached and\n AddPermission returns this error if the maximum number of permissions\n for the queue is reached.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sqs#PurgeQueue": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#PurgeQueueRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#PurgeQueueInProgress" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes available messages in a queue (including in-flight messages) specified by the\n QueueURL parameter.

\n \n

When you use the PurgeQueue action, you can't retrieve any messages\n deleted from a queue.

\n

The message deletion process takes up to 60 seconds. We recommend waiting for 60\n seconds regardless of your queue's size.

\n \n

Messages sent to the queue before you call\n PurgeQueue might be received but are deleted within the next\n minute.

\n

Messages sent to the queue after you call PurgeQueue\n might be deleted while the queue is being purged.

" + } + }, + "com.amazonaws.sqs#PurgeQueueInProgress": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.PurgeQueueInProgress", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

Indicates that the specified queue previously received a PurgeQueue\n request within the last 60 seconds (the time it can take to delete the messages in the\n queue).

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sqs#PurgeQueueRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the queue from which the PurgeQueue action deletes\n messages.

\n

Queue URLs and names are case-sensitive.

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

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#QueueAttributeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sqs#QueueAttributeName", + "traits": { + "smithy.api#xmlName": "Name" + } + }, + "value": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#xmlName": "Value" + } + } + }, + "com.amazonaws.sqs#QueueAttributeName": { + "type": "enum", + "members": { + "All": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "All" + } + }, + "Policy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Policy" + } + }, + "VisibilityTimeout": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VisibilityTimeout" + } + }, + "MaximumMessageSize": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaximumMessageSize" + } + }, + "MessageRetentionPeriod": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MessageRetentionPeriod" + } + }, + "ApproximateNumberOfMessages": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ApproximateNumberOfMessages" + } + }, + "ApproximateNumberOfMessagesNotVisible": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ApproximateNumberOfMessagesNotVisible" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreatedTimestamp" + } + }, + "LastModifiedTimestamp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastModifiedTimestamp" + } + }, + "QueueArn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QueueArn" + } + }, + "ApproximateNumberOfMessagesDelayed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ApproximateNumberOfMessagesDelayed" + } + }, + "DelaySeconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DelaySeconds" + } + }, + "ReceiveMessageWaitTimeSeconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReceiveMessageWaitTimeSeconds" + } + }, + "RedrivePolicy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RedrivePolicy" + } + }, + "FifoQueue": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FifoQueue" + } + }, + "ContentBasedDeduplication": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ContentBasedDeduplication" + } + }, + "KmsMasterKeyId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KmsMasterKeyId" + } + }, + "KmsDataKeyReusePeriodSeconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KmsDataKeyReusePeriodSeconds" + } + }, + "DeduplicationScope": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeduplicationScope" + } + }, + "FifoThroughputLimit": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FifoThroughputLimit" + } + }, + "RedriveAllowPolicy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RedriveAllowPolicy" + } + }, + "SqsManagedSseEnabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SqsManagedSseEnabled" + } + } + } + }, + "com.amazonaws.sqs#QueueDeletedRecently": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.QueueDeletedRecently", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You must wait 60 seconds after deleting a queue before you can create another queue\n with the same name.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#QueueDoesNotExist": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.NonExistentQueue", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Ensure that the QueueUrl is correct and that the queue has not been\n deleted.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#QueueNameExists": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "QueueAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A queue with this name already exists. Amazon SQS returns this error only if the request\n includes attributes whose values differ from those of the existing queue.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#QueueUrlList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#String" + } + }, + "com.amazonaws.sqs#ReceiptHandleIsInvalid": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReceiptHandleIsInvalid", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified receipt handle isn't valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.sqs#ReceiveMessage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#ReceiveMessageRequest" + }, + "output": { + "target": "com.amazonaws.sqs#ReceiveMessageResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#KmsAccessDenied" + }, + { + "target": "com.amazonaws.sqs#KmsDisabled" + }, + { + "target": "com.amazonaws.sqs#KmsInvalidKeyUsage" + }, + { + "target": "com.amazonaws.sqs#KmsInvalidState" + }, + { + "target": "com.amazonaws.sqs#KmsNotFound" + }, + { + "target": "com.amazonaws.sqs#KmsOptInRequired" + }, + { + "target": "com.amazonaws.sqs#KmsThrottled" + }, + { + "target": "com.amazonaws.sqs#OverLimit" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves one or more messages (up to 10), from the specified queue. Using the\n WaitTimeSeconds parameter enables long-poll support. For more\n information, see Amazon SQS\n Long Polling in the Amazon SQS Developer Guide.

\n

Short poll is the default behavior where a weighted random set of machines is sampled\n on a ReceiveMessage call. Therefore, only the messages on the sampled\n machines are returned. If the number of messages in the queue is small (fewer than\n 1,000), you most likely get fewer messages than you requested per\n ReceiveMessage call. If the number of messages in the queue is\n extremely small, you might not receive any messages in a particular\n ReceiveMessage response. If this happens, repeat the request.

\n

For each message returned, the response includes the following:

\n \n

The receipt handle is the identifier you must provide when deleting the message. For\n more information, see Queue and Message Identifiers in the Amazon SQS Developer\n Guide.

\n

You can provide the VisibilityTimeout parameter in your request. The\n parameter is applied to the messages that Amazon SQS returns in the response. If you don't\n include the parameter, the overall visibility timeout for the queue is used for the\n returned messages. The default visibility timeout for a queue is 30 seconds.

\n \n

In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

\n " + } + }, + "com.amazonaws.sqs#ReceiveMessageRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon SQS queue from which messages are received.

\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "AttributeNames": { + "target": "com.amazonaws.sqs#AttributeNameList", + "traits": { + "smithy.api#deprecated": { + "message": "AttributeNames has been replaced by MessageSystemAttributeNames" + }, + "smithy.api#documentation": "\n

This parameter has been discontinued but will be supported for backward\n compatibility. To provide attribute names, you are encouraged to use\n MessageSystemAttributeNames.

\n \n

A list of attributes that need to be returned along with each message. These\n attributes include:

\n ", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "AttributeName" + } + }, + "MessageSystemAttributeNames": { + "target": "com.amazonaws.sqs#MessageSystemAttributeList", + "traits": { + "smithy.api#documentation": "

A list of attributes that need to be returned along with each message. These\n attributes include:

\n ", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "AttributeName" + } + }, + "MessageAttributeNames": { + "target": "com.amazonaws.sqs#MessageAttributeNameList", + "traits": { + "smithy.api#documentation": "

The name of the message attribute, where N is the index.

\n \n

When using ReceiveMessage, you can send a list of attribute names to\n receive, or you can return all of the attributes by specifying All or\n .* in your request. You can also use all message attributes starting\n with a prefix, for example bar.*.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "MessageAttributeName" + } + }, + "MaxNumberOfMessages": { + "target": "com.amazonaws.sqs#NullableInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of messages to return. Amazon SQS never returns more messages than this\n value (however, fewer messages might be returned). Valid values: 1 to 10. Default:\n 1.

" + } + }, + "VisibilityTimeout": { + "target": "com.amazonaws.sqs#NullableInteger", + "traits": { + "smithy.api#documentation": "

The duration (in seconds) that the received messages are hidden from subsequent\n retrieve requests after being retrieved by a ReceiveMessage request. If not\n specified, the default visibility timeout for the queue is used, which is 30\n seconds.

\n

Understanding VisibilityTimeout:

\n \n

For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.

" + } + }, + "WaitTimeSeconds": { + "target": "com.amazonaws.sqs#NullableInteger", + "traits": { + "smithy.api#documentation": "

The duration (in seconds) for which the call waits for a message to arrive in the\n queue before returning. If a message is available, the call returns sooner than\n WaitTimeSeconds. If no messages are available and the wait time\n expires, the call does not return a message list. If you are using the Java SDK, it\n returns a ReceiveMessageResponse object, which has a empty list instead of\n a Null object.

\n \n

To avoid HTTP errors, ensure that the HTTP response timeout for\n ReceiveMessage requests is longer than the\n WaitTimeSeconds parameter. For example, with the Java SDK, you can\n set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients.

\n " + } + }, + "ReceiveRequestAttemptId": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The token used for deduplication of ReceiveMessage calls. If a networking\n issue occurs after a ReceiveMessage action, and instead of a response you\n receive a generic error, it is possible to retry the same action with an identical\n ReceiveRequestAttemptId to retrieve the same set of messages, even if\n their visibility timeout has not yet expired.

\n \n

The maximum length of ReceiveRequestAttemptId is 128 characters.\n ReceiveRequestAttemptId can contain alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon SQS\n Developer Guide.

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

Retrieves one or more messages from a specified queue.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#ReceiveMessageResult": { + "type": "structure", + "members": { + "Messages": { + "target": "com.amazonaws.sqs#MessageList", + "traits": { + "smithy.api#documentation": "

A list of messages.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Message" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of received messages.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#RemovePermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#RemovePermissionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Revokes any permissions in the queue policy that matches the specified\n Label parameter.

\n \n \n " + } + }, + "com.amazonaws.sqs#RemovePermissionRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon SQS queue from which permissions are removed.

\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "Label": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The identification of the permission to remove. This is the label added using the\n \n AddPermission\n action.

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

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#RequestThrottled": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "RequestThrottled", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

The request was denied due to request throttling.

\n ", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sqs#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceNotFoundException", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

One or more specified resources don't exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.sqs#SendMessage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#SendMessageRequest" + }, + "output": { + "target": "com.amazonaws.sqs#SendMessageResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidMessageContents" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#KmsAccessDenied" + }, + { + "target": "com.amazonaws.sqs#KmsDisabled" + }, + { + "target": "com.amazonaws.sqs#KmsInvalidKeyUsage" + }, + { + "target": "com.amazonaws.sqs#KmsInvalidState" + }, + { + "target": "com.amazonaws.sqs#KmsNotFound" + }, + { + "target": "com.amazonaws.sqs#KmsOptInRequired" + }, + { + "target": "com.amazonaws.sqs#KmsThrottled" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Delivers a message to the specified queue.

\n \n

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.

\n

\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n

\n

If a message contains characters outside the allowed set, Amazon SQS rejects the message and returns an InvalidMessageContents error. Ensure that your message body includes only valid characters to avoid this exception.

\n " + } + }, + "com.amazonaws.sqs#SendMessageBatch": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#SendMessageBatchRequest" + }, + "output": { + "target": "com.amazonaws.sqs#SendMessageBatchResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#BatchEntryIdsNotDistinct" + }, + { + "target": "com.amazonaws.sqs#BatchRequestTooLong" + }, + { + "target": "com.amazonaws.sqs#EmptyBatchRequest" + }, + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidBatchEntryId" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#KmsAccessDenied" + }, + { + "target": "com.amazonaws.sqs#KmsDisabled" + }, + { + "target": "com.amazonaws.sqs#KmsInvalidKeyUsage" + }, + { + "target": "com.amazonaws.sqs#KmsInvalidState" + }, + { + "target": "com.amazonaws.sqs#KmsNotFound" + }, + { + "target": "com.amazonaws.sqs#KmsOptInRequired" + }, + { + "target": "com.amazonaws.sqs#KmsThrottled" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#TooManyEntriesInBatchRequest" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

You can use SendMessageBatch to send up to 10 messages to the specified\n queue by assigning either identical or different values to each message (or by not\n assigning values at all). This is a batch version of \n SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued\n in the order they are sent.

\n

The result of sending each message is reported individually in the response.\n Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

\n

The maximum allowed individual message size and the maximum total payload size (the\n sum of the individual lengths of all of the batched messages) are both 1 MiB \n 1,048,576 bytes.

\n \n

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.

\n

\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n

\n

If a message contains characters outside the allowed set, Amazon SQS rejects the message and returns an InvalidMessageContents error. Ensure that your message body includes only valid characters to avoid this exception.

\n \n

If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses\n the default value for the queue.

" + } + }, + "com.amazonaws.sqs#SendMessageBatchRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon SQS queue to which batched messages are sent.

\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "Entries": { + "target": "com.amazonaws.sqs#SendMessageBatchRequestEntryList", + "traits": { + "smithy.api#documentation": "

A list of \n SendMessageBatchRequestEntry\n items.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "SendMessageBatchRequestEntry" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#SendMessageBatchRequestEntry": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An identifier for a message in this batch used to communicate the result.

\n \n

The Ids of a batch request need to be unique within a request.

\n

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

\n ", + "smithy.api#required": {} + } + }, + "MessageBody": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The body of the message.

", + "smithy.api#required": {} + } + }, + "DelaySeconds": { + "target": "com.amazonaws.sqs#NullableInteger", + "traits": { + "smithy.api#documentation": "

The length of time, in seconds, for which a specific message is delayed. Valid values:\n 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value\n become available for processing after the delay period is finished. If you don't specify\n a value, the default value for the queue is applied.

\n \n

When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

\n " + } + }, + "MessageAttributes": { + "target": "com.amazonaws.sqs#MessageBodyAttributeMap", + "traits": { + "smithy.api#documentation": "

Each message attribute consists of a Name, Type, \nand Value. For more information, see \nAmazon SQS \nmessage attributes in the Amazon SQS Developer Guide.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "MessageAttribute" + } + }, + "MessageSystemAttributes": { + "target": "com.amazonaws.sqs#MessageBodySystemAttributeMap", + "traits": { + "smithy.api#documentation": "

The message system attribute to send Each message system attribute consists of a Name, Type, and Value.

\n \n \n ", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "MessageSystemAttribute" + } + }, + "MessageDeduplicationId": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The token used for deduplication of messages within a 5-minute minimum deduplication\n interval. If a message with a particular MessageDeduplicationId is sent\n successfully, subsequent messages with the same MessageDeduplicationId are\n accepted successfully but aren't delivered. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.

\n \n \n

The MessageDeduplicationId is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).

\n

If a message is sent successfully but the acknowledgement is lost and the message\n is resent with the same MessageDeduplicationId after the deduplication\n interval, Amazon SQS can't detect duplicate messages.

\n

Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.

\n \n

The length of MessageDeduplicationId is 128 characters.\n MessageDeduplicationId can contain alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon SQS Developer\n Guide.

" + } + }, + "MessageGroupId": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

\n MessageGroupId is an attribute used in Amazon SQS FIFO (First-In-First-Out) and standard queues. \n In FIFO queues, MessageGroupId organizes messages into distinct groups. \n Messages within the same message group are always processed one at a time, in strict order, \n ensuring that no two messages from the same group are processed simultaneously. \n In standard queues, using MessageGroupId enables fair queues. \n It is used to identify the tenant a message belongs to, \n helping maintain consistent message dwell time across all tenants during noisy neighbor events. \n Unlike FIFO queues, messages with the same MessageGroupId can be processed in parallel, \n maintaining the high throughput of standard queues.

\n \n

The length of MessageGroupId is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.

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

Contains the details of a single Amazon SQS message along with an Id.

" + } + }, + "com.amazonaws.sqs#SendMessageBatchRequestEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#SendMessageBatchRequestEntry" + } + }, + "com.amazonaws.sqs#SendMessageBatchResult": { + "type": "structure", + "members": { + "Successful": { + "target": "com.amazonaws.sqs#SendMessageBatchResultEntryList", + "traits": { + "smithy.api#documentation": "

A list of \n SendMessageBatchResultEntry\n items.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "SendMessageBatchResultEntry" + } + }, + "Failed": { + "target": "com.amazonaws.sqs#BatchResultErrorEntryList", + "traits": { + "smithy.api#documentation": "

A list of \n BatchResultErrorEntry\n items with error\n details about each message that can't be enqueued.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "BatchResultErrorEntry" + } + } + }, + "traits": { + "smithy.api#documentation": "

For each message in the batch, the response contains a \n SendMessageBatchResultEntry\n tag if the message succeeds or a\n \n BatchResultErrorEntry\n tag if the message\n fails.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#SendMessageBatchResultEntry": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An identifier for the message in this batch.

", + "smithy.api#required": {} + } + }, + "MessageId": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An identifier for the message.

", + "smithy.api#required": {} + } + }, + "MD5OfMessageBody": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

", + "smithy.api#required": {} + } + }, + "MD5OfMessageAttributes": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

" + } + }, + "MD5OfMessageSystemAttributes": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An MD5 digest of the non-URL-encoded message system attribute string. You can use this \nattribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

" + } + }, + "SequenceNumber": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The large, non-consecutive number that Amazon SQS assigns to each message.

\n

The length of SequenceNumber is 128 bits. As SequenceNumber\n continues to increase for a particular MessageGroupId.

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

Encloses a MessageId for a successfully-enqueued message in a \n SendMessageBatch.\n

" + } + }, + "com.amazonaws.sqs#SendMessageBatchResultEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#SendMessageBatchResultEntry" + } + }, + "com.amazonaws.sqs#SendMessageRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon SQS queue to which a message is sent.

\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "MessageBody": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The message to send. The minimum size is one character. The maximum size is \n 1 MiB or 1,048,576 bytes

\n \n

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.

\n

\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n

\n

If a message contains characters outside the allowed set, Amazon SQS rejects the message and returns an InvalidMessageContents error. Ensure that your message body includes only valid characters to avoid this exception.

\n ", + "smithy.api#required": {} + } + }, + "DelaySeconds": { + "target": "com.amazonaws.sqs#NullableInteger", + "traits": { + "smithy.api#documentation": "

The length of time, in seconds, for which to delay a specific message. Valid values:\n 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value\n become available for processing after the delay period is finished. If you don't specify\n a value, the default value for the queue applies.

\n \n

When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

\n " + } + }, + "MessageAttributes": { + "target": "com.amazonaws.sqs#MessageBodyAttributeMap", + "traits": { + "smithy.api#documentation": "

Each message attribute consists of a Name, Type, \nand Value. For more information, see \nAmazon SQS \nmessage attributes in the Amazon SQS Developer Guide.

", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "MessageAttribute" + } + }, + "MessageSystemAttributes": { + "target": "com.amazonaws.sqs#MessageBodySystemAttributeMap", + "traits": { + "smithy.api#documentation": "

The message system attribute to send. Each message system attribute consists of a Name, Type, and Value.

\n \n \n ", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "MessageSystemAttribute" + } + }, + "MessageDeduplicationId": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The token used for deduplication of sent messages. If a message with a particular\n MessageDeduplicationId is sent successfully, any messages sent with the\n same MessageDeduplicationId are accepted successfully but aren't delivered\n during the 5-minute deduplication interval. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.

\n \n \n

The MessageDeduplicationId is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).

\n

If a message is sent successfully but the acknowledgement is lost and the message\n is resent with the same MessageDeduplicationId after the deduplication\n interval, Amazon SQS can't detect duplicate messages.

\n

Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.

\n \n

The maximum length of MessageDeduplicationId is 128 characters.\n MessageDeduplicationId can contain alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon SQS Developer\n Guide.

" + } + }, + "MessageGroupId": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

\n MessageGroupId is an attribute used in Amazon SQS FIFO (First-In-First-Out) and standard queues. \n In FIFO queues, MessageGroupId organizes messages into distinct groups. \n Messages within the same message group are always processed one at a time, in strict order, \n ensuring that no two messages from the same group are processed simultaneously. \n In standard queues, using MessageGroupId enables fair queues. \n It is used to identify the tenant a message belongs to, \n helping maintain consistent message dwell time across all tenants during noisy neighbor events. \n Unlike FIFO queues, messages with the same MessageGroupId can be processed in parallel, \n maintaining the high throughput of standard queues.

\n \n

The length of MessageGroupId is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.

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

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#SendMessageResult": { + "type": "structure", + "members": { + "MD5OfMessageBody": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

" + } + }, + "MD5OfMessageAttributes": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

" + } + }, + "MD5OfMessageSystemAttributes": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An MD5 digest of the non-URL-encoded message system attribute string. You can use this \nattribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest.

" + } + }, + "MessageId": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An attribute containing the MessageId of the message sent to the queue.\n For more information, see Queue and Message Identifiers in the Amazon SQS Developer\n Guide.

" + } + }, + "SequenceNumber": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The large, non-consecutive number that Amazon SQS assigns to each message.

\n

The length of SequenceNumber is 128 bits. SequenceNumber\n continues to increase for a particular MessageGroupId.

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

The MD5OfMessageBody and MessageId elements.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#SetQueueAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#SetQueueAttributesRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidAttributeName" + }, + { + "target": "com.amazonaws.sqs#InvalidAttributeValue" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#OverLimit" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Sets the value of one or more queue attributes, like a policy. When you change a\n queue's attributes, the change can take up to 60 seconds for most of the attributes to\n propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod attribute can take up to 15 minutes and will\n impact existing messages in the queue potentially causing them to be expired and deleted\n if the MessageRetentionPeriod is reduced below the age of existing\n messages.

\n \n \n " + } + }, + "com.amazonaws.sqs#SetQueueAttributesRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the Amazon SQS queue whose attributes are set.

\n

Queue URLs and names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "Attributes": { + "target": "com.amazonaws.sqs#QueueAttributeMap", + "traits": { + "smithy.api#documentation": "

A map of attributes to set.

\n

The following lists the names, descriptions, and values of the special request\n parameters that the SetQueueAttributes action uses:

\n \n

The following attributes apply only to dead-letter queues:\n

\n \n \n

The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.

\n \n

The following attributes apply only to server-side-encryption:

\n \n

The following attribute applies only to FIFO (first-in-first-out)\n queues:

\n \n

The following attributes apply only to \nhigh throughput\nfor FIFO queues:

\n \n

To enable high throughput for FIFO queues, do the following:

\n \n

If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.

\n

For information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Attribute" + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#StartMessageMoveTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#StartMessageMoveTaskRequest" + }, + "output": { + "target": "com.amazonaws.sqs#StartMessageMoveTaskResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an asynchronous task to move messages from a specified source queue to a\n specified destination queue.

\n \n \n " + } + }, + "com.amazonaws.sqs#StartMessageMoveTaskRequest": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The ARN of the queue that contains the messages to be moved to another queue.\n Currently, only ARNs of dead-letter queues (DLQs) whose sources are other Amazon SQS queues\n are accepted. DLQs whose sources are non-SQS queues, such as Lambda or Amazon SNS topics, are\n not currently supported.

", + "smithy.api#required": {} + } + }, + "DestinationArn": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The ARN of the queue that receives the moved messages. You can use this field to\n specify the destination queue where you would like to redrive messages. If this field is\n left blank, the messages will be redriven back to their respective original source\n queues.

" + } + }, + "MaxNumberOfMessagesPerSecond": { + "target": "com.amazonaws.sqs#NullableInteger", + "traits": { + "smithy.api#documentation": "

The number of messages to be moved per second (the message movement rate). You can use\n this field to define a fixed message movement rate. The maximum value for messages per\n second is 500. If this field is left blank, the system will optimize the rate based on\n the queue message backlog size, which may vary throughout the duration of the message\n movement task.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#StartMessageMoveTaskResult": { + "type": "structure", + "members": { + "TaskHandle": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

An identifier associated with a message movement task. You can use this identifier to\n cancel a specified message movement task using the CancelMessageMoveTask\n action.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#String": { + "type": "string" + }, + "com.amazonaws.sqs#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#xmlName": "StringListValue" + } + } + }, + "com.amazonaws.sqs#TagKey": { + "type": "string" + }, + "com.amazonaws.sqs#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#TagKey" + } + }, + "com.amazonaws.sqs#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sqs#TagKey", + "traits": { + "smithy.api#xmlName": "Key" + } + }, + "value": { + "target": "com.amazonaws.sqs#TagValue", + "traits": { + "smithy.api#xmlName": "Value" + } + } + }, + "com.amazonaws.sqs#TagQueue": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#TagQueueRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.

\n

When you use queue tags, keep the following guidelines in mind:

\n \n

For a full list of tag restrictions, see \nQuotas related to queues \nin the Amazon SQS Developer Guide.

\n \n

Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.

\n " + } + }, + "com.amazonaws.sqs#TagQueueRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the queue.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sqs#TagMap", + "traits": { + "smithy.api#documentation": "

The list of tags to be added to the specified queue.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Tag" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#TagValue": { + "type": "string" + }, + "com.amazonaws.sqs#Token": { + "type": "string" + }, + "com.amazonaws.sqs#TooManyEntriesInBatchRequest": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.TooManyEntriesInBatchRequest", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The batch request contains more entries than permissible. For Amazon SQS, the\n maximum number of entries you can include in a single SendMessageBatch, DeleteMessageBatch, or ChangeMessageVisibilityBatch request is 10.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#UnsupportedOperation": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.UnsupportedOperation", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Error code 400. Unsupported operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#UntagQueue": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#UntagQueueRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "

Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.

\n \n

Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.

\n " + } + }, + "com.amazonaws.sqs#UntagQueueRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "

The URL of the queue.

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.sqs#TagKeyList", + "traits": { + "smithy.api#documentation": "

The list of tags to be removed from the specified queue.

", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "TagKey" + } + } + }, + "traits": { + "smithy.api#input": {} + } + } + } +}