diff --git a/codegen/sdk-codegen/aws-models/amplifybackend.json b/codegen/sdk-codegen/aws-models/amplifybackend.json index 0025c6b00acd..0ff536cae252 100644 --- a/codegen/sdk-codegen/aws-models/amplifybackend.json +++ b/codegen/sdk-codegen/aws-models/amplifybackend.json @@ -1,6158 +1,6244 @@ { - "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.amplifybackend#AdditionalConstraintsElement": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "REQUIRE_DIGIT", - "name": "REQUIRE_DIGIT" - }, - { - "value": "REQUIRE_LOWERCASE", - "name": "REQUIRE_LOWERCASE" - }, - { - "value": "REQUIRE_SYMBOL", - "name": "REQUIRE_SYMBOL" - }, - { - "value": "REQUIRE_UPPERCASE", - "name": "REQUIRE_UPPERCASE" - } + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } ] - } }, - "com.amazonaws.amplifybackend#AmplifyBackend": { - "type": "service", - "version": "2020-08-11", - "operations": [ - { - "target": "com.amazonaws.amplifybackend#CloneBackend" - }, - { - "target": "com.amazonaws.amplifybackend#CreateBackend" - }, - { - "target": "com.amazonaws.amplifybackend#CreateBackendAPI" - }, - { - "target": "com.amazonaws.amplifybackend#CreateBackendAuth" - }, - { - "target": "com.amazonaws.amplifybackend#CreateBackendConfig" - }, - { - "target": "com.amazonaws.amplifybackend#CreateBackendStorage" - }, - { - "target": "com.amazonaws.amplifybackend#CreateToken" - }, - { - "target": "com.amazonaws.amplifybackend#DeleteBackend" - }, - { - "target": "com.amazonaws.amplifybackend#DeleteBackendAPI" - }, - { - "target": "com.amazonaws.amplifybackend#DeleteBackendAuth" - }, - { - "target": "com.amazonaws.amplifybackend#DeleteBackendStorage" - }, - { - "target": "com.amazonaws.amplifybackend#DeleteToken" - }, - { - "target": "com.amazonaws.amplifybackend#GenerateBackendAPIModels" - }, - { - "target": "com.amazonaws.amplifybackend#GetBackend" - }, - { - "target": "com.amazonaws.amplifybackend#GetBackendAPI" - }, - { - "target": "com.amazonaws.amplifybackend#GetBackendAPIModels" - }, - { - "target": "com.amazonaws.amplifybackend#GetBackendAuth" - }, - { - "target": "com.amazonaws.amplifybackend#GetBackendJob" - }, - { - "target": "com.amazonaws.amplifybackend#GetBackendStorage" - }, - { - "target": "com.amazonaws.amplifybackend#GetToken" - }, - { - "target": "com.amazonaws.amplifybackend#ImportBackendAuth" - }, - { - "target": "com.amazonaws.amplifybackend#ImportBackendStorage" - }, - { - "target": "com.amazonaws.amplifybackend#ListBackendJobs" - }, - { - "target": "com.amazonaws.amplifybackend#ListS3Buckets" - }, - { - "target": "com.amazonaws.amplifybackend#RemoveAllBackends" - }, - { - "target": "com.amazonaws.amplifybackend#RemoveBackendConfig" - }, - { - "target": "com.amazonaws.amplifybackend#UpdateBackendAPI" - }, - { - "target": "com.amazonaws.amplifybackend#UpdateBackendAuth" - }, - { - "target": "com.amazonaws.amplifybackend#UpdateBackendConfig" - }, - { - "target": "com.amazonaws.amplifybackend#UpdateBackendJob" - }, - { - "target": "com.amazonaws.amplifybackend#UpdateBackendStorage" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "AmplifyBackend", - "arnNamespace": "amplifybackend", - "cloudFormationName": "AmplifyBackend", - "cloudTrailEventSource": "amplifybackend.amazonaws.com", - "endpointPrefix": "amplifybackend" - }, - "aws.auth#sigv4": { - "name": "amplifybackend" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

AWS Amplify Admin API

", - "smithy.api#title": "AmplifyBackend", - "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": "aws.partition", - "argv": [ - { - "ref": "Region" + "shapes": { + "com.amazonaws.amplifybackend#AdditionalConstraintsElement": { + "type": "enum", + "members": { + "REQUIRE_DIGIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUIRE_DIGIT" + } + }, + "REQUIRE_LOWERCASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUIRE_LOWERCASE" + } + }, + "REQUIRE_SYMBOL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUIRE_SYMBOL" + } + }, + "REQUIRE_UPPERCASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUIRE_UPPERCASE" } - ], - "assign": "PartitionResult" } - ], - "type": "tree", - "rules": [ + } + }, + "com.amazonaws.amplifybackend#AmplifyBackend": { + "type": "service", + "version": "2020-08-11", + "operations": [ { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" + "target": "com.amazonaws.amplifybackend#CloneBackend" + }, + { + "target": "com.amazonaws.amplifybackend#CreateBackend" + }, + { + "target": "com.amazonaws.amplifybackend#CreateBackendAPI" + }, + { + "target": "com.amazonaws.amplifybackend#CreateBackendAuth" + }, + { + "target": "com.amazonaws.amplifybackend#CreateBackendConfig" + }, + { + "target": "com.amazonaws.amplifybackend#CreateBackendStorage" + }, + { + "target": "com.amazonaws.amplifybackend#CreateToken" + }, + { + "target": "com.amazonaws.amplifybackend#DeleteBackend" + }, + { + "target": "com.amazonaws.amplifybackend#DeleteBackendAPI" + }, + { + "target": "com.amazonaws.amplifybackend#DeleteBackendAuth" + }, + { + "target": "com.amazonaws.amplifybackend#DeleteBackendStorage" + }, + { + "target": "com.amazonaws.amplifybackend#DeleteToken" + }, + { + "target": "com.amazonaws.amplifybackend#GenerateBackendAPIModels" + }, + { + "target": "com.amazonaws.amplifybackend#GetBackend" + }, + { + "target": "com.amazonaws.amplifybackend#GetBackendAPI" + }, + { + "target": "com.amazonaws.amplifybackend#GetBackendAPIModels" + }, + { + "target": "com.amazonaws.amplifybackend#GetBackendAuth" + }, + { + "target": "com.amazonaws.amplifybackend#GetBackendJob" + }, + { + "target": "com.amazonaws.amplifybackend#GetBackendStorage" + }, + { + "target": "com.amazonaws.amplifybackend#GetToken" + }, + { + "target": "com.amazonaws.amplifybackend#ImportBackendAuth" + }, + { + "target": "com.amazonaws.amplifybackend#ImportBackendStorage" + }, + { + "target": "com.amazonaws.amplifybackend#ListBackendJobs" + }, + { + "target": "com.amazonaws.amplifybackend#ListS3Buckets" + }, + { + "target": "com.amazonaws.amplifybackend#RemoveAllBackends" + }, + { + "target": "com.amazonaws.amplifybackend#RemoveBackendConfig" + }, + { + "target": "com.amazonaws.amplifybackend#UpdateBackendAPI" + }, + { + "target": "com.amazonaws.amplifybackend#UpdateBackendAuth" + }, + { + "target": "com.amazonaws.amplifybackend#UpdateBackendConfig" + }, + { + "target": "com.amazonaws.amplifybackend#UpdateBackendJob" + }, + { + "target": "com.amazonaws.amplifybackend#UpdateBackendStorage" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "AmplifyBackend", + "arnNamespace": "amplifybackend", + "cloudFormationName": "AmplifyBackend", + "cloudTrailEventSource": "amplifybackend.amazonaws.com", + "endpointPrefix": "amplifybackend" + }, + "aws.auth#sigv4": { + "name": "amplifybackend" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

AWS Amplify Admin API

", + "smithy.api#title": "AmplifyBackend", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": true, + "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" } - ] }, - { - "fn": "parseURL", - "argv": [ + "rules": [ { - "ref": "Endpoint" + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "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" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://amplifybackend-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": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://amplifybackend-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://amplifybackend.{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://amplifybackend.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] } - ], - "assign": "url" - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.ap-south-1.api.aws" + } }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "type": "tree", - "rules": [ + "params": { + "UseDualStack": true, + "Region": "ap-south-1", + "UseFIPS": true + } + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-south-1", + "UseFIPS": true } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" }, { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.ap-south-1.api.aws" + } }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + "params": { + "UseDualStack": true, + "Region": "ap-south-1", + "UseFIPS": false + } + }, { - "ref": "UseFIPS" + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-south-1", + "UseFIPS": false + } }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ { - "ref": "UseDualStack" + "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.ca-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ca-central-1", + "UseFIPS": true + } }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ca-central-1", + "UseFIPS": true } - ] }, { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.ca-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ca-central-1", + "UseFIPS": false } - ] - } - ], - "type": "tree", - "rules": [ + }, { - "conditions": [], - "endpoint": { - "url": "https://amplifybackend-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": [ - { - "fn": "booleanEquals", - "argv": [ + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ca-central-1", + "UseFIPS": false + } + }, { - "ref": "UseFIPS" + "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.eu-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-central-1", + "UseFIPS": true + } }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-central-1", + "UseFIPS": true } - ] - } - ], - "type": "tree", - "rules": [ + }, { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://amplifybackend-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.eu-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-central-1", + "UseFIPS": false } - ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + }, { - "ref": "UseDualStack" + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-central-1", + "UseFIPS": false + } }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] + "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.us-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-west-1", + "UseFIPS": true } - ] - } - ], - "type": "tree", - "rules": [ + }, { - "conditions": [], - "endpoint": { - "url": "https://amplifybackend.{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://amplifybackend.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.ap-south-1.api.aws" - } - }, - "params": { - "Region": "ap-south-1", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.ap-south-1.api.aws" - } - }, - "params": { - "Region": "ap-south-1", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.ca-central-1.api.aws" - } - }, - "params": { - "Region": "ca-central-1", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.ca-central-1.api.aws" - } - }, - "params": { - "Region": "ca-central-1", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.eu-central-1.api.aws" - } - }, - "params": { - "Region": "eu-central-1", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.eu-central-1.api.aws" - } - }, - "params": { - "Region": "eu-central-1", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.us-west-1.api.aws" - } - }, - "params": { - "Region": "us-west-1", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.us-west-1.api.aws" - } - }, - "params": { - "Region": "us-west-1", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.us-west-2.api.aws" - } - }, - "params": { - "Region": "us-west-2", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.us-west-2.api.aws" - } - }, - "params": { - "Region": "us-west-2", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.eu-north-1.api.aws" - } - }, - "params": { - "Region": "eu-north-1", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.eu-north-1.api.aws" - } - }, - "params": { - "Region": "eu-north-1", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.eu-west-3.api.aws" - } - }, - "params": { - "Region": "eu-west-3", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.eu-west-3.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-3", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.eu-west-3.api.aws" - } - }, - "params": { - "Region": "eu-west-3", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.eu-west-3.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-3", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.eu-west-2.api.aws" - } - }, - "params": { - "Region": "eu-west-2", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.eu-west-2.api.aws" - } - }, - "params": { - "Region": "eu-west-2", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.eu-west-1.api.aws" - } - }, - "params": { - "Region": "eu-west-1", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.eu-west-1.api.aws" - } - }, - "params": { - "Region": "eu-west-1", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.ap-northeast-2.api.aws" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.ap-northeast-2.api.aws" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.ap-northeast-1.api.aws" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.ap-northeast-1.api.aws" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.me-south-1.api.aws" - } - }, - "params": { - "Region": "me-south-1", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.me-south-1.amazonaws.com" - } - }, - "params": { - "Region": "me-south-1", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.me-south-1.api.aws" - } - }, - "params": { - "Region": "me-south-1", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.me-south-1.amazonaws.com" - } - }, - "params": { - "Region": "me-south-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.sa-east-1.api.aws" - } - }, - "params": { - "Region": "sa-east-1", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.sa-east-1.amazonaws.com" - } - }, - "params": { - "Region": "sa-east-1", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.sa-east-1.api.aws" - } - }, - "params": { - "Region": "sa-east-1", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.sa-east-1.amazonaws.com" - } - }, - "params": { - "Region": "sa-east-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.ap-southeast-1.api.aws" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.ap-southeast-1.api.aws" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.ap-southeast-2.api.aws" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.ap-southeast-2.api.aws" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.us-east-2.api.aws" - } - }, - "params": { - "Region": "us-east-2", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend-fips.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.us-east-2.api.aws" - } - }, - "params": { - "Region": "us-east-2", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://amplifybackend.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": 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", - "UseDualStack": false, - "UseFIPS": true, - "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", - "UseDualStack": true, - "UseFIPS": false, - "Endpoint": "https://example.com" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.amplifybackend#AuthResources": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "USER_POOL_ONLY", - "name": "USER_POOL_ONLY" - }, - { - "value": "IDENTITY_POOL_AND_USER_POOL", - "name": "IDENTITY_POOL_AND_USER_POOL" - } - ] - } - }, - "com.amazonaws.amplifybackend#AuthenticatedElement": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "READ", - "name": "READ" - }, - { - "value": "CREATE_AND_UPDATE", - "name": "CREATE_AND_UPDATE" - }, - { - "value": "DELETE", - "name": "DELETE" - } - ] - } - }, - "com.amazonaws.amplifybackend#BackendAPIAppSyncAuthSettings": { - "type": "structure", - "members": { - "CognitoUserPoolId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.

", - "smithy.api#jsonName": "cognitoUserPoolId" - } - }, - "Description": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.

", - "smithy.api#jsonName": "description" - } - }, - "ExpirationTime": { - "target": "com.amazonaws.amplifybackend#__double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.

", - "smithy.api#jsonName": "expirationTime" - } - }, - "OpenIDAuthTTL": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The expiry time for the OpenID authentication mechanism.

", - "smithy.api#jsonName": "openIDAuthTTL" - } - }, - "OpenIDClientId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The clientID for openID, if openID was used as an authentication setting to access your data models.

", - "smithy.api#jsonName": "openIDClientId" - } - }, - "OpenIDIatTTL": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The expiry time for the OpenID authentication mechanism.

", - "smithy.api#jsonName": "openIDIatTTL" - } - }, - "OpenIDIssueURL": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The openID issuer URL, if openID was used as an authentication setting to access your data models.

", - "smithy.api#jsonName": "openIDIssueURL" - } - }, - "OpenIDProviderName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.

", - "smithy.api#jsonName": "openIDProviderName" - } - } - }, - "traits": { - "smithy.api#documentation": "

The authentication settings for accessing provisioned data models in your Amplify project.

" - } - }, - "com.amazonaws.amplifybackend#BackendAPIAuthType": { - "type": "structure", - "members": { - "Mode": { - "target": "com.amazonaws.amplifybackend#Mode", - "traits": { - "smithy.api#documentation": "

Describes the authentication mode.

", - "smithy.api#jsonName": "mode" - } - }, - "Settings": { - "target": "com.amazonaws.amplifybackend#BackendAPIAppSyncAuthSettings", - "traits": { - "smithy.api#documentation": "

Describes settings for the authentication mode.

", - "smithy.api#jsonName": "settings" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the auth types for your configured data models.

" - } - }, - "com.amazonaws.amplifybackend#BackendAPIConflictResolution": { - "type": "structure", - "members": { - "ResolutionStrategy": { - "target": "com.amazonaws.amplifybackend#ResolutionStrategy", - "traits": { - "smithy.api#documentation": "

The strategy for conflict resolution.

", - "smithy.api#jsonName": "resolutionStrategy" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the conflict resolution configuration for your data model configured in your Amplify project.

" - } - }, - "com.amazonaws.amplifybackend#BackendAPIResourceConfig": { - "type": "structure", - "members": { - "AdditionalAuthTypes": { - "target": "com.amazonaws.amplifybackend#ListOfBackendAPIAuthType", - "traits": { - "smithy.api#documentation": "

Additional authentication methods used to interact with your data models.

", - "smithy.api#jsonName": "additionalAuthTypes" - } - }, - "ApiName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The API name used to interact with the data model, configured as a part of your Amplify project.

", - "smithy.api#jsonName": "apiName" - } - }, - "ConflictResolution": { - "target": "com.amazonaws.amplifybackend#BackendAPIConflictResolution", - "traits": { - "smithy.api#documentation": "

The conflict resolution strategy for your data stored in the data models.

", - "smithy.api#jsonName": "conflictResolution" - } - }, - "DefaultAuthType": { - "target": "com.amazonaws.amplifybackend#BackendAPIAuthType", - "traits": { - "smithy.api#documentation": "

The default authentication type for interacting with the configured data models in your Amplify project.

", - "smithy.api#jsonName": "defaultAuthType" - } - }, - "Service": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The service used to provision and interact with the data model.

", - "smithy.api#jsonName": "service" - } - }, - "TransformSchema": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The definition of the data model in the annotated transform of the GraphQL schema.

", - "smithy.api#jsonName": "transformSchema" - } - } - }, - "traits": { - "smithy.api#documentation": "

The resource config for the data model, configured as a part of the Amplify project.

" - } - }, - "com.amazonaws.amplifybackend#BackendAuthAppleProviderConfig": { - "type": "structure", - "members": { - "ClientId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

Describes the client_id (also called Services ID) that comes from Apple.

", - "smithy.api#jsonName": "client_id" - } - }, - "KeyId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

Describes the key_id that comes from Apple.

", - "smithy.api#jsonName": "key_id" - } - }, - "PrivateKey": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

Describes the private_key that comes from Apple.

", - "smithy.api#jsonName": "private_key" - } - }, - "TeamId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

Describes the team_id that comes from Apple.

", - "smithy.api#jsonName": "team_id" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes Apple social federation configurations for allowing your app users to sign in using OAuth.

" - } - }, - "com.amazonaws.amplifybackend#BackendAuthSocialProviderConfig": { - "type": "structure", - "members": { - "ClientId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

Describes the client_id, which can be obtained from the third-party social federation provider.

", - "smithy.api#jsonName": "client_id" - } - }, - "ClientSecret": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

Describes the client_secret, which can be obtained from third-party social federation providers.

", - "smithy.api#jsonName": "client_secret" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes third-party social federation configurations for allowing your app users to sign in using OAuth.

" - } - }, - "com.amazonaws.amplifybackend#BackendJobRespObj": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId", - "smithy.api#required": {} - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName", - "smithy.api#required": {} - } - }, - "CreateTime": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The time when the job was created.

", - "smithy.api#jsonName": "createTime" - } - }, - "Error": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

If the request fails, this error is returned.

", - "smithy.api#jsonName": "error" - } - }, - "JobId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID for the job.

", - "smithy.api#jsonName": "jobId" - } - }, - "Operation": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the operation.

", - "smithy.api#jsonName": "operation" - } - }, - "Status": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The current status of the request.

", - "smithy.api#jsonName": "status" - } - }, - "UpdateTime": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The time when the job was last updated.

", - "smithy.api#jsonName": "updateTime" - } - } - }, - "traits": { - "smithy.api#documentation": "

The response object for this operation.

" - } - }, - "com.amazonaws.amplifybackend#BackendStoragePermissions": { - "type": "structure", - "members": { - "Authenticated": { - "target": "com.amazonaws.amplifybackend#ListOfAuthenticatedElement", - "traits": { - "smithy.api#documentation": "

Lists all authenticated user read, write, and delete permissions for your S3 bucket.

", - "smithy.api#jsonName": "authenticated", - "smithy.api#required": {} - } - }, - "UnAuthenticated": { - "target": "com.amazonaws.amplifybackend#ListOfUnAuthenticatedElement", - "traits": { - "smithy.api#documentation": "

Lists all unauthenticated user read, write, and delete permissions for your S3 bucket.

", - "smithy.api#jsonName": "unAuthenticated" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the read, write, and delete permissions users have against your storage S3 bucket.

" - } - }, - "com.amazonaws.amplifybackend#BadRequestException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

An error message to inform that the request failed.

", - "smithy.api#jsonName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

An error returned if a request is not formed properly.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.amplifybackend#CloneBackend": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#CloneBackendRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#CloneBackendResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

This operation clones an existing backend.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/environments/{BackendEnvironmentName}/clone", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#CloneBackendRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TargetEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the destination backend environment to be created.

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

The request body for CloneBackend.

" - } - }, - "com.amazonaws.amplifybackend#CloneBackendResponse": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId" - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName" - } - }, - "Error": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

If the request fails, this error is returned.

", - "smithy.api#jsonName": "error" - } - }, - "JobId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID for the job.

", - "smithy.api#jsonName": "jobId" - } - }, - "Operation": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the operation.

", - "smithy.api#jsonName": "operation" - } - }, - "Status": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The current status of the request.

", - "smithy.api#jsonName": "status" - } - } - } - }, - "com.amazonaws.amplifybackend#CreateBackend": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#CreateBackendRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#CreateBackendResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#CreateBackendAPI": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#CreateBackendAPIRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#CreateBackendAPIResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new backend API resource.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/api", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#CreateBackendAPIRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName", - "smithy.api#required": {} - } - }, - "ResourceConfig": { - "target": "com.amazonaws.amplifybackend#BackendAPIResourceConfig", - "traits": { - "smithy.api#documentation": "

The resource configuration for this request.

", - "smithy.api#jsonName": "resourceConfig", - "smithy.api#required": {} - } - }, - "ResourceName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of this resource.

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

The request body for CreateBackendAPI.

" - } - }, - "com.amazonaws.amplifybackend#CreateBackendAPIResponse": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId" - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName" - } - }, - "Error": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

If the request fails, this error is returned.

", - "smithy.api#jsonName": "error" - } - }, - "JobId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID for the job.

", - "smithy.api#jsonName": "jobId" - } - }, - "Operation": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the operation.

", - "smithy.api#jsonName": "operation" - } - }, - "Status": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The current status of the request.

", - "smithy.api#jsonName": "status" - } - } - } - }, - "com.amazonaws.amplifybackend#CreateBackendAuth": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#CreateBackendAuthRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#CreateBackendAuthResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new backend authentication resource.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/auth", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#CreateBackendAuthForgotPasswordConfig": { - "type": "structure", - "members": { - "DeliveryMethod": { - "target": "com.amazonaws.amplifybackend#DeliveryMethod", - "traits": { - "smithy.api#documentation": "

(DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.

", - "smithy.api#jsonName": "deliveryMethod", - "smithy.api#required": {} - } - }, - "EmailSettings": { - "target": "com.amazonaws.amplifybackend#EmailSettings", - "traits": { - "smithy.api#documentation": "

(DEPRECATED) The configuration for the email sent when an app user forgets their password.

", - "smithy.api#jsonName": "emailSettings" - } - }, - "SmsSettings": { - "target": "com.amazonaws.amplifybackend#SmsSettings", - "traits": { - "smithy.api#documentation": "

(DEPRECATED) The configuration for the SMS message sent when an app user forgets their password.

", - "smithy.api#jsonName": "smsSettings" - } - } - }, - "traits": { - "smithy.api#documentation": "

(DEPRECATED) Describes the forgot password policy for authenticating into the Amplify app.

" - } - }, - "com.amazonaws.amplifybackend#CreateBackendAuthIdentityPoolConfig": { - "type": "structure", - "members": { - "IdentityPoolName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

Name of the Amazon Cognito identity pool used for authorization.

", - "smithy.api#jsonName": "identityPoolName", - "smithy.api#required": {} - } - }, - "UnauthenticatedLogin": { - "target": "com.amazonaws.amplifybackend#__boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Set to true or false based on whether you want to enable guest authorization to your Amplify app.

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

Describes authorization configurations for the auth resources, configured as a part of your Amplify project.

" - } - }, - "com.amazonaws.amplifybackend#CreateBackendAuthMFAConfig": { - "type": "structure", - "members": { - "MFAMode": { - "target": "com.amazonaws.amplifybackend#MFAMode", - "traits": { - "smithy.api#documentation": "

Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.

", - "smithy.api#required": {} - } - }, - "Settings": { - "target": "com.amazonaws.amplifybackend#Settings", - "traits": { - "smithy.api#documentation": "

Describes the configuration settings and methods for your Amplify app users to use MFA.

", - "smithy.api#jsonName": "settings" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.

" - } - }, - "com.amazonaws.amplifybackend#CreateBackendAuthOAuthConfig": { - "type": "structure", - "members": { - "DomainPrefix": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The domain prefix for your Amplify app.

", - "smithy.api#jsonName": "domainPrefix" - } - }, - "OAuthGrantType": { - "target": "com.amazonaws.amplifybackend#OAuthGrantType", - "traits": { - "smithy.api#documentation": "

The OAuth grant type that you use to allow app users to authenticate from your Amplify app.

", - "smithy.api#jsonName": "oAuthGrantType", - "smithy.api#required": {} - } - }, - "OAuthScopes": { - "target": "com.amazonaws.amplifybackend#ListOfOAuthScopesElement", - "traits": { - "smithy.api#documentation": "

List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.

", - "smithy.api#jsonName": "oAuthScopes", - "smithy.api#required": {} - } - }, - "RedirectSignInURIs": { - "target": "com.amazonaws.amplifybackend#ListOf__string", - "traits": { - "smithy.api#documentation": "

The redirected URI for signing in to your Amplify app.

", - "smithy.api#jsonName": "redirectSignInURIs", - "smithy.api#required": {} - } - }, - "RedirectSignOutURIs": { - "target": "com.amazonaws.amplifybackend#ListOf__string", - "traits": { - "smithy.api#documentation": "

Redirect URLs that OAuth uses when a user signs out of an Amplify app.

", - "smithy.api#jsonName": "redirectSignOutURIs", - "smithy.api#required": {} - } - }, - "SocialProviderSettings": { - "target": "com.amazonaws.amplifybackend#SocialProviderSettings", - "traits": { - "smithy.api#documentation": "

The settings for using social providers to access your Amplify app.

", - "smithy.api#jsonName": "socialProviderSettings" - } - } - }, - "traits": { - "smithy.api#documentation": "

Creates the OAuth configuration for your Amplify project.

" - } - }, - "com.amazonaws.amplifybackend#CreateBackendAuthPasswordPolicyConfig": { - "type": "structure", - "members": { - "AdditionalConstraints": { - "target": "com.amazonaws.amplifybackend#ListOfAdditionalConstraintsElement", - "traits": { - "smithy.api#documentation": "

Additional constraints for the password used to access the backend of your Amplify project.

", - "smithy.api#jsonName": "additionalConstraints" - } - }, - "MinimumLength": { - "target": "com.amazonaws.amplifybackend#__double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum length of the password used to access the backend of your Amplify project.

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

The password policy configuration for the backend to your Amplify project.

" - } - }, - "com.amazonaws.amplifybackend#CreateBackendAuthRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName", - "smithy.api#required": {} - } - }, - "ResourceConfig": { - "target": "com.amazonaws.amplifybackend#CreateBackendAuthResourceConfig", - "traits": { - "smithy.api#documentation": "

The resource configuration for this request object.

", - "smithy.api#jsonName": "resourceConfig", - "smithy.api#required": {} - } - }, - "ResourceName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of this resource.

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

The request body for CreateBackendAuth.

" - } - }, - "com.amazonaws.amplifybackend#CreateBackendAuthResourceConfig": { - "type": "structure", - "members": { - "AuthResources": { - "target": "com.amazonaws.amplifybackend#AuthResources", - "traits": { - "smithy.api#documentation": "

Defines whether you want to configure only authentication or both authentication and authorization settings.

", - "smithy.api#jsonName": "authResources", - "smithy.api#required": {} - } - }, - "IdentityPoolConfigs": { - "target": "com.amazonaws.amplifybackend#CreateBackendAuthIdentityPoolConfig", - "traits": { - "smithy.api#documentation": "

Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.

", - "smithy.api#jsonName": "identityPoolConfigs" - } - }, - "Service": { - "target": "com.amazonaws.amplifybackend#Service", - "traits": { - "smithy.api#documentation": "

Defines the service name to use when configuring an authentication resource in your Amplify project.

", - "smithy.api#jsonName": "service", - "smithy.api#required": {} - } - }, - "UserPoolConfigs": { - "target": "com.amazonaws.amplifybackend#CreateBackendAuthUserPoolConfig", - "traits": { - "smithy.api#documentation": "

Describes authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.

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

Defines the resource configuration when creating an auth resource in your Amplify project.

" - } - }, - "com.amazonaws.amplifybackend#CreateBackendAuthResponse": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId" - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName" - } - }, - "Error": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

If the request fails, this error is returned.

", - "smithy.api#jsonName": "error" - } - }, - "JobId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID for the job.

", - "smithy.api#jsonName": "jobId" - } - }, - "Operation": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the operation.

", - "smithy.api#jsonName": "operation" - } - }, - "Status": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The current status of the request.

", - "smithy.api#jsonName": "status" - } - } - } - }, - "com.amazonaws.amplifybackend#CreateBackendAuthUserPoolConfig": { - "type": "structure", - "members": { - "ForgotPassword": { - "target": "com.amazonaws.amplifybackend#CreateBackendAuthForgotPasswordConfig", - "traits": { - "smithy.api#documentation": "

(DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

", - "smithy.api#jsonName": "forgotPassword" - } - }, - "Mfa": { - "target": "com.amazonaws.amplifybackend#CreateBackendAuthMFAConfig", - "traits": { - "smithy.api#documentation": "

Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.

", - "smithy.api#jsonName": "mfa" - } - }, - "OAuth": { - "target": "com.amazonaws.amplifybackend#CreateBackendAuthOAuthConfig", - "traits": { - "smithy.api#documentation": "

Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.

", - "smithy.api#jsonName": "oAuth" - } - }, - "PasswordPolicy": { - "target": "com.amazonaws.amplifybackend#CreateBackendAuthPasswordPolicyConfig", - "traits": { - "smithy.api#documentation": "

Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

", - "smithy.api#jsonName": "passwordPolicy" - } - }, - "RequiredSignUpAttributes": { - "target": "com.amazonaws.amplifybackend#ListOfRequiredSignUpAttributesElement", - "traits": { - "smithy.api#documentation": "

The required attributes to sign up new users in the user pool.

", - "smithy.api#jsonName": "requiredSignUpAttributes", - "smithy.api#required": {} - } - }, - "SignInMethod": { - "target": "com.amazonaws.amplifybackend#SignInMethod", - "traits": { - "smithy.api#documentation": "

Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project.

", - "smithy.api#jsonName": "signInMethod", - "smithy.api#required": {} - } - }, - "UserPoolName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The Amazon Cognito user pool name.

", - "smithy.api#jsonName": "userPoolName", - "smithy.api#required": {} - } - }, - "VerificationMessage": { - "target": "com.amazonaws.amplifybackend#CreateBackendAuthVerificationMessageConfig", - "traits": { - "smithy.api#documentation": "

Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.

", - "smithy.api#jsonName": "verificationMessage" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Amazon Cognito user pool configuration for the auth resource to be configured for your Amplify project.

" - } - }, - "com.amazonaws.amplifybackend#CreateBackendAuthVerificationMessageConfig": { - "type": "structure", - "members": { - "DeliveryMethod": { - "target": "com.amazonaws.amplifybackend#DeliveryMethod", - "traits": { - "smithy.api#documentation": "

The type of verification message to send.

", - "smithy.api#jsonName": "deliveryMethod", - "smithy.api#required": {} - } - }, - "EmailSettings": { - "target": "com.amazonaws.amplifybackend#EmailSettings", - "traits": { - "smithy.api#documentation": "

The settings for the email message.

", - "smithy.api#jsonName": "emailSettings" - } - }, - "SmsSettings": { - "target": "com.amazonaws.amplifybackend#SmsSettings", - "traits": { - "smithy.api#documentation": "

The settings for the SMS message.

", - "smithy.api#jsonName": "smsSettings" - } - } - }, - "traits": { - "smithy.api#documentation": "

Creates an email or SMS verification message for the auth resource configured for your Amplify project.

" - } - }, - "com.amazonaws.amplifybackend#CreateBackendConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#CreateBackendConfigRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#CreateBackendConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a config object for a backend.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/config", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#CreateBackendConfigRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BackendManagerAppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID for the backend manager.

", - "smithy.api#jsonName": "backendManagerAppId" - } - } - }, - "traits": { - "smithy.api#documentation": "

The request body for CreateBackendConfig.

" - } - }, - "com.amazonaws.amplifybackend#CreateBackendConfigResponse": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId" - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName" - } - }, - "JobId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID for the job.

", - "smithy.api#jsonName": "jobId" - } - }, - "Status": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The current status of the request.

", - "smithy.api#jsonName": "status" - } - } - } - }, - "com.amazonaws.amplifybackend#CreateBackendRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId", - "smithy.api#required": {} - } - }, - "AppName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the app.

", - "smithy.api#jsonName": "appName", - "smithy.api#required": {} - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName", - "smithy.api#required": {} - } - }, - "ResourceConfig": { - "target": "com.amazonaws.amplifybackend#ResourceConfig", - "traits": { - "smithy.api#documentation": "

The resource configuration for creating a backend.

", - "smithy.api#jsonName": "resourceConfig" - } - }, - "ResourceName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the resource.

", - "smithy.api#jsonName": "resourceName" - } - } - }, - "traits": { - "smithy.api#documentation": "

The request body for CreateBackend.

" - } - }, - "com.amazonaws.amplifybackend#CreateBackendResponse": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId" - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName" - } - }, - "Error": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

If the request fails, this error is returned.

", - "smithy.api#jsonName": "error" - } - }, - "JobId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID for the job.

", - "smithy.api#jsonName": "jobId" - } - }, - "Operation": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the operation.

", - "smithy.api#jsonName": "operation" - } - }, - "Status": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The current status of the request.

", - "smithy.api#jsonName": "status" - } - } - } - }, - "com.amazonaws.amplifybackend#CreateBackendStorage": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#CreateBackendStorageRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#CreateBackendStorageResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a backend storage resource.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/storage", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#CreateBackendStorageRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName", - "smithy.api#required": {} - } - }, - "ResourceConfig": { - "target": "com.amazonaws.amplifybackend#CreateBackendStorageResourceConfig", - "traits": { - "smithy.api#documentation": "

The resource configuration for creating backend storage.

", - "smithy.api#jsonName": "resourceConfig", - "smithy.api#required": {} - } - }, - "ResourceName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the storage resource.

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

The request body for CreateBackendStorage.

" - } - }, - "com.amazonaws.amplifybackend#CreateBackendStorageResourceConfig": { - "type": "structure", - "members": { - "BucketName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the S3 bucket.

", - "smithy.api#jsonName": "bucketName" - } - }, - "Permissions": { - "target": "com.amazonaws.amplifybackend#BackendStoragePermissions", - "traits": { - "smithy.api#documentation": "

The authorization configuration for the storage S3 bucket.

", - "smithy.api#jsonName": "permissions", - "smithy.api#required": {} - } - }, - "ServiceName": { - "target": "com.amazonaws.amplifybackend#ServiceName", - "traits": { - "smithy.api#documentation": "

The name of the storage service.

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

The resource configuration for creating backend storage.

" - } - }, - "com.amazonaws.amplifybackend#CreateBackendStorageResponse": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId" - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName" - } - }, - "JobId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID for the job.

", - "smithy.api#jsonName": "jobId" - } - }, - "Status": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The current status of the request.

", - "smithy.api#jsonName": "status" - } - } - } - }, - "com.amazonaws.amplifybackend#CreateToken": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#CreateTokenRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#CreateTokenResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/challenge", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#CreateTokenRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.amplifybackend#CreateTokenResponse": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId" - } - }, - "ChallengeCode": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

One-time challenge code for authenticating into the Amplify Admin UI.

", - "smithy.api#jsonName": "challengeCode" - } - }, - "SessionId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

A unique ID provided when creating a new challenge token.

", - "smithy.api#jsonName": "sessionId" - } - }, - "Ttl": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The expiry time for the one-time generated token code.

", - "smithy.api#jsonName": "ttl" - } - } - } - }, - "com.amazonaws.amplifybackend#DeleteBackend": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#DeleteBackendRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#DeleteBackendResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes an existing environment from your Amplify project.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/environments/{BackendEnvironmentName}/remove", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#DeleteBackendAPI": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#DeleteBackendAPIRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#DeleteBackendAPIResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an existing backend API resource.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/api/{BackendEnvironmentName}/remove", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#DeleteBackendAPIRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ResourceConfig": { - "target": "com.amazonaws.amplifybackend#BackendAPIResourceConfig", - "traits": { - "smithy.api#documentation": "

Defines the resource configuration for the data model in your Amplify project.

", - "smithy.api#jsonName": "resourceConfig" - } - }, - "ResourceName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of this resource.

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

The request body for DeleteBackendAPI.

" - } - }, - "com.amazonaws.amplifybackend#DeleteBackendAPIResponse": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId" - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName" - } - }, - "Error": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

If the request fails, this error is returned.

", - "smithy.api#jsonName": "error" - } - }, - "JobId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID for the job.

", - "smithy.api#jsonName": "jobId" - } - }, - "Operation": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the operation.

", - "smithy.api#jsonName": "operation" - } - }, - "Status": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The current status of the request.

", - "smithy.api#jsonName": "status" - } - } - } - }, - "com.amazonaws.amplifybackend#DeleteBackendAuth": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#DeleteBackendAuthRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#DeleteBackendAuthResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an existing backend authentication resource.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/auth/{BackendEnvironmentName}/remove", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#DeleteBackendAuthRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ResourceName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of this resource.

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

The request body for DeleteBackendAuth.

" - } - }, - "com.amazonaws.amplifybackend#DeleteBackendAuthResponse": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId" - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName" - } - }, - "Error": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

If the request fails, this error is returned.

", - "smithy.api#jsonName": "error" - } - }, - "JobId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID for the job.

", - "smithy.api#jsonName": "jobId" - } - }, - "Operation": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the operation.

", - "smithy.api#jsonName": "operation" - } - }, - "Status": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The current status of the request.

", - "smithy.api#jsonName": "status" - } - } - } - }, - "com.amazonaws.amplifybackend#DeleteBackendRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.amplifybackend#DeleteBackendResponse": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId" - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName" - } - }, - "Error": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

If the request fails, this error is returned.

", - "smithy.api#jsonName": "error" - } - }, - "JobId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID for the job.

", - "smithy.api#jsonName": "jobId" - } - }, - "Operation": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the operation.

", - "smithy.api#jsonName": "operation" - } - }, - "Status": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The current status of the request.

", - "smithy.api#jsonName": "status" - } - } - } - }, - "com.amazonaws.amplifybackend#DeleteBackendStorage": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#DeleteBackendStorageRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#DeleteBackendStorageResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes the specified backend storage resource.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/storage/{BackendEnvironmentName}/remove", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#DeleteBackendStorageRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ResourceName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the storage resource.

", - "smithy.api#jsonName": "resourceName", - "smithy.api#required": {} - } - }, - "ServiceName": { - "target": "com.amazonaws.amplifybackend#ServiceName", - "traits": { - "smithy.api#documentation": "

The name of the storage service.

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

The request body for DeleteBackendStorage.

" - } - }, - "com.amazonaws.amplifybackend#DeleteBackendStorageResponse": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId" - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName" - } - }, - "JobId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID for the job.

", - "smithy.api#jsonName": "jobId" - } - }, - "Status": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The current status of the request.

", - "smithy.api#jsonName": "status" - } - } - } - }, - "com.amazonaws.amplifybackend#DeleteToken": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#DeleteTokenRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#DeleteTokenResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the challenge token based on the given appId and sessionId.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/challenge/{SessionId}/remove", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#DeleteTokenRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SessionId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The session ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.amplifybackend#DeleteTokenResponse": { - "type": "structure", - "members": { - "IsSuccess": { - "target": "com.amazonaws.amplifybackend#__boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the request succeeded or failed.

", - "smithy.api#jsonName": "isSuccess" - } - } - } - }, - "com.amazonaws.amplifybackend#DeliveryMethod": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The type of verification message to send.

", - "smithy.api#enum": [ - { - "value": "EMAIL", - "name": "EMAIL" - }, - { - "value": "SMS", - "name": "SMS" - } - ] - } - }, - "com.amazonaws.amplifybackend#EmailSettings": { - "type": "structure", - "members": { - "EmailMessage": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The contents of the email message.

", - "smithy.api#jsonName": "emailMessage" - } - }, - "EmailSubject": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The contents of the subject line of the email message.

", - "smithy.api#jsonName": "emailSubject" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for the email sent when an app user forgets their password.

" - } - }, - "com.amazonaws.amplifybackend#GatewayTimeoutException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

An error message to inform that the request failed.

", - "smithy.api#jsonName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

An error returned if there's a temporary issue with the service.

", - "smithy.api#error": "server", - "smithy.api#httpError": 504 - } - }, - "com.amazonaws.amplifybackend#GenerateBackendAPIModels": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#GenerateBackendAPIModelsRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#GenerateBackendAPIModelsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Generates a model schema for an existing backend API resource.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/api/{BackendEnvironmentName}/generateModels", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#GenerateBackendAPIModelsRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ResourceName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of this resource.

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

The request body for GenerateBackendAPIModels.

" - } - }, - "com.amazonaws.amplifybackend#GenerateBackendAPIModelsResponse": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId" - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName" - } - }, - "Error": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

If the request fails, this error is returned.

", - "smithy.api#jsonName": "error" - } - }, - "JobId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID for the job.

", - "smithy.api#jsonName": "jobId" - } - }, - "Operation": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the operation.

", - "smithy.api#jsonName": "operation" - } - }, - "Status": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The current status of the request.

", - "smithy.api#jsonName": "status" - } - } - } - }, - "com.amazonaws.amplifybackend#GetBackend": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#GetBackendRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#GetBackendResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides project-level details for your Amplify UI project.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/details", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#GetBackendAPI": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#GetBackendAPIRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#GetBackendAPIResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the details for a backend API.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/api/{BackendEnvironmentName}/details", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#GetBackendAPIModels": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#GetBackendAPIModelsRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#GetBackendAPIModelsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Generates a model schema for existing backend API resource.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/api/{BackendEnvironmentName}/getModels", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#GetBackendAPIModelsRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ResourceName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of this resource.

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

The request body for GetBackendAPIModels.

" - } - }, - "com.amazonaws.amplifybackend#GetBackendAPIModelsResponse": { - "type": "structure", - "members": { - "Models": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

Stringified JSON of the datastore model.

", - "smithy.api#jsonName": "models" - } - }, - "Status": { - "target": "com.amazonaws.amplifybackend#Status", - "traits": { - "smithy.api#documentation": "

The current status of the request.

", - "smithy.api#jsonName": "status" - } - } - } - }, - "com.amazonaws.amplifybackend#GetBackendAPIRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ResourceConfig": { - "target": "com.amazonaws.amplifybackend#BackendAPIResourceConfig", - "traits": { - "smithy.api#documentation": "

Defines the resource configuration for the data model in your Amplify project.

", - "smithy.api#jsonName": "resourceConfig" - } - }, - "ResourceName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of this resource.

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

The request body for GetBackendAPI.

" - } - }, - "com.amazonaws.amplifybackend#GetBackendAPIResponse": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId" - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName" - } - }, - "Error": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

If the request fails, this error is returned.

", - "smithy.api#jsonName": "error" - } - }, - "ResourceConfig": { - "target": "com.amazonaws.amplifybackend#BackendAPIResourceConfig", - "traits": { - "smithy.api#documentation": "

The resource configuration for this response object.

", - "smithy.api#jsonName": "resourceConfig" - } - }, - "ResourceName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of this resource.

", - "smithy.api#jsonName": "resourceName" - } - } - } - }, - "com.amazonaws.amplifybackend#GetBackendAuth": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#GetBackendAuthRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#GetBackendAuthResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets a backend auth details.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/auth/{BackendEnvironmentName}/details", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#GetBackendAuthRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ResourceName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of this resource.

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

The request body for GetBackendAuth.

" - } - }, - "com.amazonaws.amplifybackend#GetBackendAuthResponse": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId" - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName" - } - }, - "Error": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

If the request fails, this error is returned.

", - "smithy.api#jsonName": "error" - } - }, - "ResourceConfig": { - "target": "com.amazonaws.amplifybackend#CreateBackendAuthResourceConfig", - "traits": { - "smithy.api#documentation": "

The resource configuration for authorization requests to the backend of your Amplify project.

", - "smithy.api#jsonName": "resourceConfig" - } - }, - "ResourceName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of this resource.

", - "smithy.api#jsonName": "resourceName" - } - } - } - }, - "com.amazonaws.amplifybackend#GetBackendJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#GetBackendJobRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#GetBackendJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a specific job.

", - "smithy.api#http": { - "method": "GET", - "uri": "/backend/{AppId}/job/{BackendEnvironmentName}/{JobId}", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#GetBackendJobRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "JobId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID for the job.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.amplifybackend#GetBackendJobResponse": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId" - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName" - } - }, - "CreateTime": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The time when the job was created.

", - "smithy.api#jsonName": "createTime" - } - }, - "Error": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

If the request fails, this error is returned.

", - "smithy.api#jsonName": "error" - } - }, - "JobId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID for the job.

", - "smithy.api#jsonName": "jobId" - } - }, - "Operation": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the operation.

", - "smithy.api#jsonName": "operation" - } - }, - "Status": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The current status of the request.

", - "smithy.api#jsonName": "status" - } - }, - "UpdateTime": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The time when the job was last updated.

", - "smithy.api#jsonName": "updateTime" - } - } - } - }, - "com.amazonaws.amplifybackend#GetBackendRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName" - } - } - }, - "traits": { - "smithy.api#documentation": "

The request body for GetBackend.

" - } - }, - "com.amazonaws.amplifybackend#GetBackendResponse": { - "type": "structure", - "members": { - "AmplifyFeatureFlags": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

A stringified version of the cli.json file for your Amplify project.

", - "smithy.api#jsonName": "amplifyFeatureFlags" - } - }, - "AmplifyMetaConfig": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

A stringified version of the current configs for your Amplify project.

", - "smithy.api#jsonName": "amplifyMetaConfig" - } - }, - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId" - } - }, - "AppName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the app.

", - "smithy.api#jsonName": "appName" - } - }, - "BackendEnvironmentList": { - "target": "com.amazonaws.amplifybackend#ListOf__string", - "traits": { - "smithy.api#documentation": "

A list of backend environments in an array.

", - "smithy.api#jsonName": "backendEnvironmentList" - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName" - } - }, - "Error": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

If the request failed, this is the returned error.

", - "smithy.api#jsonName": "error" - } - } - } - }, - "com.amazonaws.amplifybackend#GetBackendStorage": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#GetBackendStorageRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#GetBackendStorageResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets details for a backend storage resource.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/storage/{BackendEnvironmentName}/details", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#GetBackendStorageRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ResourceName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the storage resource.

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

The request body for GetBackendStorage.

" - } - }, - "com.amazonaws.amplifybackend#GetBackendStorageResourceConfig": { - "type": "structure", - "members": { - "BucketName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the S3 bucket.

", - "smithy.api#jsonName": "bucketName" - } - }, - "Imported": { - "target": "com.amazonaws.amplifybackend#__boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Returns True if the storage resource has been imported.

", - "smithy.api#jsonName": "imported", - "smithy.api#required": {} - } - }, - "Permissions": { - "target": "com.amazonaws.amplifybackend#BackendStoragePermissions", - "traits": { - "smithy.api#documentation": "

The authorization configuration for the storage S3 bucket.

", - "smithy.api#jsonName": "permissions" - } - }, - "ServiceName": { - "target": "com.amazonaws.amplifybackend#ServiceName", - "traits": { - "smithy.api#documentation": "

The name of the storage service.

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

The details for a backend storage resource.

" - } - }, - "com.amazonaws.amplifybackend#GetBackendStorageResponse": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId" - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName" - } - }, - "ResourceConfig": { - "target": "com.amazonaws.amplifybackend#GetBackendStorageResourceConfig", - "traits": { - "smithy.api#documentation": "

The resource configuration for the backend storage resource.

", - "smithy.api#jsonName": "resourceConfig" - } - }, - "ResourceName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the storage resource.

", - "smithy.api#jsonName": "resourceName" - } - } - } - }, - "com.amazonaws.amplifybackend#GetToken": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#GetTokenRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#GetTokenResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the challenge token based on the given appId and sessionId.

", - "smithy.api#http": { - "method": "GET", - "uri": "/backend/{AppId}/challenge/{SessionId}", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#GetTokenRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SessionId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The session ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.amplifybackend#GetTokenResponse": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId" - } - }, - "ChallengeCode": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The one-time challenge code for authenticating into the Amplify Admin UI.

", - "smithy.api#jsonName": "challengeCode" - } - }, - "SessionId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

A unique ID provided when creating a new challenge token.

", - "smithy.api#jsonName": "sessionId" - } - }, - "Ttl": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The expiry time for the one-time generated token code.

", - "smithy.api#jsonName": "ttl" - } - } - } - }, - "com.amazonaws.amplifybackend#ImportBackendAuth": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#ImportBackendAuthRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#ImportBackendAuthResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Imports an existing backend authentication resource.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/auth/{BackendEnvironmentName}/import", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#ImportBackendAuthRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "IdentityPoolId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Cognito identity pool.

", - "smithy.api#jsonName": "identityPoolId" - } - }, - "NativeClientId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Cognito native client.

", - "smithy.api#jsonName": "nativeClientId", - "smithy.api#required": {} - } - }, - "UserPoolId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Cognito user pool.

", - "smithy.api#jsonName": "userPoolId", - "smithy.api#required": {} - } - }, - "WebClientId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Cognito web client.

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

The request body for ImportBackendAuth.

" - } - }, - "com.amazonaws.amplifybackend#ImportBackendAuthResponse": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId" - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName" - } - }, - "Error": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

If the request fails, this error is returned.

", - "smithy.api#jsonName": "error" - } - }, - "JobId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID for the job.

", - "smithy.api#jsonName": "jobId" - } - }, - "Operation": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the operation.

", - "smithy.api#jsonName": "operation" - } - }, - "Status": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The current status of the request.

", - "smithy.api#jsonName": "status" - } - } - } - }, - "com.amazonaws.amplifybackend#ImportBackendStorage": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#ImportBackendStorageRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#ImportBackendStorageResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Imports an existing backend storage resource.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/storage/{BackendEnvironmentName}/import", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#ImportBackendStorageRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BucketName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the S3 bucket.

", - "smithy.api#jsonName": "bucketName" - } - }, - "ServiceName": { - "target": "com.amazonaws.amplifybackend#ServiceName", - "traits": { - "smithy.api#documentation": "

The name of the storage service.

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

The request body for ImportBackendStorage.

" - } - }, - "com.amazonaws.amplifybackend#ImportBackendStorageResponse": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId" - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName" - } - }, - "JobId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID for the job.

", - "smithy.api#jsonName": "jobId" - } - }, - "Status": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The current status of the request.

", - "smithy.api#jsonName": "status" - } - } - } - }, - "com.amazonaws.amplifybackend#ListBackendJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#ListBackendJobsRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#ListBackendJobsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the jobs for the backend of an Amplify app.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/job/{BackendEnvironmentName}", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#ListBackendJobsRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "JobId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID for the job.

", - "smithy.api#jsonName": "jobId" - } - }, - "MaxResults": { - "target": "com.amazonaws.amplifybackend#__integerMin1Max25", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results that you want in the response.

", - "smithy.api#jsonName": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

", - "smithy.api#jsonName": "nextToken" - } - }, - "Operation": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

Filters the list of response objects to include only those with the specified operation name.

", - "smithy.api#jsonName": "operation" - } - }, - "Status": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

Filters the list of response objects to include only those with the specified status.

", - "smithy.api#jsonName": "status" - } - } - }, - "traits": { - "smithy.api#documentation": "

The request body for ListBackendJobs.

" - } - }, - "com.amazonaws.amplifybackend#ListBackendJobsResponse": { - "type": "structure", - "members": { - "Jobs": { - "target": "com.amazonaws.amplifybackend#ListOfBackendJobRespObj", - "traits": { - "smithy.api#documentation": "

An array of jobs and their properties.

", - "smithy.api#jsonName": "jobs" - } - }, - "NextToken": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

", - "smithy.api#jsonName": "nextToken" - } - } - } - }, - "com.amazonaws.amplifybackend#ListOfAdditionalConstraintsElement": { - "type": "list", - "member": { - "target": "com.amazonaws.amplifybackend#AdditionalConstraintsElement" - } - }, - "com.amazonaws.amplifybackend#ListOfAuthenticatedElement": { - "type": "list", - "member": { - "target": "com.amazonaws.amplifybackend#AuthenticatedElement" - } - }, - "com.amazonaws.amplifybackend#ListOfBackendAPIAuthType": { - "type": "list", - "member": { - "target": "com.amazonaws.amplifybackend#BackendAPIAuthType" - } - }, - "com.amazonaws.amplifybackend#ListOfBackendJobRespObj": { - "type": "list", - "member": { - "target": "com.amazonaws.amplifybackend#BackendJobRespObj" - } - }, - "com.amazonaws.amplifybackend#ListOfMfaTypesElement": { - "type": "list", - "member": { - "target": "com.amazonaws.amplifybackend#MfaTypesElement" - } - }, - "com.amazonaws.amplifybackend#ListOfOAuthScopesElement": { - "type": "list", - "member": { - "target": "com.amazonaws.amplifybackend#OAuthScopesElement" - } - }, - "com.amazonaws.amplifybackend#ListOfRequiredSignUpAttributesElement": { - "type": "list", - "member": { - "target": "com.amazonaws.amplifybackend#RequiredSignUpAttributesElement" - } - }, - "com.amazonaws.amplifybackend#ListOfS3BucketInfo": { - "type": "list", - "member": { - "target": "com.amazonaws.amplifybackend#S3BucketInfo" - } - }, - "com.amazonaws.amplifybackend#ListOfUnAuthenticatedElement": { - "type": "list", - "member": { - "target": "com.amazonaws.amplifybackend#UnAuthenticatedElement" - } - }, - "com.amazonaws.amplifybackend#ListOf__string": { - "type": "list", - "member": { - "target": "com.amazonaws.amplifybackend#__string" - } - }, - "com.amazonaws.amplifybackend#ListS3Buckets": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#ListS3BucketsRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#ListS3BucketsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

The list of S3 buckets in your account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/s3Buckets", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#ListS3BucketsRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

Reserved for future use.

", - "smithy.api#jsonName": "nextToken" - } - } - }, - "traits": { - "smithy.api#documentation": "

The request body for S3Buckets.

" - } - }, - "com.amazonaws.amplifybackend#ListS3BucketsResponse": { - "type": "structure", - "members": { - "Buckets": { - "target": "com.amazonaws.amplifybackend#ListOfS3BucketInfo", - "traits": { - "smithy.api#documentation": "

The list of S3 buckets.

", - "smithy.api#jsonName": "buckets" - } - }, - "NextToken": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

Reserved for future use.

", - "smithy.api#jsonName": "nextToken" - } - } - } - }, - "com.amazonaws.amplifybackend#LoginAuthConfigReqObj": { - "type": "structure", - "members": { - "AwsCognitoIdentityPoolId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The Amazon Cognito identity pool ID used for the Amplify Admin UI login authorization.

", - "smithy.api#jsonName": "aws_cognito_identity_pool_id" - } - }, - "AwsCognitoRegion": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The AWS Region for the Amplify Admin UI login.

", - "smithy.api#jsonName": "aws_cognito_region" - } - }, - "AwsUserPoolsId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The Amazon Cognito user pool ID used for Amplify Admin UI login authentication.

", - "smithy.api#jsonName": "aws_user_pools_id" - } - }, - "AwsUserPoolsWebClientId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The web client ID for the Amazon Cognito user pools.

", - "smithy.api#jsonName": "aws_user_pools_web_client_id" - } - } - }, - "traits": { - "smithy.api#documentation": "

The request object for this operation.

" - } - }, - "com.amazonaws.amplifybackend#MFAMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ON", - "name": "ON" - }, - { - "value": "OFF", - "name": "OFF" - }, - { - "value": "OPTIONAL", - "name": "OPTIONAL" - } - ] - } - }, - "com.amazonaws.amplifybackend#MfaTypesElement": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SMS", - "name": "SMS" - }, - { - "value": "TOTP", - "name": "TOTP" - } - ] - } - }, - "com.amazonaws.amplifybackend#Mode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "API_KEY", - "name": "API_KEY" - }, - { - "value": "AWS_IAM", - "name": "AWS_IAM" - }, - { - "value": "AMAZON_COGNITO_USER_POOLS", - "name": "AMAZON_COGNITO_USER_POOLS" - }, - { - "value": "OPENID_CONNECT", - "name": "OPENID_CONNECT" - } - ] - } - }, - "com.amazonaws.amplifybackend#NotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

An error message to inform that the request has failed.

", - "smithy.api#jsonName": "message" - } - }, - "ResourceType": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The type of resource that is not found.

", - "smithy.api#jsonName": "resourceType" - } - } - }, - "traits": { - "smithy.api#documentation": "

An error returned when a specific resource type is not found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.amplifybackend#OAuthGrantType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CODE", - "name": "CODE" - }, - { - "value": "IMPLICIT", - "name": "IMPLICIT" - } - ] - } - }, - "com.amazonaws.amplifybackend#OAuthScopesElement": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PHONE", - "name": "PHONE" - }, - { - "value": "EMAIL", - "name": "EMAIL" - }, - { - "value": "OPENID", - "name": "OPENID" - }, - { - "value": "PROFILE", - "name": "PROFILE" - }, - { - "value": "AWS_COGNITO_SIGNIN_USER_ADMIN", - "name": "AWS_COGNITO_SIGNIN_USER_ADMIN" - } - ] - } - }, - "com.amazonaws.amplifybackend#RemoveAllBackends": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#RemoveAllBackendsRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#RemoveAllBackendsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes all backend environments from your Amplify project.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/remove", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#RemoveAllBackendsRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "CleanAmplifyApp": { - "target": "com.amazonaws.amplifybackend#__boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Cleans up the Amplify Console app if this value is set to true.

", - "smithy.api#jsonName": "cleanAmplifyApp" - } - } - }, - "traits": { - "smithy.api#documentation": "

The request body for RemoveAllBackends.

" - } - }, - "com.amazonaws.amplifybackend#RemoveAllBackendsResponse": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId" - } - }, - "Error": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

If the request fails, this error is returned.

", - "smithy.api#jsonName": "error" - } - }, - "JobId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID for the job.

", - "smithy.api#jsonName": "jobId" - } - }, - "Operation": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the operation.

", - "smithy.api#jsonName": "operation" - } - }, - "Status": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The current status of the request.

", - "smithy.api#jsonName": "status" - } - } - } - }, - "com.amazonaws.amplifybackend#RemoveBackendConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#RemoveBackendConfigRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#RemoveBackendConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes the AWS resources required to access the Amplify Admin UI.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/config/remove", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#RemoveBackendConfigRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.amplifybackend#RemoveBackendConfigResponse": { - "type": "structure", - "members": { - "Error": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

If the request fails, this error is returned.

", - "smithy.api#jsonName": "error" - } - } - } - }, - "com.amazonaws.amplifybackend#RequiredSignUpAttributesElement": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ADDRESS", - "name": "ADDRESS" - }, - { - "value": "BIRTHDATE", - "name": "BIRTHDATE" - }, - { - "value": "EMAIL", - "name": "EMAIL" - }, - { - "value": "FAMILY_NAME", - "name": "FAMILY_NAME" - }, - { - "value": "GENDER", - "name": "GENDER" - }, - { - "value": "GIVEN_NAME", - "name": "GIVEN_NAME" - }, - { - "value": "LOCALE", - "name": "LOCALE" - }, - { - "value": "MIDDLE_NAME", - "name": "MIDDLE_NAME" - }, - { - "value": "NAME", - "name": "NAME" - }, - { - "value": "NICKNAME", - "name": "NICKNAME" - }, - { - "value": "PHONE_NUMBER", - "name": "PHONE_NUMBER" - }, - { - "value": "PICTURE", - "name": "PICTURE" - }, - { - "value": "PREFERRED_USERNAME", - "name": "PREFERRED_USERNAME" - }, - { - "value": "PROFILE", - "name": "PROFILE" - }, - { - "value": "UPDATED_AT", - "name": "UPDATED_AT" - }, - { - "value": "WEBSITE", - "name": "WEBSITE" - }, - { - "value": "ZONE_INFO", - "name": "ZONE_INFO" - } - ] - } - }, - "com.amazonaws.amplifybackend#ResolutionStrategy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "OPTIMISTIC_CONCURRENCY", - "name": "OPTIMISTIC_CONCURRENCY" - }, - { - "value": "LAMBDA", - "name": "LAMBDA" - }, - { - "value": "AUTOMERGE", - "name": "AUTOMERGE" - }, - { - "value": "NONE", - "name": "NONE" - } - ] - } - }, - "com.amazonaws.amplifybackend#ResourceConfig": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Defines the resource configuration for the data model in your Amplify project.

" - } - }, - "com.amazonaws.amplifybackend#S3BucketInfo": { - "type": "structure", - "members": { - "CreationDate": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The creation date of the S3 bucket.

", - "smithy.api#jsonName": "creationDate" - } - }, - "Name": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the S3 bucket.

", - "smithy.api#jsonName": "name" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the metadata of the S3 bucket.

" - } - }, - "com.amazonaws.amplifybackend#Service": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "COGNITO", - "name": "COGNITO" - } - ] - } - }, - "com.amazonaws.amplifybackend#ServiceName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "S3", - "name": "S3" - } - ] - } - }, - "com.amazonaws.amplifybackend#Settings": { - "type": "structure", - "members": { - "MfaTypes": { - "target": "com.amazonaws.amplifybackend#ListOfMfaTypesElement", - "traits": { - "smithy.api#documentation": "

The supported MFA types.

", - "smithy.api#jsonName": "mfaTypes" - } - }, - "SmsMessage": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The body of the SMS message.

", - "smithy.api#jsonName": "smsMessage" - } - } - }, - "traits": { - "smithy.api#documentation": "

The settings of your MFA configuration for the backend of your Amplify project.

" - } - }, - "com.amazonaws.amplifybackend#SignInMethod": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EMAIL", - "name": "EMAIL" - }, - { - "value": "EMAIL_AND_PHONE_NUMBER", - "name": "EMAIL_AND_PHONE_NUMBER" - }, - { - "value": "PHONE_NUMBER", - "name": "PHONE_NUMBER" - }, - { - "value": "USERNAME", - "name": "USERNAME" - } - ] - } - }, - "com.amazonaws.amplifybackend#SmsSettings": { - "type": "structure", - "members": { - "SmsMessage": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The contents of the SMS message.

", - "smithy.api#jsonName": "smsMessage" - } - } - }, - "traits": { - "smithy.api#documentation": "

SMS settings for authentication.

" - } - }, - "com.amazonaws.amplifybackend#SocialProviderSettings": { - "type": "structure", - "members": { - "Facebook": { - "target": "com.amazonaws.amplifybackend#BackendAuthSocialProviderConfig" + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.us-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.us-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.eu-north-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-north-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-north-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.eu-north-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-north-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-north-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.eu-west-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-3", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-3", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.eu-west-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-3", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-3", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.eu-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.eu-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.eu-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.eu-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.ap-northeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.ap-northeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-2", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-2", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.ap-northeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-1", + "UseFIPS": false + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.me-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "me-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.me-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "me-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.me-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "me-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.me-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "me-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.sa-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "sa-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "sa-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.sa-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "sa-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "sa-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.ap-southeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-2", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-2", + "UseFIPS": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.us-east-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-east-2", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-2", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.us-east-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-east-2", + "UseFIPS": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://amplifybackend.us-east-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-2", + "UseFIPS": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": 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": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": true, + "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": { + "UseDualStack": true, + "Region": "us-east-1", + "UseFIPS": false, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.amplifybackend#AuthResources": { + "type": "enum", + "members": { + "USER_POOL_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_POOL_ONLY" + } + }, + "IDENTITY_POOL_AND_USER_POOL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IDENTITY_POOL_AND_USER_POOL" + } + } + } + }, + "com.amazonaws.amplifybackend#AuthenticatedElement": { + "type": "enum", + "members": { + "READ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ" + } + }, + "CREATE_AND_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_AND_UPDATE" + } + }, + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + } + } + }, + "com.amazonaws.amplifybackend#BackendAPIAppSyncAuthSettings": { + "type": "structure", + "members": { + "CognitoUserPoolId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.

", + "smithy.api#jsonName": "cognitoUserPoolId" + } + }, + "Description": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.

", + "smithy.api#jsonName": "description" + } + }, + "ExpirationTime": { + "target": "com.amazonaws.amplifybackend#__double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.

", + "smithy.api#jsonName": "expirationTime" + } + }, + "OpenIDAuthTTL": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The expiry time for the OpenID authentication mechanism.

", + "smithy.api#jsonName": "openIDAuthTTL" + } + }, + "OpenIDClientId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The clientID for openID, if openID was used as an authentication setting to access your data models.

", + "smithy.api#jsonName": "openIDClientId" + } + }, + "OpenIDIatTTL": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The expiry time for the OpenID authentication mechanism.

", + "smithy.api#jsonName": "openIDIatTTL" + } + }, + "OpenIDIssueURL": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The openID issuer URL, if openID was used as an authentication setting to access your data models.

", + "smithy.api#jsonName": "openIDIssueURL" + } + }, + "OpenIDProviderName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.

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

The authentication settings for accessing provisioned data models in your Amplify project.

" + } + }, + "com.amazonaws.amplifybackend#BackendAPIAuthType": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.amplifybackend#Mode", + "traits": { + "smithy.api#documentation": "

Describes the authentication mode.

", + "smithy.api#jsonName": "mode" + } + }, + "Settings": { + "target": "com.amazonaws.amplifybackend#BackendAPIAppSyncAuthSettings", + "traits": { + "smithy.api#documentation": "

Describes settings for the authentication mode.

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

Describes the auth types for your configured data models.

" + } + }, + "com.amazonaws.amplifybackend#BackendAPIConflictResolution": { + "type": "structure", + "members": { + "ResolutionStrategy": { + "target": "com.amazonaws.amplifybackend#ResolutionStrategy", + "traits": { + "smithy.api#documentation": "

The strategy for conflict resolution.

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

Describes the conflict resolution configuration for your data model configured in your Amplify project.

" + } + }, + "com.amazonaws.amplifybackend#BackendAPIResourceConfig": { + "type": "structure", + "members": { + "AdditionalAuthTypes": { + "target": "com.amazonaws.amplifybackend#ListOfBackendAPIAuthType", + "traits": { + "smithy.api#documentation": "

Additional authentication methods used to interact with your data models.

", + "smithy.api#jsonName": "additionalAuthTypes" + } + }, + "ApiName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The API name used to interact with the data model, configured as a part of your Amplify project.

", + "smithy.api#jsonName": "apiName" + } + }, + "ConflictResolution": { + "target": "com.amazonaws.amplifybackend#BackendAPIConflictResolution", + "traits": { + "smithy.api#documentation": "

The conflict resolution strategy for your data stored in the data models.

", + "smithy.api#jsonName": "conflictResolution" + } + }, + "DefaultAuthType": { + "target": "com.amazonaws.amplifybackend#BackendAPIAuthType", + "traits": { + "smithy.api#documentation": "

The default authentication type for interacting with the configured data models in your Amplify project.

", + "smithy.api#jsonName": "defaultAuthType" + } + }, + "Service": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The service used to provision and interact with the data model.

", + "smithy.api#jsonName": "service" + } + }, + "TransformSchema": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The definition of the data model in the annotated transform of the GraphQL schema.

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

The resource config for the data model, configured as a part of the Amplify project.

" + } + }, + "com.amazonaws.amplifybackend#BackendAuthAppleProviderConfig": { + "type": "structure", + "members": { + "ClientId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

Describes the client_id (also called Services ID) that comes from Apple.

", + "smithy.api#jsonName": "client_id" + } + }, + "KeyId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

Describes the key_id that comes from Apple.

", + "smithy.api#jsonName": "key_id" + } + }, + "PrivateKey": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

Describes the private_key that comes from Apple.

", + "smithy.api#jsonName": "private_key" + } + }, + "TeamId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

Describes the team_id that comes from Apple.

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

Describes Apple social federation configurations for allowing your app users to sign in using OAuth.

" + } + }, + "com.amazonaws.amplifybackend#BackendAuthSocialProviderConfig": { + "type": "structure", + "members": { + "ClientId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

Describes the client_id, which can be obtained from the third-party social federation provider.

", + "smithy.api#jsonName": "client_id" + } + }, + "ClientSecret": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

Describes the client_secret, which can be obtained from third-party social federation providers.

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

Describes third-party social federation configurations for allowing your app users to sign in using OAuth.

" + } + }, + "com.amazonaws.amplifybackend#BackendJobRespObj": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId", + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName", + "smithy.api#required": {} + } + }, + "CreateTime": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The time when the job was created.

", + "smithy.api#jsonName": "createTime" + } + }, + "Error": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

If the request fails, this error is returned.

", + "smithy.api#jsonName": "error" + } + }, + "JobId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID for the job.

", + "smithy.api#jsonName": "jobId" + } + }, + "Operation": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the operation.

", + "smithy.api#jsonName": "operation" + } + }, + "Status": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The current status of the request.

", + "smithy.api#jsonName": "status" + } + }, + "UpdateTime": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The time when the job was last updated.

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

The response object for this operation.

" + } + }, + "com.amazonaws.amplifybackend#BackendStoragePermissions": { + "type": "structure", + "members": { + "Authenticated": { + "target": "com.amazonaws.amplifybackend#ListOfAuthenticatedElement", + "traits": { + "smithy.api#documentation": "

Lists all authenticated user read, write, and delete permissions for your S3 bucket.

", + "smithy.api#jsonName": "authenticated", + "smithy.api#required": {} + } + }, + "UnAuthenticated": { + "target": "com.amazonaws.amplifybackend#ListOfUnAuthenticatedElement", + "traits": { + "smithy.api#documentation": "

Lists all unauthenticated user read, write, and delete permissions for your S3 bucket.

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

Describes the read, write, and delete permissions users have against your storage S3 bucket.

" + } + }, + "com.amazonaws.amplifybackend#BadRequestException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

An error message to inform that the request failed.

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

An error returned if a request is not formed properly.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.amplifybackend#CloneBackend": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#CloneBackendRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#CloneBackendResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

This operation clones an existing backend.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/environments/{BackendEnvironmentName}/clone", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#CloneBackendRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TargetEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the destination backend environment to be created.

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

The request body for CloneBackend.

" + } + }, + "com.amazonaws.amplifybackend#CloneBackendResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName" + } + }, + "Error": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

If the request fails, this error is returned.

", + "smithy.api#jsonName": "error" + } + }, + "JobId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID for the job.

", + "smithy.api#jsonName": "jobId" + } + }, + "Operation": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the operation.

", + "smithy.api#jsonName": "operation" + } + }, + "Status": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The current status of the request.

", + "smithy.api#jsonName": "status" + } + } + } + }, + "com.amazonaws.amplifybackend#CreateBackend": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#CreateBackendRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#CreateBackendResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#CreateBackendAPI": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#CreateBackendAPIRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#CreateBackendAPIResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new backend API resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/api", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#CreateBackendAPIRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName", + "smithy.api#required": {} + } + }, + "ResourceConfig": { + "target": "com.amazonaws.amplifybackend#BackendAPIResourceConfig", + "traits": { + "smithy.api#documentation": "

The resource configuration for this request.

", + "smithy.api#jsonName": "resourceConfig", + "smithy.api#required": {} + } + }, + "ResourceName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of this resource.

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

The request body for CreateBackendAPI.

" + } + }, + "com.amazonaws.amplifybackend#CreateBackendAPIResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName" + } + }, + "Error": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

If the request fails, this error is returned.

", + "smithy.api#jsonName": "error" + } + }, + "JobId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID for the job.

", + "smithy.api#jsonName": "jobId" + } + }, + "Operation": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the operation.

", + "smithy.api#jsonName": "operation" + } + }, + "Status": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The current status of the request.

", + "smithy.api#jsonName": "status" + } + } + } + }, + "com.amazonaws.amplifybackend#CreateBackendAuth": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#CreateBackendAuthRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#CreateBackendAuthResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new backend authentication resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/auth", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#CreateBackendAuthForgotPasswordConfig": { + "type": "structure", + "members": { + "DeliveryMethod": { + "target": "com.amazonaws.amplifybackend#DeliveryMethod", + "traits": { + "smithy.api#documentation": "

(DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.

", + "smithy.api#jsonName": "deliveryMethod", + "smithy.api#required": {} + } + }, + "EmailSettings": { + "target": "com.amazonaws.amplifybackend#EmailSettings", + "traits": { + "smithy.api#documentation": "

(DEPRECATED) The configuration for the email sent when an app user forgets their password.

", + "smithy.api#jsonName": "emailSettings" + } + }, + "SmsSettings": { + "target": "com.amazonaws.amplifybackend#SmsSettings", + "traits": { + "smithy.api#documentation": "

(DEPRECATED) The configuration for the SMS message sent when an app user forgets their password.

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

(DEPRECATED) Describes the forgot password policy for authenticating into the Amplify app.

" + } + }, + "com.amazonaws.amplifybackend#CreateBackendAuthIdentityPoolConfig": { + "type": "structure", + "members": { + "IdentityPoolName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

Name of the Amazon Cognito identity pool used for authorization.

", + "smithy.api#jsonName": "identityPoolName", + "smithy.api#required": {} + } + }, + "UnauthenticatedLogin": { + "target": "com.amazonaws.amplifybackend#__boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Set to true or false based on whether you want to enable guest authorization to your Amplify app.

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

Describes authorization configurations for the auth resources, configured as a part of your Amplify project.

" + } + }, + "com.amazonaws.amplifybackend#CreateBackendAuthMFAConfig": { + "type": "structure", + "members": { + "MFAMode": { + "target": "com.amazonaws.amplifybackend#MFAMode", + "traits": { + "smithy.api#documentation": "

Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.

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

Describes the configuration settings and methods for your Amplify app users to use MFA.

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

Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.

" + } + }, + "com.amazonaws.amplifybackend#CreateBackendAuthOAuthConfig": { + "type": "structure", + "members": { + "DomainPrefix": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The domain prefix for your Amplify app.

", + "smithy.api#jsonName": "domainPrefix" + } + }, + "OAuthGrantType": { + "target": "com.amazonaws.amplifybackend#OAuthGrantType", + "traits": { + "smithy.api#documentation": "

The OAuth grant type that you use to allow app users to authenticate from your Amplify app.

", + "smithy.api#jsonName": "oAuthGrantType", + "smithy.api#required": {} + } + }, + "OAuthScopes": { + "target": "com.amazonaws.amplifybackend#ListOfOAuthScopesElement", + "traits": { + "smithy.api#documentation": "

List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.

", + "smithy.api#jsonName": "oAuthScopes", + "smithy.api#required": {} + } + }, + "RedirectSignInURIs": { + "target": "com.amazonaws.amplifybackend#ListOf__string", + "traits": { + "smithy.api#documentation": "

The redirected URI for signing in to your Amplify app.

", + "smithy.api#jsonName": "redirectSignInURIs", + "smithy.api#required": {} + } + }, + "RedirectSignOutURIs": { + "target": "com.amazonaws.amplifybackend#ListOf__string", + "traits": { + "smithy.api#documentation": "

Redirect URLs that OAuth uses when a user signs out of an Amplify app.

", + "smithy.api#jsonName": "redirectSignOutURIs", + "smithy.api#required": {} + } + }, + "SocialProviderSettings": { + "target": "com.amazonaws.amplifybackend#SocialProviderSettings", + "traits": { + "smithy.api#documentation": "

The settings for using social providers to access your Amplify app.

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

Creates the OAuth configuration for your Amplify project.

" + } + }, + "com.amazonaws.amplifybackend#CreateBackendAuthPasswordPolicyConfig": { + "type": "structure", + "members": { + "AdditionalConstraints": { + "target": "com.amazonaws.amplifybackend#ListOfAdditionalConstraintsElement", + "traits": { + "smithy.api#documentation": "

Additional constraints for the password used to access the backend of your Amplify project.

", + "smithy.api#jsonName": "additionalConstraints" + } + }, + "MinimumLength": { + "target": "com.amazonaws.amplifybackend#__double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum length of the password used to access the backend of your Amplify project.

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

The password policy configuration for the backend to your Amplify project.

" + } + }, + "com.amazonaws.amplifybackend#CreateBackendAuthRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName", + "smithy.api#required": {} + } + }, + "ResourceConfig": { + "target": "com.amazonaws.amplifybackend#CreateBackendAuthResourceConfig", + "traits": { + "smithy.api#documentation": "

The resource configuration for this request object.

", + "smithy.api#jsonName": "resourceConfig", + "smithy.api#required": {} + } + }, + "ResourceName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of this resource.

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

The request body for CreateBackendAuth.

" + } + }, + "com.amazonaws.amplifybackend#CreateBackendAuthResourceConfig": { + "type": "structure", + "members": { + "AuthResources": { + "target": "com.amazonaws.amplifybackend#AuthResources", + "traits": { + "smithy.api#documentation": "

Defines whether you want to configure only authentication or both authentication and authorization settings.

", + "smithy.api#jsonName": "authResources", + "smithy.api#required": {} + } + }, + "IdentityPoolConfigs": { + "target": "com.amazonaws.amplifybackend#CreateBackendAuthIdentityPoolConfig", + "traits": { + "smithy.api#documentation": "

Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.

", + "smithy.api#jsonName": "identityPoolConfigs" + } + }, + "Service": { + "target": "com.amazonaws.amplifybackend#Service", + "traits": { + "smithy.api#documentation": "

Defines the service name to use when configuring an authentication resource in your Amplify project.

", + "smithy.api#jsonName": "service", + "smithy.api#required": {} + } + }, + "UserPoolConfigs": { + "target": "com.amazonaws.amplifybackend#CreateBackendAuthUserPoolConfig", + "traits": { + "smithy.api#documentation": "

Describes authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.

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

Defines the resource configuration when creating an auth resource in your Amplify project.

" + } + }, + "com.amazonaws.amplifybackend#CreateBackendAuthResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName" + } + }, + "Error": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

If the request fails, this error is returned.

", + "smithy.api#jsonName": "error" + } + }, + "JobId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID for the job.

", + "smithy.api#jsonName": "jobId" + } + }, + "Operation": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the operation.

", + "smithy.api#jsonName": "operation" + } + }, + "Status": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The current status of the request.

", + "smithy.api#jsonName": "status" + } + } + } + }, + "com.amazonaws.amplifybackend#CreateBackendAuthUserPoolConfig": { + "type": "structure", + "members": { + "ForgotPassword": { + "target": "com.amazonaws.amplifybackend#CreateBackendAuthForgotPasswordConfig", + "traits": { + "smithy.api#documentation": "

(DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

", + "smithy.api#jsonName": "forgotPassword" + } + }, + "Mfa": { + "target": "com.amazonaws.amplifybackend#CreateBackendAuthMFAConfig", + "traits": { + "smithy.api#documentation": "

Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.

", + "smithy.api#jsonName": "mfa" + } + }, + "OAuth": { + "target": "com.amazonaws.amplifybackend#CreateBackendAuthOAuthConfig", + "traits": { + "smithy.api#documentation": "

Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.

", + "smithy.api#jsonName": "oAuth" + } + }, + "PasswordPolicy": { + "target": "com.amazonaws.amplifybackend#CreateBackendAuthPasswordPolicyConfig", + "traits": { + "smithy.api#documentation": "

Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

", + "smithy.api#jsonName": "passwordPolicy" + } + }, + "RequiredSignUpAttributes": { + "target": "com.amazonaws.amplifybackend#ListOfRequiredSignUpAttributesElement", + "traits": { + "smithy.api#documentation": "

The required attributes to sign up new users in the user pool.

", + "smithy.api#jsonName": "requiredSignUpAttributes", + "smithy.api#required": {} + } + }, + "SignInMethod": { + "target": "com.amazonaws.amplifybackend#SignInMethod", + "traits": { + "smithy.api#documentation": "

Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project.

", + "smithy.api#jsonName": "signInMethod", + "smithy.api#required": {} + } + }, + "UserPoolName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Cognito user pool name.

", + "smithy.api#jsonName": "userPoolName", + "smithy.api#required": {} + } + }, + "VerificationMessage": { + "target": "com.amazonaws.amplifybackend#CreateBackendAuthVerificationMessageConfig", + "traits": { + "smithy.api#documentation": "

Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.

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

Describes the Amazon Cognito user pool configuration for the auth resource to be configured for your Amplify project.

" + } + }, + "com.amazonaws.amplifybackend#CreateBackendAuthVerificationMessageConfig": { + "type": "structure", + "members": { + "DeliveryMethod": { + "target": "com.amazonaws.amplifybackend#DeliveryMethod", + "traits": { + "smithy.api#documentation": "

The type of verification message to send.

", + "smithy.api#jsonName": "deliveryMethod", + "smithy.api#required": {} + } + }, + "EmailSettings": { + "target": "com.amazonaws.amplifybackend#EmailSettings", + "traits": { + "smithy.api#documentation": "

The settings for the email message.

", + "smithy.api#jsonName": "emailSettings" + } + }, + "SmsSettings": { + "target": "com.amazonaws.amplifybackend#SmsSettings", + "traits": { + "smithy.api#documentation": "

The settings for the SMS message.

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

Creates an email or SMS verification message for the auth resource configured for your Amplify project.

" + } + }, + "com.amazonaws.amplifybackend#CreateBackendConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#CreateBackendConfigRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#CreateBackendConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a config object for a backend.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/config", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#CreateBackendConfigRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendManagerAppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID for the backend manager.

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

The request body for CreateBackendConfig.

" + } + }, + "com.amazonaws.amplifybackend#CreateBackendConfigResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName" + } + }, + "JobId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID for the job.

", + "smithy.api#jsonName": "jobId" + } + }, + "Status": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The current status of the request.

", + "smithy.api#jsonName": "status" + } + } + } + }, + "com.amazonaws.amplifybackend#CreateBackendRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId", + "smithy.api#required": {} + } + }, + "AppName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the app.

", + "smithy.api#jsonName": "appName", + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName", + "smithy.api#required": {} + } + }, + "ResourceConfig": { + "target": "com.amazonaws.amplifybackend#ResourceConfig", + "traits": { + "smithy.api#documentation": "

The resource configuration for creating a backend.

", + "smithy.api#jsonName": "resourceConfig" + } + }, + "ResourceName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the resource.

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

The request body for CreateBackend.

" + } + }, + "com.amazonaws.amplifybackend#CreateBackendResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName" + } + }, + "Error": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

If the request fails, this error is returned.

", + "smithy.api#jsonName": "error" + } + }, + "JobId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID for the job.

", + "smithy.api#jsonName": "jobId" + } + }, + "Operation": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the operation.

", + "smithy.api#jsonName": "operation" + } + }, + "Status": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The current status of the request.

", + "smithy.api#jsonName": "status" + } + } + } + }, + "com.amazonaws.amplifybackend#CreateBackendStorage": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#CreateBackendStorageRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#CreateBackendStorageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a backend storage resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/storage", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#CreateBackendStorageRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName", + "smithy.api#required": {} + } + }, + "ResourceConfig": { + "target": "com.amazonaws.amplifybackend#CreateBackendStorageResourceConfig", + "traits": { + "smithy.api#documentation": "

The resource configuration for creating backend storage.

", + "smithy.api#jsonName": "resourceConfig", + "smithy.api#required": {} + } + }, + "ResourceName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the storage resource.

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

The request body for CreateBackendStorage.

" + } + }, + "com.amazonaws.amplifybackend#CreateBackendStorageResourceConfig": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket.

", + "smithy.api#jsonName": "bucketName" + } + }, + "Permissions": { + "target": "com.amazonaws.amplifybackend#BackendStoragePermissions", + "traits": { + "smithy.api#documentation": "

The authorization configuration for the storage S3 bucket.

", + "smithy.api#jsonName": "permissions", + "smithy.api#required": {} + } + }, + "ServiceName": { + "target": "com.amazonaws.amplifybackend#ServiceName", + "traits": { + "smithy.api#documentation": "

The name of the storage service.

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

The resource configuration for creating backend storage.

" + } + }, + "com.amazonaws.amplifybackend#CreateBackendStorageResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName" + } + }, + "JobId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID for the job.

", + "smithy.api#jsonName": "jobId" + } + }, + "Status": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The current status of the request.

", + "smithy.api#jsonName": "status" + } + } + } + }, + "com.amazonaws.amplifybackend#CreateToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#CreateTokenRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#CreateTokenResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/challenge", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#CreateTokenRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.amplifybackend#CreateTokenResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "ChallengeCode": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

One-time challenge code for authenticating into the Amplify Admin UI.

", + "smithy.api#jsonName": "challengeCode" + } + }, + "SessionId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

A unique ID provided when creating a new challenge token.

", + "smithy.api#jsonName": "sessionId" + } + }, + "Ttl": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The expiry time for the one-time generated token code.

", + "smithy.api#jsonName": "ttl" + } + } + } + }, + "com.amazonaws.amplifybackend#DeleteBackend": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#DeleteBackendRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#DeleteBackendResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes an existing environment from your Amplify project.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/environments/{BackendEnvironmentName}/remove", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#DeleteBackendAPI": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#DeleteBackendAPIRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#DeleteBackendAPIResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an existing backend API resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/api/{BackendEnvironmentName}/remove", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#DeleteBackendAPIRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceConfig": { + "target": "com.amazonaws.amplifybackend#BackendAPIResourceConfig", + "traits": { + "smithy.api#documentation": "

Defines the resource configuration for the data model in your Amplify project.

", + "smithy.api#jsonName": "resourceConfig" + } + }, + "ResourceName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of this resource.

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

The request body for DeleteBackendAPI.

" + } + }, + "com.amazonaws.amplifybackend#DeleteBackendAPIResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName" + } + }, + "Error": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

If the request fails, this error is returned.

", + "smithy.api#jsonName": "error" + } + }, + "JobId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID for the job.

", + "smithy.api#jsonName": "jobId" + } + }, + "Operation": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the operation.

", + "smithy.api#jsonName": "operation" + } + }, + "Status": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The current status of the request.

", + "smithy.api#jsonName": "status" + } + } + } + }, + "com.amazonaws.amplifybackend#DeleteBackendAuth": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#DeleteBackendAuthRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#DeleteBackendAuthResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an existing backend authentication resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/auth/{BackendEnvironmentName}/remove", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#DeleteBackendAuthRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of this resource.

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

The request body for DeleteBackendAuth.

" + } + }, + "com.amazonaws.amplifybackend#DeleteBackendAuthResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName" + } + }, + "Error": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

If the request fails, this error is returned.

", + "smithy.api#jsonName": "error" + } + }, + "JobId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID for the job.

", + "smithy.api#jsonName": "jobId" + } + }, + "Operation": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the operation.

", + "smithy.api#jsonName": "operation" + } + }, + "Status": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The current status of the request.

", + "smithy.api#jsonName": "status" + } + } + } + }, + "com.amazonaws.amplifybackend#DeleteBackendRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.amplifybackend#DeleteBackendResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName" + } + }, + "Error": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

If the request fails, this error is returned.

", + "smithy.api#jsonName": "error" + } + }, + "JobId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID for the job.

", + "smithy.api#jsonName": "jobId" + } + }, + "Operation": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the operation.

", + "smithy.api#jsonName": "operation" + } + }, + "Status": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The current status of the request.

", + "smithy.api#jsonName": "status" + } + } + } + }, + "com.amazonaws.amplifybackend#DeleteBackendStorage": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#DeleteBackendStorageRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#DeleteBackendStorageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified backend storage resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/storage/{BackendEnvironmentName}/remove", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#DeleteBackendStorageRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the storage resource.

", + "smithy.api#jsonName": "resourceName", + "smithy.api#required": {} + } + }, + "ServiceName": { + "target": "com.amazonaws.amplifybackend#ServiceName", + "traits": { + "smithy.api#documentation": "

The name of the storage service.

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

The request body for DeleteBackendStorage.

" + } + }, + "com.amazonaws.amplifybackend#DeleteBackendStorageResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName" + } + }, + "JobId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID for the job.

", + "smithy.api#jsonName": "jobId" + } + }, + "Status": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The current status of the request.

", + "smithy.api#jsonName": "status" + } + } + } + }, + "com.amazonaws.amplifybackend#DeleteToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#DeleteTokenRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#DeleteTokenResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the challenge token based on the given appId and sessionId.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/challenge/{SessionId}/remove", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#DeleteTokenRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SessionId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The session ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.amplifybackend#DeleteTokenResponse": { + "type": "structure", + "members": { + "IsSuccess": { + "target": "com.amazonaws.amplifybackend#__boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the request succeeded or failed.

", + "smithy.api#jsonName": "isSuccess" + } + } + } + }, + "com.amazonaws.amplifybackend#DeliveryMethod": { + "type": "enum", + "members": { + "EMAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL" + } + }, + "SMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMS" + } + } + }, + "traits": { + "smithy.api#documentation": "

The type of verification message to send.

" + } + }, + "com.amazonaws.amplifybackend#EmailSettings": { + "type": "structure", + "members": { + "EmailMessage": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The contents of the email message.

", + "smithy.api#jsonName": "emailMessage" + } + }, + "EmailSubject": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The contents of the subject line of the email message.

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

The configuration for the email sent when an app user forgets their password.

" + } + }, + "com.amazonaws.amplifybackend#GatewayTimeoutException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

An error message to inform that the request failed.

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

An error returned if there's a temporary issue with the service.

", + "smithy.api#error": "server", + "smithy.api#httpError": 504 + } + }, + "com.amazonaws.amplifybackend#GenerateBackendAPIModels": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#GenerateBackendAPIModelsRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#GenerateBackendAPIModelsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Generates a model schema for an existing backend API resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/api/{BackendEnvironmentName}/generateModels", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#GenerateBackendAPIModelsRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of this resource.

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

The request body for GenerateBackendAPIModels.

" + } + }, + "com.amazonaws.amplifybackend#GenerateBackendAPIModelsResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName" + } + }, + "Error": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

If the request fails, this error is returned.

", + "smithy.api#jsonName": "error" + } + }, + "JobId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID for the job.

", + "smithy.api#jsonName": "jobId" + } + }, + "Operation": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the operation.

", + "smithy.api#jsonName": "operation" + } + }, + "Status": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The current status of the request.

", + "smithy.api#jsonName": "status" + } + } + } + }, + "com.amazonaws.amplifybackend#GetBackend": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#GetBackendRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#GetBackendResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides project-level details for your Amplify UI project.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/details", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#GetBackendAPI": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#GetBackendAPIRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#GetBackendAPIResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the details for a backend API.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/api/{BackendEnvironmentName}/details", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#GetBackendAPIModels": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#GetBackendAPIModelsRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#GetBackendAPIModelsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a model introspection schema for an existing backend API resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/api/{BackendEnvironmentName}/getModels", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#GetBackendAPIModelsRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of this resource.

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

The request body for GetBackendAPIModels.

" + } + }, + "com.amazonaws.amplifybackend#GetBackendAPIModelsResponse": { + "type": "structure", + "members": { + "Models": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

Stringified JSON of the datastore model.

", + "smithy.api#jsonName": "models" + } + }, + "Status": { + "target": "com.amazonaws.amplifybackend#Status", + "traits": { + "smithy.api#documentation": "

The current status of the request.

", + "smithy.api#jsonName": "status" + } + }, + "ModelIntrospectionSchema": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

Stringified JSON of the model introspection schema for an existing backend API resource.

", + "smithy.api#jsonName": "modelIntrospectionSchema" + } + } + } + }, + "com.amazonaws.amplifybackend#GetBackendAPIRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceConfig": { + "target": "com.amazonaws.amplifybackend#BackendAPIResourceConfig", + "traits": { + "smithy.api#documentation": "

Defines the resource configuration for the data model in your Amplify project.

", + "smithy.api#jsonName": "resourceConfig" + } + }, + "ResourceName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of this resource.

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

The request body for GetBackendAPI.

" + } + }, + "com.amazonaws.amplifybackend#GetBackendAPIResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName" + } + }, + "Error": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

If the request fails, this error is returned.

", + "smithy.api#jsonName": "error" + } + }, + "ResourceConfig": { + "target": "com.amazonaws.amplifybackend#BackendAPIResourceConfig", + "traits": { + "smithy.api#documentation": "

The resource configuration for this response object.

", + "smithy.api#jsonName": "resourceConfig" + } + }, + "ResourceName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of this resource.

", + "smithy.api#jsonName": "resourceName" + } + } + } + }, + "com.amazonaws.amplifybackend#GetBackendAuth": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#GetBackendAuthRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#GetBackendAuthResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a backend auth details.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/auth/{BackendEnvironmentName}/details", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#GetBackendAuthRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of this resource.

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

The request body for GetBackendAuth.

" + } + }, + "com.amazonaws.amplifybackend#GetBackendAuthResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName" + } + }, + "Error": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

If the request fails, this error is returned.

", + "smithy.api#jsonName": "error" + } + }, + "ResourceConfig": { + "target": "com.amazonaws.amplifybackend#CreateBackendAuthResourceConfig", + "traits": { + "smithy.api#documentation": "

The resource configuration for authorization requests to the backend of your Amplify project.

", + "smithy.api#jsonName": "resourceConfig" + } + }, + "ResourceName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of this resource.

", + "smithy.api#jsonName": "resourceName" + } + } + } + }, + "com.amazonaws.amplifybackend#GetBackendJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#GetBackendJobRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#GetBackendJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specific job.

", + "smithy.api#http": { + "method": "GET", + "uri": "/backend/{AppId}/job/{BackendEnvironmentName}/{JobId}", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#GetBackendJobRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "JobId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID for the job.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.amplifybackend#GetBackendJobResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName" + } + }, + "CreateTime": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The time when the job was created.

", + "smithy.api#jsonName": "createTime" + } + }, + "Error": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

If the request fails, this error is returned.

", + "smithy.api#jsonName": "error" + } + }, + "JobId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID for the job.

", + "smithy.api#jsonName": "jobId" + } + }, + "Operation": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the operation.

", + "smithy.api#jsonName": "operation" + } + }, + "Status": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The current status of the request.

", + "smithy.api#jsonName": "status" + } + }, + "UpdateTime": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The time when the job was last updated.

", + "smithy.api#jsonName": "updateTime" + } + } + } + }, + "com.amazonaws.amplifybackend#GetBackendRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

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

The request body for GetBackend.

" + } + }, + "com.amazonaws.amplifybackend#GetBackendResponse": { + "type": "structure", + "members": { + "AmplifyFeatureFlags": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

A stringified version of the cli.json file for your Amplify project.

", + "smithy.api#jsonName": "amplifyFeatureFlags" + } + }, + "AmplifyMetaConfig": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

A stringified version of the current configs for your Amplify project.

", + "smithy.api#jsonName": "amplifyMetaConfig" + } + }, + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "AppName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the app.

", + "smithy.api#jsonName": "appName" + } + }, + "BackendEnvironmentList": { + "target": "com.amazonaws.amplifybackend#ListOf__string", + "traits": { + "smithy.api#documentation": "

A list of backend environments in an array.

", + "smithy.api#jsonName": "backendEnvironmentList" + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName" + } + }, + "Error": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

If the request failed, this is the returned error.

", + "smithy.api#jsonName": "error" + } + } + } + }, + "com.amazonaws.amplifybackend#GetBackendStorage": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#GetBackendStorageRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#GetBackendStorageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets details for a backend storage resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/storage/{BackendEnvironmentName}/details", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#GetBackendStorageRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the storage resource.

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

The request body for GetBackendStorage.

" + } + }, + "com.amazonaws.amplifybackend#GetBackendStorageResourceConfig": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket.

", + "smithy.api#jsonName": "bucketName" + } + }, + "Imported": { + "target": "com.amazonaws.amplifybackend#__boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Returns True if the storage resource has been imported.

", + "smithy.api#jsonName": "imported", + "smithy.api#required": {} + } + }, + "Permissions": { + "target": "com.amazonaws.amplifybackend#BackendStoragePermissions", + "traits": { + "smithy.api#documentation": "

The authorization configuration for the storage S3 bucket.

", + "smithy.api#jsonName": "permissions" + } + }, + "ServiceName": { + "target": "com.amazonaws.amplifybackend#ServiceName", + "traits": { + "smithy.api#documentation": "

The name of the storage service.

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

The details for a backend storage resource.

" + } + }, + "com.amazonaws.amplifybackend#GetBackendStorageResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName" + } + }, + "ResourceConfig": { + "target": "com.amazonaws.amplifybackend#GetBackendStorageResourceConfig", + "traits": { + "smithy.api#documentation": "

The resource configuration for the backend storage resource.

", + "smithy.api#jsonName": "resourceConfig" + } + }, + "ResourceName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the storage resource.

", + "smithy.api#jsonName": "resourceName" + } + } + } + }, + "com.amazonaws.amplifybackend#GetToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#GetTokenRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#GetTokenResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the challenge token based on the given appId and sessionId.

", + "smithy.api#http": { + "method": "GET", + "uri": "/backend/{AppId}/challenge/{SessionId}", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#GetTokenRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SessionId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The session ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.amplifybackend#GetTokenResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "ChallengeCode": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The one-time challenge code for authenticating into the Amplify Admin UI.

", + "smithy.api#jsonName": "challengeCode" + } + }, + "SessionId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

A unique ID provided when creating a new challenge token.

", + "smithy.api#jsonName": "sessionId" + } + }, + "Ttl": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The expiry time for the one-time generated token code.

", + "smithy.api#jsonName": "ttl" + } + } + } + }, + "com.amazonaws.amplifybackend#ImportBackendAuth": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#ImportBackendAuthRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#ImportBackendAuthResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Imports an existing backend authentication resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/auth/{BackendEnvironmentName}/import", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#ImportBackendAuthRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IdentityPoolId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Cognito identity pool.

", + "smithy.api#jsonName": "identityPoolId" + } + }, + "NativeClientId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Cognito native client.

", + "smithy.api#jsonName": "nativeClientId", + "smithy.api#required": {} + } + }, + "UserPoolId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Cognito user pool.

", + "smithy.api#jsonName": "userPoolId", + "smithy.api#required": {} + } + }, + "WebClientId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Cognito web client.

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

The request body for ImportBackendAuth.

" + } + }, + "com.amazonaws.amplifybackend#ImportBackendAuthResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName" + } + }, + "Error": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

If the request fails, this error is returned.

", + "smithy.api#jsonName": "error" + } + }, + "JobId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID for the job.

", + "smithy.api#jsonName": "jobId" + } + }, + "Operation": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the operation.

", + "smithy.api#jsonName": "operation" + } + }, + "Status": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The current status of the request.

", + "smithy.api#jsonName": "status" + } + } + } + }, + "com.amazonaws.amplifybackend#ImportBackendStorage": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#ImportBackendStorageRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#ImportBackendStorageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Imports an existing backend storage resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/storage/{BackendEnvironmentName}/import", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#ImportBackendStorageRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BucketName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket.

", + "smithy.api#jsonName": "bucketName" + } + }, + "ServiceName": { + "target": "com.amazonaws.amplifybackend#ServiceName", + "traits": { + "smithy.api#documentation": "

The name of the storage service.

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

The request body for ImportBackendStorage.

" + } + }, + "com.amazonaws.amplifybackend#ImportBackendStorageResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName" + } + }, + "JobId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID for the job.

", + "smithy.api#jsonName": "jobId" + } + }, + "Status": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The current status of the request.

", + "smithy.api#jsonName": "status" + } + } + } + }, + "com.amazonaws.amplifybackend#ListBackendJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#ListBackendJobsRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#ListBackendJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the jobs for the backend of an Amplify app.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/job/{BackendEnvironmentName}", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#ListBackendJobsRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "JobId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID for the job.

", + "smithy.api#jsonName": "jobId" + } + }, + "MaxResults": { + "target": "com.amazonaws.amplifybackend#__integerMin1Max25", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results that you want in the response.

", + "smithy.api#jsonName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The token for the next set of results.

", + "smithy.api#jsonName": "nextToken" + } + }, + "Operation": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

Filters the list of response objects to include only those with the specified operation name.

", + "smithy.api#jsonName": "operation" + } + }, + "Status": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

Filters the list of response objects to include only those with the specified status.

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

The request body for ListBackendJobs.

" + } + }, + "com.amazonaws.amplifybackend#ListBackendJobsResponse": { + "type": "structure", + "members": { + "Jobs": { + "target": "com.amazonaws.amplifybackend#ListOfBackendJobRespObj", + "traits": { + "smithy.api#documentation": "

An array of jobs and their properties.

", + "smithy.api#jsonName": "jobs" + } + }, + "NextToken": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The token for the next set of results.

", + "smithy.api#jsonName": "nextToken" + } + } + } + }, + "com.amazonaws.amplifybackend#ListOfAdditionalConstraintsElement": { + "type": "list", + "member": { + "target": "com.amazonaws.amplifybackend#AdditionalConstraintsElement" + } + }, + "com.amazonaws.amplifybackend#ListOfAuthenticatedElement": { + "type": "list", + "member": { + "target": "com.amazonaws.amplifybackend#AuthenticatedElement" + } + }, + "com.amazonaws.amplifybackend#ListOfBackendAPIAuthType": { + "type": "list", + "member": { + "target": "com.amazonaws.amplifybackend#BackendAPIAuthType" + } + }, + "com.amazonaws.amplifybackend#ListOfBackendJobRespObj": { + "type": "list", + "member": { + "target": "com.amazonaws.amplifybackend#BackendJobRespObj" + } + }, + "com.amazonaws.amplifybackend#ListOfMfaTypesElement": { + "type": "list", + "member": { + "target": "com.amazonaws.amplifybackend#MfaTypesElement" + } + }, + "com.amazonaws.amplifybackend#ListOfOAuthScopesElement": { + "type": "list", + "member": { + "target": "com.amazonaws.amplifybackend#OAuthScopesElement" + } + }, + "com.amazonaws.amplifybackend#ListOfRequiredSignUpAttributesElement": { + "type": "list", + "member": { + "target": "com.amazonaws.amplifybackend#RequiredSignUpAttributesElement" + } + }, + "com.amazonaws.amplifybackend#ListOfS3BucketInfo": { + "type": "list", + "member": { + "target": "com.amazonaws.amplifybackend#S3BucketInfo" + } + }, + "com.amazonaws.amplifybackend#ListOfUnAuthenticatedElement": { + "type": "list", + "member": { + "target": "com.amazonaws.amplifybackend#UnAuthenticatedElement" + } + }, + "com.amazonaws.amplifybackend#ListOf__string": { + "type": "list", + "member": { + "target": "com.amazonaws.amplifybackend#__string" + } + }, + "com.amazonaws.amplifybackend#ListS3Buckets": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#ListS3BucketsRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#ListS3BucketsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

The list of S3 buckets in your account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/s3Buckets", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#ListS3BucketsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

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

The request body for S3Buckets.

" + } + }, + "com.amazonaws.amplifybackend#ListS3BucketsResponse": { + "type": "structure", + "members": { + "Buckets": { + "target": "com.amazonaws.amplifybackend#ListOfS3BucketInfo", + "traits": { + "smithy.api#documentation": "

The list of S3 buckets.

", + "smithy.api#jsonName": "buckets" + } + }, + "NextToken": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

", + "smithy.api#jsonName": "nextToken" + } + } + } + }, + "com.amazonaws.amplifybackend#LoginAuthConfigReqObj": { + "type": "structure", + "members": { + "AwsCognitoIdentityPoolId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Cognito identity pool ID used for the Amplify Admin UI login authorization.

", + "smithy.api#jsonName": "aws_cognito_identity_pool_id" + } + }, + "AwsCognitoRegion": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The AWS Region for the Amplify Admin UI login.

", + "smithy.api#jsonName": "aws_cognito_region" + } + }, + "AwsUserPoolsId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Cognito user pool ID used for Amplify Admin UI login authentication.

", + "smithy.api#jsonName": "aws_user_pools_id" + } + }, + "AwsUserPoolsWebClientId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The web client ID for the Amazon Cognito user pools.

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

The request object for this operation.

" + } + }, + "com.amazonaws.amplifybackend#MFAMode": { + "type": "enum", + "members": { + "ON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ON" + } + }, + "OFF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OFF" + } + }, + "OPTIONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPTIONAL" + } + } + } + }, + "com.amazonaws.amplifybackend#MfaTypesElement": { + "type": "enum", + "members": { + "SMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMS" + } + }, + "TOTP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOTP" + } + } + } + }, + "com.amazonaws.amplifybackend#Mode": { + "type": "enum", + "members": { + "API_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "API_KEY" + } + }, + "AWS_IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_IAM" + } + }, + "AMAZON_COGNITO_USER_POOLS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON_COGNITO_USER_POOLS" + } + }, + "OPENID_CONNECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPENID_CONNECT" + } + } + } + }, + "com.amazonaws.amplifybackend#NotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

An error message to inform that the request has failed.

", + "smithy.api#jsonName": "message" + } + }, + "ResourceType": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The type of resource that is not found.

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

An error returned when a specific resource type is not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.amplifybackend#OAuthGrantType": { + "type": "enum", + "members": { + "CODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CODE" + } + }, + "IMPLICIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPLICIT" + } + } + } + }, + "com.amazonaws.amplifybackend#OAuthScopesElement": { + "type": "enum", + "members": { + "PHONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PHONE" + } + }, + "EMAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL" + } + }, + "OPENID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPENID" + } + }, + "PROFILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROFILE" + } + }, + "AWS_COGNITO_SIGNIN_USER_ADMIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_COGNITO_SIGNIN_USER_ADMIN" + } + } + } + }, + "com.amazonaws.amplifybackend#RemoveAllBackends": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#RemoveAllBackendsRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#RemoveAllBackendsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes all backend environments from your Amplify project.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/remove", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#RemoveAllBackendsRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "CleanAmplifyApp": { + "target": "com.amazonaws.amplifybackend#__boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Cleans up the Amplify Console app if this value is set to true.

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

The request body for RemoveAllBackends.

" + } + }, + "com.amazonaws.amplifybackend#RemoveAllBackendsResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "Error": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

If the request fails, this error is returned.

", + "smithy.api#jsonName": "error" + } + }, + "JobId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID for the job.

", + "smithy.api#jsonName": "jobId" + } + }, + "Operation": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the operation.

", + "smithy.api#jsonName": "operation" + } + }, + "Status": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The current status of the request.

", + "smithy.api#jsonName": "status" + } + } + } + }, + "com.amazonaws.amplifybackend#RemoveBackendConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#RemoveBackendConfigRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#RemoveBackendConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the AWS resources required to access the Amplify Admin UI.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/config/remove", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#RemoveBackendConfigRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.amplifybackend#RemoveBackendConfigResponse": { + "type": "structure", + "members": { + "Error": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

If the request fails, this error is returned.

", + "smithy.api#jsonName": "error" + } + } + } + }, + "com.amazonaws.amplifybackend#RequiredSignUpAttributesElement": { + "type": "enum", + "members": { + "ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADDRESS" + } + }, + "BIRTHDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIRTHDATE" + } + }, + "EMAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL" + } + }, + "FAMILY_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAMILY_NAME" + } + }, + "GENDER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GENDER" + } + }, + "GIVEN_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GIVEN_NAME" + } + }, + "LOCALE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOCALE" + } + }, + "MIDDLE_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIDDLE_NAME" + } + }, + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + }, + "NICKNAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NICKNAME" + } + }, + "PHONE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PHONE_NUMBER" + } + }, + "PICTURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PICTURE" + } + }, + "PREFERRED_USERNAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREFERRED_USERNAME" + } + }, + "PROFILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROFILE" + } + }, + "UPDATED_AT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATED_AT" + } + }, + "WEBSITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEBSITE" + } + }, + "ZONE_INFO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZONE_INFO" + } + } + } + }, + "com.amazonaws.amplifybackend#ResolutionStrategy": { + "type": "enum", + "members": { + "OPTIMISTIC_CONCURRENCY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPTIMISTIC_CONCURRENCY" + } + }, + "LAMBDA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAMBDA" + } + }, + "AUTOMERGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTOMERGE" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.amplifybackend#ResourceConfig": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Defines the resource configuration for the data model in your Amplify project.

" + } + }, + "com.amazonaws.amplifybackend#S3BucketInfo": { + "type": "structure", + "members": { + "CreationDate": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The creation date of the S3 bucket.

", + "smithy.api#jsonName": "creationDate" + } + }, + "Name": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket.

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

Describes the metadata of the S3 bucket.

" + } + }, + "com.amazonaws.amplifybackend#Service": { + "type": "enum", + "members": { + "COGNITO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COGNITO" + } + } + } + }, + "com.amazonaws.amplifybackend#ServiceName": { + "type": "enum", + "members": { + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + } + } + }, + "com.amazonaws.amplifybackend#Settings": { + "type": "structure", + "members": { + "MfaTypes": { + "target": "com.amazonaws.amplifybackend#ListOfMfaTypesElement", + "traits": { + "smithy.api#documentation": "

The supported MFA types.

", + "smithy.api#jsonName": "mfaTypes" + } + }, + "SmsMessage": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The body of the SMS message.

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

The settings of your MFA configuration for the backend of your Amplify project.

" + } + }, + "com.amazonaws.amplifybackend#SignInMethod": { + "type": "enum", + "members": { + "EMAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL" + } + }, + "EMAIL_AND_PHONE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL_AND_PHONE_NUMBER" + } + }, + "PHONE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PHONE_NUMBER" + } + }, + "USERNAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USERNAME" + } + } + } + }, + "com.amazonaws.amplifybackend#SmsSettings": { + "type": "structure", + "members": { + "SmsMessage": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The contents of the SMS message.

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

SMS settings for authentication.

" + } + }, + "com.amazonaws.amplifybackend#SocialProviderSettings": { + "type": "structure", + "members": { + "Facebook": { + "target": "com.amazonaws.amplifybackend#BackendAuthSocialProviderConfig" + }, + "Google": { + "target": "com.amazonaws.amplifybackend#BackendAuthSocialProviderConfig" + }, + "LoginWithAmazon": { + "target": "com.amazonaws.amplifybackend#BackendAuthSocialProviderConfig" + }, + "SignInWithApple": { + "target": "com.amazonaws.amplifybackend#BackendAuthAppleProviderConfig" + } + }, + "traits": { + "smithy.api#documentation": "

The settings for using the social identity providers for access to your Amplify app.

" + } + }, + "com.amazonaws.amplifybackend#Status": { + "type": "enum", + "members": { + "LATEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LATEST" + } + }, + "STALE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STALE" + } + } + } + }, + "com.amazonaws.amplifybackend#TooManyRequestsException": { + "type": "structure", + "members": { + "LimitType": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The type of limit that was exceeded.

", + "smithy.api#jsonName": "limitType" + } + }, + "Message": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

An error message to inform that the request has failed.

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

An error that is returned when a limit of a specific type has been exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.amplifybackend#UnAuthenticatedElement": { + "type": "enum", + "members": { + "READ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ" + } + }, + "CREATE_AND_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_AND_UPDATE" + } + }, + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + } + } + }, + "com.amazonaws.amplifybackend#UpdateBackendAPI": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#UpdateBackendAPIRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#UpdateBackendAPIResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing backend API resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/api/{BackendEnvironmentName}", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#UpdateBackendAPIRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceConfig": { + "target": "com.amazonaws.amplifybackend#BackendAPIResourceConfig", + "traits": { + "smithy.api#documentation": "

Defines the resource configuration for the data model in your Amplify project.

", + "smithy.api#jsonName": "resourceConfig" + } + }, + "ResourceName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of this resource.

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

The request body for UpdateBackendAPI.

" + } + }, + "com.amazonaws.amplifybackend#UpdateBackendAPIResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName" + } + }, + "Error": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

If the request fails, this error is returned.

", + "smithy.api#jsonName": "error" + } + }, + "JobId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID for the job.

", + "smithy.api#jsonName": "jobId" + } + }, + "Operation": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the operation.

", + "smithy.api#jsonName": "operation" + } + }, + "Status": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The current status of the request.

", + "smithy.api#jsonName": "status" + } + } + } + }, + "com.amazonaws.amplifybackend#UpdateBackendAuth": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#UpdateBackendAuthRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#UpdateBackendAuthResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing backend authentication resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/auth/{BackendEnvironmentName}", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#UpdateBackendAuthForgotPasswordConfig": { + "type": "structure", + "members": { + "DeliveryMethod": { + "target": "com.amazonaws.amplifybackend#DeliveryMethod", + "traits": { + "smithy.api#documentation": "

(DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.

", + "smithy.api#jsonName": "deliveryMethod" + } + }, + "EmailSettings": { + "target": "com.amazonaws.amplifybackend#EmailSettings", + "traits": { + "smithy.api#documentation": "

(DEPRECATED) The configuration for the email sent when an app user forgets their password.

", + "smithy.api#jsonName": "emailSettings" + } + }, + "SmsSettings": { + "target": "com.amazonaws.amplifybackend#SmsSettings", + "traits": { + "smithy.api#documentation": "

(DEPRECATED) The configuration for the SMS message sent when an Amplify app user forgets their password.

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

(DEPRECATED) Describes the forgot password policy for authenticating into the Amplify app.

" + } + }, + "com.amazonaws.amplifybackend#UpdateBackendAuthIdentityPoolConfig": { + "type": "structure", + "members": { + "UnauthenticatedLogin": { + "target": "com.amazonaws.amplifybackend#__boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A boolean value that can be set to allow or disallow guest-level authorization into your Amplify app.

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

Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.

" + } + }, + "com.amazonaws.amplifybackend#UpdateBackendAuthMFAConfig": { + "type": "structure", + "members": { + "MFAMode": { + "target": "com.amazonaws.amplifybackend#MFAMode", + "traits": { + "smithy.api#documentation": "

The MFA mode for the backend of your Amplify project.

" + } + }, + "Settings": { + "target": "com.amazonaws.amplifybackend#Settings", + "traits": { + "smithy.api#documentation": "

The settings of your MFA configuration for the backend of your Amplify project.

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

Updates the multi-factor authentication (MFA) configuration for the backend of your Amplify project.

" + } + }, + "com.amazonaws.amplifybackend#UpdateBackendAuthOAuthConfig": { + "type": "structure", + "members": { + "DomainPrefix": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Cognito domain prefix used to create a hosted UI for authentication.

", + "smithy.api#jsonName": "domainPrefix" + } + }, + "OAuthGrantType": { + "target": "com.amazonaws.amplifybackend#OAuthGrantType", + "traits": { + "smithy.api#documentation": "

The OAuth grant type to allow app users to authenticate from your Amplify app.

", + "smithy.api#jsonName": "oAuthGrantType" + } + }, + "OAuthScopes": { + "target": "com.amazonaws.amplifybackend#ListOfOAuthScopesElement", + "traits": { + "smithy.api#documentation": "

The list of OAuth-related flows that can allow users to authenticate from your Amplify app.

", + "smithy.api#jsonName": "oAuthScopes" + } + }, + "RedirectSignInURIs": { + "target": "com.amazonaws.amplifybackend#ListOf__string", + "traits": { + "smithy.api#documentation": "

Redirect URLs that OAuth uses when a user signs in to an Amplify app.

", + "smithy.api#jsonName": "redirectSignInURIs" + } + }, + "RedirectSignOutURIs": { + "target": "com.amazonaws.amplifybackend#ListOf__string", + "traits": { + "smithy.api#documentation": "

Redirect URLs that OAuth uses when a user signs out of an Amplify app.

", + "smithy.api#jsonName": "redirectSignOutURIs" + } + }, + "SocialProviderSettings": { + "target": "com.amazonaws.amplifybackend#SocialProviderSettings", + "traits": { + "smithy.api#documentation": "

Describes third-party social federation configurations for allowing your users to sign in with OAuth.

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

The OAuth configurations for authenticating users into your Amplify app.

" + } }, - "Google": { - "target": "com.amazonaws.amplifybackend#BackendAuthSocialProviderConfig" + "com.amazonaws.amplifybackend#UpdateBackendAuthPasswordPolicyConfig": { + "type": "structure", + "members": { + "AdditionalConstraints": { + "target": "com.amazonaws.amplifybackend#ListOfAdditionalConstraintsElement", + "traits": { + "smithy.api#documentation": "

Describes additional constraints on password requirements to sign in to the auth resource, configured as a part of your Amplify project.

", + "smithy.api#jsonName": "additionalConstraints" + } + }, + "MinimumLength": { + "target": "com.amazonaws.amplifybackend#__double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Describes the minimum length of the password required to sign in to the auth resource, configured as a part of your Amplify project.

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

Describes the password policy for your Amazon Cognito user pool configured as a part of your Amplify project.

" + } }, - "LoginWithAmazon": { - "target": "com.amazonaws.amplifybackend#BackendAuthSocialProviderConfig" + "com.amazonaws.amplifybackend#UpdateBackendAuthRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceConfig": { + "target": "com.amazonaws.amplifybackend#UpdateBackendAuthResourceConfig", + "traits": { + "smithy.api#documentation": "

The resource configuration for this request object.

", + "smithy.api#jsonName": "resourceConfig", + "smithy.api#required": {} + } + }, + "ResourceName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of this resource.

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

The request body for UpdateBackendAuth.

" + } }, - "SignInWithApple": { - "target": "com.amazonaws.amplifybackend#BackendAuthAppleProviderConfig" - } - }, - "traits": { - "smithy.api#documentation": "

The settings for using the social identity providers for access to your Amplify app.

" - } - }, - "com.amazonaws.amplifybackend#Status": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LATEST", - "name": "LATEST" - }, - { - "value": "STALE", - "name": "STALE" - } - ] - } - }, - "com.amazonaws.amplifybackend#TooManyRequestsException": { - "type": "structure", - "members": { - "LimitType": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The type of limit that was exceeded.

", - "smithy.api#jsonName": "limitType" - } - }, - "Message": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

An error message to inform that the request has failed.

", - "smithy.api#jsonName": "message" - } - } - }, - "traits": { - "smithy.api#documentation": "

An error that is returned when a limit of a specific type has been exceeded.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.amplifybackend#UnAuthenticatedElement": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "READ", - "name": "READ" - }, - { - "value": "CREATE_AND_UPDATE", - "name": "CREATE_AND_UPDATE" - }, - { - "value": "DELETE", - "name": "DELETE" - } - ] - } - }, - "com.amazonaws.amplifybackend#UpdateBackendAPI": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#UpdateBackendAPIRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#UpdateBackendAPIResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an existing backend API resource.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/api/{BackendEnvironmentName}", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#UpdateBackendAPIRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ResourceConfig": { - "target": "com.amazonaws.amplifybackend#BackendAPIResourceConfig", - "traits": { - "smithy.api#documentation": "

Defines the resource configuration for the data model in your Amplify project.

", - "smithy.api#jsonName": "resourceConfig" - } - }, - "ResourceName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of this resource.

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

The request body for UpdateBackendAPI.

" - } - }, - "com.amazonaws.amplifybackend#UpdateBackendAPIResponse": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId" - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName" - } - }, - "Error": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

If the request fails, this error is returned.

", - "smithy.api#jsonName": "error" - } - }, - "JobId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID for the job.

", - "smithy.api#jsonName": "jobId" - } - }, - "Operation": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the operation.

", - "smithy.api#jsonName": "operation" - } - }, - "Status": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The current status of the request.

", - "smithy.api#jsonName": "status" - } - } - } - }, - "com.amazonaws.amplifybackend#UpdateBackendAuth": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#UpdateBackendAuthRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#UpdateBackendAuthResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an existing backend authentication resource.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/auth/{BackendEnvironmentName}", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#UpdateBackendAuthForgotPasswordConfig": { - "type": "structure", - "members": { - "DeliveryMethod": { - "target": "com.amazonaws.amplifybackend#DeliveryMethod", - "traits": { - "smithy.api#documentation": "

(DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.

", - "smithy.api#jsonName": "deliveryMethod" - } - }, - "EmailSettings": { - "target": "com.amazonaws.amplifybackend#EmailSettings", - "traits": { - "smithy.api#documentation": "

(DEPRECATED) The configuration for the email sent when an app user forgets their password.

", - "smithy.api#jsonName": "emailSettings" - } - }, - "SmsSettings": { - "target": "com.amazonaws.amplifybackend#SmsSettings", - "traits": { - "smithy.api#documentation": "

(DEPRECATED) The configuration for the SMS message sent when an Amplify app user forgets their password.

", - "smithy.api#jsonName": "smsSettings" - } - } - }, - "traits": { - "smithy.api#documentation": "

(DEPRECATED) Describes the forgot password policy for authenticating into the Amplify app.

" - } - }, - "com.amazonaws.amplifybackend#UpdateBackendAuthIdentityPoolConfig": { - "type": "structure", - "members": { - "UnauthenticatedLogin": { - "target": "com.amazonaws.amplifybackend#__boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A boolean value that can be set to allow or disallow guest-level authorization into your Amplify app.

", - "smithy.api#jsonName": "unauthenticatedLogin" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.

" - } - }, - "com.amazonaws.amplifybackend#UpdateBackendAuthMFAConfig": { - "type": "structure", - "members": { - "MFAMode": { - "target": "com.amazonaws.amplifybackend#MFAMode", - "traits": { - "smithy.api#documentation": "

The MFA mode for the backend of your Amplify project.

" - } - }, - "Settings": { - "target": "com.amazonaws.amplifybackend#Settings", - "traits": { - "smithy.api#documentation": "

The settings of your MFA configuration for the backend of your Amplify project.

", - "smithy.api#jsonName": "settings" - } - } - }, - "traits": { - "smithy.api#documentation": "

Updates the multi-factor authentication (MFA) configuration for the backend of your Amplify project.

" - } - }, - "com.amazonaws.amplifybackend#UpdateBackendAuthOAuthConfig": { - "type": "structure", - "members": { - "DomainPrefix": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The Amazon Cognito domain prefix used to create a hosted UI for authentication.

", - "smithy.api#jsonName": "domainPrefix" - } - }, - "OAuthGrantType": { - "target": "com.amazonaws.amplifybackend#OAuthGrantType", - "traits": { - "smithy.api#documentation": "

The OAuth grant type to allow app users to authenticate from your Amplify app.

", - "smithy.api#jsonName": "oAuthGrantType" - } - }, - "OAuthScopes": { - "target": "com.amazonaws.amplifybackend#ListOfOAuthScopesElement", - "traits": { - "smithy.api#documentation": "

The list of OAuth-related flows that can allow users to authenticate from your Amplify app.

", - "smithy.api#jsonName": "oAuthScopes" - } - }, - "RedirectSignInURIs": { - "target": "com.amazonaws.amplifybackend#ListOf__string", - "traits": { - "smithy.api#documentation": "

Redirect URLs that OAuth uses when a user signs in to an Amplify app.

", - "smithy.api#jsonName": "redirectSignInURIs" - } - }, - "RedirectSignOutURIs": { - "target": "com.amazonaws.amplifybackend#ListOf__string", - "traits": { - "smithy.api#documentation": "

Redirect URLs that OAuth uses when a user signs out of an Amplify app.

", - "smithy.api#jsonName": "redirectSignOutURIs" - } - }, - "SocialProviderSettings": { - "target": "com.amazonaws.amplifybackend#SocialProviderSettings", - "traits": { - "smithy.api#documentation": "

Describes third-party social federation configurations for allowing your users to sign in with OAuth.

", - "smithy.api#jsonName": "socialProviderSettings" - } - } - }, - "traits": { - "smithy.api#documentation": "

The OAuth configurations for authenticating users into your Amplify app.

" - } - }, - "com.amazonaws.amplifybackend#UpdateBackendAuthPasswordPolicyConfig": { - "type": "structure", - "members": { - "AdditionalConstraints": { - "target": "com.amazonaws.amplifybackend#ListOfAdditionalConstraintsElement", - "traits": { - "smithy.api#documentation": "

Describes additional constraints on password requirements to sign in to the auth resource, configured as a part of your Amplify project.

", - "smithy.api#jsonName": "additionalConstraints" - } - }, - "MinimumLength": { - "target": "com.amazonaws.amplifybackend#__double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Describes the minimum length of the password required to sign in to the auth resource, configured as a part of your Amplify project.

", - "smithy.api#jsonName": "minimumLength" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the password policy for your Amazon Cognito user pool configured as a part of your Amplify project.

" - } - }, - "com.amazonaws.amplifybackend#UpdateBackendAuthRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ResourceConfig": { - "target": "com.amazonaws.amplifybackend#UpdateBackendAuthResourceConfig", - "traits": { - "smithy.api#documentation": "

The resource configuration for this request object.

", - "smithy.api#jsonName": "resourceConfig", - "smithy.api#required": {} - } - }, - "ResourceName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of this resource.

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

The request body for UpdateBackendAuth.

" - } - }, - "com.amazonaws.amplifybackend#UpdateBackendAuthResourceConfig": { - "type": "structure", - "members": { - "AuthResources": { - "target": "com.amazonaws.amplifybackend#AuthResources", - "traits": { - "smithy.api#documentation": "

Defines the service name to use when configuring an authentication resource in your Amplify project.

", - "smithy.api#jsonName": "authResources", - "smithy.api#required": {} - } - }, - "IdentityPoolConfigs": { - "target": "com.amazonaws.amplifybackend#UpdateBackendAuthIdentityPoolConfig", - "traits": { - "smithy.api#documentation": "

Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.

", - "smithy.api#jsonName": "identityPoolConfigs" - } - }, - "Service": { - "target": "com.amazonaws.amplifybackend#Service", - "traits": { - "smithy.api#documentation": "

Defines the service name to use when configuring an authentication resource in your Amplify project.

", - "smithy.api#jsonName": "service", - "smithy.api#required": {} - } - }, - "UserPoolConfigs": { - "target": "com.amazonaws.amplifybackend#UpdateBackendAuthUserPoolConfig", - "traits": { - "smithy.api#documentation": "

Describes the authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.

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

Defines the resource configuration when updating an authentication resource in your Amplify project.

" - } - }, - "com.amazonaws.amplifybackend#UpdateBackendAuthResponse": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId" - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName" - } - }, - "Error": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

If the request fails, this error is returned.

", - "smithy.api#jsonName": "error" - } - }, - "JobId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID for the job.

", - "smithy.api#jsonName": "jobId" - } - }, - "Operation": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the operation.

", - "smithy.api#jsonName": "operation" - } - }, - "Status": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The current status of the request.

", - "smithy.api#jsonName": "status" - } - } - } - }, - "com.amazonaws.amplifybackend#UpdateBackendAuthUserPoolConfig": { - "type": "structure", - "members": { - "ForgotPassword": { - "target": "com.amazonaws.amplifybackend#UpdateBackendAuthForgotPasswordConfig", - "traits": { - "smithy.api#documentation": "

(DEPRECATED) Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

", - "smithy.api#jsonName": "forgotPassword" - } - }, - "Mfa": { - "target": "com.amazonaws.amplifybackend#UpdateBackendAuthMFAConfig", - "traits": { - "smithy.api#documentation": "

Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.

", - "smithy.api#jsonName": "mfa" - } - }, - "OAuth": { - "target": "com.amazonaws.amplifybackend#UpdateBackendAuthOAuthConfig", - "traits": { - "smithy.api#documentation": "

Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.

", - "smithy.api#jsonName": "oAuth" - } - }, - "PasswordPolicy": { - "target": "com.amazonaws.amplifybackend#UpdateBackendAuthPasswordPolicyConfig", - "traits": { - "smithy.api#documentation": "

Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

", - "smithy.api#jsonName": "passwordPolicy" - } - }, - "VerificationMessage": { - "target": "com.amazonaws.amplifybackend#UpdateBackendAuthVerificationMessageConfig", - "traits": { - "smithy.api#documentation": "

Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.

", - "smithy.api#jsonName": "verificationMessage" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Amazon Cognito user pool configuration for the authorization resource to be configured for your Amplify project on an update.

" - } - }, - "com.amazonaws.amplifybackend#UpdateBackendAuthVerificationMessageConfig": { - "type": "structure", - "members": { - "DeliveryMethod": { - "target": "com.amazonaws.amplifybackend#DeliveryMethod", - "traits": { - "smithy.api#documentation": "

The type of verification message to send.

", - "smithy.api#jsonName": "deliveryMethod", - "smithy.api#required": {} - } - }, - "EmailSettings": { - "target": "com.amazonaws.amplifybackend#EmailSettings", - "traits": { - "smithy.api#documentation": "

The settings for the email message.

", - "smithy.api#jsonName": "emailSettings" - } - }, - "SmsSettings": { - "target": "com.amazonaws.amplifybackend#SmsSettings", - "traits": { - "smithy.api#documentation": "

The settings for the SMS message.

", - "smithy.api#jsonName": "smsSettings" - } - } - }, - "traits": { - "smithy.api#documentation": "

Updates the configuration of the email or SMS message for the auth resource configured for your Amplify project.

" - } - }, - "com.amazonaws.amplifybackend#UpdateBackendConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#UpdateBackendConfigRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#UpdateBackendConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the AWS resources required to access the Amplify Admin UI.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/config/update", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#UpdateBackendConfigRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LoginAuthConfig": { - "target": "com.amazonaws.amplifybackend#LoginAuthConfigReqObj", - "traits": { - "smithy.api#documentation": "

Describes the Amazon Cognito configuration for Admin UI access.

", - "smithy.api#jsonName": "loginAuthConfig" - } - } - }, - "traits": { - "smithy.api#documentation": "

The request body for UpdateBackendConfig.

" - } - }, - "com.amazonaws.amplifybackend#UpdateBackendConfigResponse": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId" - } - }, - "BackendManagerAppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID for the backend manager.

", - "smithy.api#jsonName": "backendManagerAppId" - } - }, - "Error": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

If the request fails, this error is returned.

", - "smithy.api#jsonName": "error" - } - }, - "LoginAuthConfig": { - "target": "com.amazonaws.amplifybackend#LoginAuthConfigReqObj", - "traits": { - "smithy.api#documentation": "

Describes the Amazon Cognito configurations for the Admin UI auth resource to log in with.

", - "smithy.api#jsonName": "loginAuthConfig" - } - } - } - }, - "com.amazonaws.amplifybackend#UpdateBackendJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#UpdateBackendJobRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#UpdateBackendJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a specific job.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/job/{BackendEnvironmentName}/{JobId}", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#UpdateBackendJobRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "JobId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID for the job.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Operation": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

Filters the list of response objects to include only those with the specified operation name.

", - "smithy.api#jsonName": "operation" - } - }, - "Status": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

Filters the list of response objects to include only those with the specified status.

", - "smithy.api#jsonName": "status" - } - } - }, - "traits": { - "smithy.api#documentation": "

The request body for GetBackendJob.

" - } - }, - "com.amazonaws.amplifybackend#UpdateBackendJobResponse": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId" - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName" - } - }, - "CreateTime": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The time when the job was created.

", - "smithy.api#jsonName": "createTime" - } - }, - "Error": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

If the request fails, this error is returned.

", - "smithy.api#jsonName": "error" - } - }, - "JobId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID for the job.

", - "smithy.api#jsonName": "jobId" - } - }, - "Operation": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the operation.

", - "smithy.api#jsonName": "operation" - } - }, - "Status": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The current status of the request.

", - "smithy.api#jsonName": "status" - } - }, - "UpdateTime": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The time when the job was last updated.

", - "smithy.api#jsonName": "updateTime" - } - } - } - }, - "com.amazonaws.amplifybackend#UpdateBackendStorage": { - "type": "operation", - "input": { - "target": "com.amazonaws.amplifybackend#UpdateBackendStorageRequest" - }, - "output": { - "target": "com.amazonaws.amplifybackend#UpdateBackendStorageResponse" - }, - "errors": [ - { - "target": "com.amazonaws.amplifybackend#BadRequestException" - }, - { - "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" - }, - { - "target": "com.amazonaws.amplifybackend#NotFoundException" - }, - { - "target": "com.amazonaws.amplifybackend#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an existing backend storage resource.

", - "smithy.api#http": { - "method": "POST", - "uri": "/backend/{AppId}/storage/{BackendEnvironmentName}", - "code": 200 - } - } - }, - "com.amazonaws.amplifybackend#UpdateBackendStorageRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ResourceConfig": { - "target": "com.amazonaws.amplifybackend#UpdateBackendStorageResourceConfig", - "traits": { - "smithy.api#documentation": "

The resource configuration for updating backend storage.

", - "smithy.api#jsonName": "resourceConfig", - "smithy.api#required": {} - } - }, - "ResourceName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the storage resource.

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

The request body for UpdateBackendStorage.

" - } - }, - "com.amazonaws.amplifybackend#UpdateBackendStorageResourceConfig": { - "type": "structure", - "members": { - "Permissions": { - "target": "com.amazonaws.amplifybackend#BackendStoragePermissions", - "traits": { - "smithy.api#documentation": "

The authorization configuration for the storage S3 bucket.

", - "smithy.api#jsonName": "permissions", - "smithy.api#required": {} - } - }, - "ServiceName": { - "target": "com.amazonaws.amplifybackend#ServiceName", - "traits": { - "smithy.api#documentation": "

The name of the storage service.

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

The resource configuration for updating backend storage.

" - } - }, - "com.amazonaws.amplifybackend#UpdateBackendStorageResponse": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#jsonName": "appId" - } - }, - "BackendEnvironmentName": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the backend environment.

", - "smithy.api#jsonName": "backendEnvironmentName" - } - }, - "JobId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID for the job.

", - "smithy.api#jsonName": "jobId" - } - }, - "Status": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The current status of the request.

", - "smithy.api#jsonName": "status" - } - } - } - }, - "com.amazonaws.amplifybackend#__boolean": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.amplifybackend#__double": { - "type": "double", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.amplifybackend#__integerMin1Max25": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 25 + "com.amazonaws.amplifybackend#UpdateBackendAuthResourceConfig": { + "type": "structure", + "members": { + "AuthResources": { + "target": "com.amazonaws.amplifybackend#AuthResources", + "traits": { + "smithy.api#documentation": "

Defines the service name to use when configuring an authentication resource in your Amplify project.

", + "smithy.api#jsonName": "authResources", + "smithy.api#required": {} + } + }, + "IdentityPoolConfigs": { + "target": "com.amazonaws.amplifybackend#UpdateBackendAuthIdentityPoolConfig", + "traits": { + "smithy.api#documentation": "

Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.

", + "smithy.api#jsonName": "identityPoolConfigs" + } + }, + "Service": { + "target": "com.amazonaws.amplifybackend#Service", + "traits": { + "smithy.api#documentation": "

Defines the service name to use when configuring an authentication resource in your Amplify project.

", + "smithy.api#jsonName": "service", + "smithy.api#required": {} + } + }, + "UserPoolConfigs": { + "target": "com.amazonaws.amplifybackend#UpdateBackendAuthUserPoolConfig", + "traits": { + "smithy.api#documentation": "

Describes the authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.

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

Defines the resource configuration when updating an authentication resource in your Amplify project.

" + } + }, + "com.amazonaws.amplifybackend#UpdateBackendAuthResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName" + } + }, + "Error": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

If the request fails, this error is returned.

", + "smithy.api#jsonName": "error" + } + }, + "JobId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID for the job.

", + "smithy.api#jsonName": "jobId" + } + }, + "Operation": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the operation.

", + "smithy.api#jsonName": "operation" + } + }, + "Status": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The current status of the request.

", + "smithy.api#jsonName": "status" + } + } + } + }, + "com.amazonaws.amplifybackend#UpdateBackendAuthUserPoolConfig": { + "type": "structure", + "members": { + "ForgotPassword": { + "target": "com.amazonaws.amplifybackend#UpdateBackendAuthForgotPasswordConfig", + "traits": { + "smithy.api#documentation": "

(DEPRECATED) Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

", + "smithy.api#jsonName": "forgotPassword" + } + }, + "Mfa": { + "target": "com.amazonaws.amplifybackend#UpdateBackendAuthMFAConfig", + "traits": { + "smithy.api#documentation": "

Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.

", + "smithy.api#jsonName": "mfa" + } + }, + "OAuth": { + "target": "com.amazonaws.amplifybackend#UpdateBackendAuthOAuthConfig", + "traits": { + "smithy.api#documentation": "

Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.

", + "smithy.api#jsonName": "oAuth" + } + }, + "PasswordPolicy": { + "target": "com.amazonaws.amplifybackend#UpdateBackendAuthPasswordPolicyConfig", + "traits": { + "smithy.api#documentation": "

Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

", + "smithy.api#jsonName": "passwordPolicy" + } + }, + "VerificationMessage": { + "target": "com.amazonaws.amplifybackend#UpdateBackendAuthVerificationMessageConfig", + "traits": { + "smithy.api#documentation": "

Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.

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

Describes the Amazon Cognito user pool configuration for the authorization resource to be configured for your Amplify project on an update.

" + } + }, + "com.amazonaws.amplifybackend#UpdateBackendAuthVerificationMessageConfig": { + "type": "structure", + "members": { + "DeliveryMethod": { + "target": "com.amazonaws.amplifybackend#DeliveryMethod", + "traits": { + "smithy.api#documentation": "

The type of verification message to send.

", + "smithy.api#jsonName": "deliveryMethod", + "smithy.api#required": {} + } + }, + "EmailSettings": { + "target": "com.amazonaws.amplifybackend#EmailSettings", + "traits": { + "smithy.api#documentation": "

The settings for the email message.

", + "smithy.api#jsonName": "emailSettings" + } + }, + "SmsSettings": { + "target": "com.amazonaws.amplifybackend#SmsSettings", + "traits": { + "smithy.api#documentation": "

The settings for the SMS message.

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

Updates the configuration of the email or SMS message for the auth resource configured for your Amplify project.

" + } + }, + "com.amazonaws.amplifybackend#UpdateBackendConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#UpdateBackendConfigRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#UpdateBackendConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the AWS resources required to access the Amplify Admin UI.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/config/update", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#UpdateBackendConfigRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LoginAuthConfig": { + "target": "com.amazonaws.amplifybackend#LoginAuthConfigReqObj", + "traits": { + "smithy.api#documentation": "

Describes the Amazon Cognito configuration for Admin UI access.

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

The request body for UpdateBackendConfig.

" + } + }, + "com.amazonaws.amplifybackend#UpdateBackendConfigResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "BackendManagerAppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID for the backend manager.

", + "smithy.api#jsonName": "backendManagerAppId" + } + }, + "Error": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

If the request fails, this error is returned.

", + "smithy.api#jsonName": "error" + } + }, + "LoginAuthConfig": { + "target": "com.amazonaws.amplifybackend#LoginAuthConfigReqObj", + "traits": { + "smithy.api#documentation": "

Describes the Amazon Cognito configurations for the Admin UI auth resource to log in with.

", + "smithy.api#jsonName": "loginAuthConfig" + } + } + } + }, + "com.amazonaws.amplifybackend#UpdateBackendJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#UpdateBackendJobRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#UpdateBackendJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a specific job.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/job/{BackendEnvironmentName}/{JobId}", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#UpdateBackendJobRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "JobId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID for the job.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Operation": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

Filters the list of response objects to include only those with the specified operation name.

", + "smithy.api#jsonName": "operation" + } + }, + "Status": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

Filters the list of response objects to include only those with the specified status.

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

The request body for GetBackendJob.

" + } + }, + "com.amazonaws.amplifybackend#UpdateBackendJobResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName" + } + }, + "CreateTime": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The time when the job was created.

", + "smithy.api#jsonName": "createTime" + } + }, + "Error": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

If the request fails, this error is returned.

", + "smithy.api#jsonName": "error" + } + }, + "JobId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID for the job.

", + "smithy.api#jsonName": "jobId" + } + }, + "Operation": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the operation.

", + "smithy.api#jsonName": "operation" + } + }, + "Status": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The current status of the request.

", + "smithy.api#jsonName": "status" + } + }, + "UpdateTime": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The time when the job was last updated.

", + "smithy.api#jsonName": "updateTime" + } + } + } + }, + "com.amazonaws.amplifybackend#UpdateBackendStorage": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#UpdateBackendStorageRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#UpdateBackendStorageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing backend storage resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/storage/{BackendEnvironmentName}", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#UpdateBackendStorageRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceConfig": { + "target": "com.amazonaws.amplifybackend#UpdateBackendStorageResourceConfig", + "traits": { + "smithy.api#documentation": "

The resource configuration for updating backend storage.

", + "smithy.api#jsonName": "resourceConfig", + "smithy.api#required": {} + } + }, + "ResourceName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the storage resource.

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

The request body for UpdateBackendStorage.

" + } + }, + "com.amazonaws.amplifybackend#UpdateBackendStorageResourceConfig": { + "type": "structure", + "members": { + "Permissions": { + "target": "com.amazonaws.amplifybackend#BackendStoragePermissions", + "traits": { + "smithy.api#documentation": "

The authorization configuration for the storage S3 bucket.

", + "smithy.api#jsonName": "permissions", + "smithy.api#required": {} + } + }, + "ServiceName": { + "target": "com.amazonaws.amplifybackend#ServiceName", + "traits": { + "smithy.api#documentation": "

The name of the storage service.

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

The resource configuration for updating backend storage.

" + } + }, + "com.amazonaws.amplifybackend#UpdateBackendStorageResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName" + } + }, + "JobId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID for the job.

", + "smithy.api#jsonName": "jobId" + } + }, + "Status": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The current status of the request.

", + "smithy.api#jsonName": "status" + } + } + } + }, + "com.amazonaws.amplifybackend#__boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.amplifybackend#__double": { + "type": "double", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.amplifybackend#__integerMin1Max25": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.amplifybackend#__string": { + "type": "string" } - } - }, - "com.amazonaws.amplifybackend#__string": { - "type": "string" } - } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/apprunner.json b/codegen/sdk-codegen/aws-models/apprunner.json index 7a1c23a4ee24..13ff23fe7d18 100644 --- a/codegen/sdk-codegen/aws-models/apprunner.json +++ b/codegen/sdk-codegen/aws-models/apprunner.json @@ -1,5099 +1,5140 @@ { - "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.apprunner#ASConfigMaxConcurrency": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.apprunner#ASConfigMaxSize": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.apprunner#ASConfigMinSize": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.apprunner#AppRunner": { - "type": "service", - "version": "2020-05-15", - "operations": [ - { - "target": "com.amazonaws.apprunner#AssociateCustomDomain" - }, - { - "target": "com.amazonaws.apprunner#CreateAutoScalingConfiguration" - }, - { - "target": "com.amazonaws.apprunner#CreateConnection" - }, - { - "target": "com.amazonaws.apprunner#CreateObservabilityConfiguration" - }, - { - "target": "com.amazonaws.apprunner#CreateService" - }, - { - "target": "com.amazonaws.apprunner#CreateVpcConnector" - }, - { - "target": "com.amazonaws.apprunner#CreateVpcIngressConnection" - }, - { - "target": "com.amazonaws.apprunner#DeleteAutoScalingConfiguration" - }, - { - "target": "com.amazonaws.apprunner#DeleteConnection" - }, - { - "target": "com.amazonaws.apprunner#DeleteObservabilityConfiguration" - }, - { - "target": "com.amazonaws.apprunner#DeleteService" - }, - { - "target": "com.amazonaws.apprunner#DeleteVpcConnector" - }, - { - "target": "com.amazonaws.apprunner#DeleteVpcIngressConnection" - }, - { - "target": "com.amazonaws.apprunner#DescribeAutoScalingConfiguration" - }, - { - "target": "com.amazonaws.apprunner#DescribeCustomDomains" - }, - { - "target": "com.amazonaws.apprunner#DescribeObservabilityConfiguration" - }, - { - "target": "com.amazonaws.apprunner#DescribeService" - }, - { - "target": "com.amazonaws.apprunner#DescribeVpcConnector" - }, - { - "target": "com.amazonaws.apprunner#DescribeVpcIngressConnection" - }, - { - "target": "com.amazonaws.apprunner#DisassociateCustomDomain" - }, - { - "target": "com.amazonaws.apprunner#ListAutoScalingConfigurations" - }, - { - "target": "com.amazonaws.apprunner#ListConnections" - }, - { - "target": "com.amazonaws.apprunner#ListObservabilityConfigurations" - }, - { - "target": "com.amazonaws.apprunner#ListOperations" - }, - { - "target": "com.amazonaws.apprunner#ListServices" - }, - { - "target": "com.amazonaws.apprunner#ListTagsForResource" - }, - { - "target": "com.amazonaws.apprunner#ListVpcConnectors" - }, - { - "target": "com.amazonaws.apprunner#ListVpcIngressConnections" - }, - { - "target": "com.amazonaws.apprunner#PauseService" - }, - { - "target": "com.amazonaws.apprunner#ResumeService" - }, - { - "target": "com.amazonaws.apprunner#StartDeployment" - }, - { - "target": "com.amazonaws.apprunner#TagResource" - }, - { - "target": "com.amazonaws.apprunner#UntagResource" - }, - { - "target": "com.amazonaws.apprunner#UpdateService" - }, - { - "target": "com.amazonaws.apprunner#UpdateVpcIngressConnection" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "AppRunner", - "arnNamespace": "apprunner", - "cloudFormationName": "AppRunner", - "cloudTrailEventSource": "apprunner.amazonaws.com", - "endpointPrefix": "apprunner" - }, - "aws.auth#sigv4": { - "name": "apprunner" - }, - "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "App Runner\n\n \n\n

App Runner is an application service that provides a fast, simple, and cost-effective way to go directly from an existing container image or source code\n to a running service in the Amazon Web Services Cloud in seconds. You don't need to learn new technologies, decide which compute service to use, or understand how to\n provision and configure Amazon Web Services resources.

\n

App Runner connects directly to your container registry or source code repository. It provides an automatic delivery pipeline with fully managed operations,\n high performance, scalability, and security.

\n

For more information about App Runner, see the App Runner Developer Guide.\n For release information, see the App Runner Release Notes.

\n

\n To install the Software Development Kits (SDKs), Integrated\n Development Environment (IDE) Toolkits, and command line tools that you can use to access the API, see Tools for\n Amazon Web Services.

\n

\n Endpoints\n

\n

For a list of Region-specific endpoints that App Runner supports, see App Runner\n endpoints and quotas in the Amazon Web Services General Reference.

", - "smithy.api#title": "AWS App Runner", - "smithy.api#xmlNamespace": { - "uri": "http://apprunner.amazonaws.com/doc/2020-05-15/" - }, - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" }, - "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" + { + "id": "PaginatedTrait", + "namespace": "*" }, - "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" + { + "id": "HttpHeaderTrait", + "namespace": "*" }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.apprunner#ASConfigMaxConcurrency": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.apprunner#ASConfigMaxSize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.apprunner#ASConfigMinSize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 25 } - ], - "type": "tree", - "rules": [ + } + }, + "com.amazonaws.apprunner#AppRunner": { + "type": "service", + "version": "2020-05-15", + "operations": [ { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" + "target": "com.amazonaws.apprunner#AssociateCustomDomain" + }, + { + "target": "com.amazonaws.apprunner#CreateAutoScalingConfiguration" + }, + { + "target": "com.amazonaws.apprunner#CreateConnection" + }, + { + "target": "com.amazonaws.apprunner#CreateObservabilityConfiguration" + }, + { + "target": "com.amazonaws.apprunner#CreateService" + }, + { + "target": "com.amazonaws.apprunner#CreateVpcConnector" + }, + { + "target": "com.amazonaws.apprunner#CreateVpcIngressConnection" + }, + { + "target": "com.amazonaws.apprunner#DeleteAutoScalingConfiguration" + }, + { + "target": "com.amazonaws.apprunner#DeleteConnection" + }, + { + "target": "com.amazonaws.apprunner#DeleteObservabilityConfiguration" + }, + { + "target": "com.amazonaws.apprunner#DeleteService" + }, + { + "target": "com.amazonaws.apprunner#DeleteVpcConnector" + }, + { + "target": "com.amazonaws.apprunner#DeleteVpcIngressConnection" + }, + { + "target": "com.amazonaws.apprunner#DescribeAutoScalingConfiguration" + }, + { + "target": "com.amazonaws.apprunner#DescribeCustomDomains" + }, + { + "target": "com.amazonaws.apprunner#DescribeObservabilityConfiguration" + }, + { + "target": "com.amazonaws.apprunner#DescribeService" + }, + { + "target": "com.amazonaws.apprunner#DescribeVpcConnector" + }, + { + "target": "com.amazonaws.apprunner#DescribeVpcIngressConnection" + }, + { + "target": "com.amazonaws.apprunner#DisassociateCustomDomain" + }, + { + "target": "com.amazonaws.apprunner#ListAutoScalingConfigurations" + }, + { + "target": "com.amazonaws.apprunner#ListConnections" + }, + { + "target": "com.amazonaws.apprunner#ListObservabilityConfigurations" + }, + { + "target": "com.amazonaws.apprunner#ListOperations" + }, + { + "target": "com.amazonaws.apprunner#ListServices" + }, + { + "target": "com.amazonaws.apprunner#ListTagsForResource" + }, + { + "target": "com.amazonaws.apprunner#ListVpcConnectors" + }, + { + "target": "com.amazonaws.apprunner#ListVpcIngressConnections" + }, + { + "target": "com.amazonaws.apprunner#PauseService" + }, + { + "target": "com.amazonaws.apprunner#ResumeService" + }, + { + "target": "com.amazonaws.apprunner#StartDeployment" + }, + { + "target": "com.amazonaws.apprunner#TagResource" + }, + { + "target": "com.amazonaws.apprunner#UntagResource" + }, + { + "target": "com.amazonaws.apprunner#UpdateService" + }, + { + "target": "com.amazonaws.apprunner#UpdateVpcIngressConnection" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "AppRunner", + "arnNamespace": "apprunner", + "cloudFormationName": "AppRunner", + "cloudTrailEventSource": "apprunner.amazonaws.com", + "endpointPrefix": "apprunner" + }, + "aws.auth#sigv4": { + "name": "apprunner" + }, + "aws.protocols#awsJson1_0": {}, + "smithy.api#documentation": "App Runner\n\n \n\n

App Runner is an application service that provides a fast, simple, and cost-effective way to go directly from an existing container image or source code\n to a running service in the Amazon Web Services Cloud in seconds. You don't need to learn new technologies, decide which compute service to use, or understand how to\n provision and configure Amazon Web Services resources.

\n

App Runner connects directly to your container registry or source code repository. It provides an automatic delivery pipeline with fully managed operations,\n high performance, scalability, and security.

\n

For more information about App Runner, see the App Runner Developer Guide.\n For release information, see the App Runner Release Notes.

\n

\n To install the Software Development Kits (SDKs), Integrated\n Development Environment (IDE) Toolkits, and command line tools that you can use to access the API, see Tools for\n Amazon Web Services.

\n

\n Endpoints\n

\n

For a list of Region-specific endpoints that App Runner supports, see App Runner\n endpoints and quotas in the Amazon Web Services General Reference.

", + "smithy.api#title": "AWS App Runner", + "smithy.api#xmlNamespace": { + "uri": "http://apprunner.amazonaws.com/doc/2020-05-15/" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": true, + "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" } - ] }, - { - "fn": "parseURL", - "argv": [ + "rules": [ { - "ref": "Endpoint" + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "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" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://apprunner-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": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://apprunner-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://apprunner.{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://apprunner.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] } - ], - "assign": "url" - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://apprunner-fips.us-west-2.api.aws" + } }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "type": "tree", - "rules": [ + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": true + } + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apprunner-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" }, { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://apprunner.us-west-2.api.aws" + } }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": true + } + }, { - "ref": "UseFIPS" + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apprunner.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ { - "ref": "UseDualStack" + "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://apprunner-fips.eu-west-1.api.aws" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": true, + "UseDualStack": true + } }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apprunner-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": true, + "UseDualStack": false } - ] }, { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://apprunner.eu-west-1.api.aws" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": true } - ] - } - ], - "type": "tree", - "rules": [ + }, { - "conditions": [], - "endpoint": { - "url": "https://apprunner-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": [ - { - "fn": "booleanEquals", - "argv": [ + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apprunner.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, { - "ref": "UseFIPS" + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://apprunner-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": true, + "UseDualStack": true + } }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apprunner-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": true, + "UseDualStack": false } - ] - } - ], - "type": "tree", - "rules": [ + }, { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://apprunner-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://apprunner.ap-northeast-1.api.aws" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": true } - ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + }, { - "ref": "UseDualStack" + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apprunner.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://apprunner-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true } - ] - } - ], - "type": "tree", - "rules": [ + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apprunner-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://apprunner.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://apprunner.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://apprunner-fips.us-east-2.api.aws" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apprunner-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://apprunner.us-east-2.api.aws" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://apprunner.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with 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 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" + } + }, { - "conditions": [], - "endpoint": { - "url": "https://apprunner.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "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" + } } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] - }, - { - "conditions": [], - "endpoint": { - "url": "https://apprunner.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + ], + "version": "1.0" } - ] } - ] }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://apprunner-fips.us-west-2.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "us-west-2" - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://apprunner-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "us-west-2" - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://apprunner.us-west-2.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "us-west-2" - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://apprunner.us-west-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "us-west-2" - } - }, - { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://apprunner-fips.eu-west-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-west-1" - } + "com.amazonaws.apprunner#AppRunnerResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}$" + } + }, + "com.amazonaws.apprunner#AssociateCustomDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#AssociateCustomDomainRequest" }, - { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://apprunner-fips.eu-west-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-west-1" - } + "output": { + "target": "com.amazonaws.apprunner#AssociateCustomDomainResponse" }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://apprunner.eu-west-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-west-1" - } + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#InvalidStateException" + } + ], + "traits": { + "smithy.api#documentation": "

Associate your own domain name with the App Runner subdomain URL of your App Runner service.

\n

After you call AssociateCustomDomain and receive a successful response, use the information in the CustomDomain record\n that's returned to add CNAME records to your Domain Name System (DNS). For each mapped domain name, add a mapping to the target App Runner subdomain and one or\n more certificate validation records. App Runner then performs DNS validation to verify that you own or control the domain name that you associated. App Runner tracks\n domain validity in a certificate stored in AWS Certificate Manager (ACM).

" + } + }, + "com.amazonaws.apprunner#AssociateCustomDomainRequest": { + "type": "structure", + "members": { + "ServiceArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner service that you want to associate a custom domain name with.

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

A custom domain endpoint to associate. Specify a root domain (for example, example.com), a subdomain (for example,\n login.example.com or admin.login.example.com), or a wildcard (for example, *.example.com).

", + "smithy.api#required": {} + } + }, + "EnableWWWSubdomain": { + "target": "com.amazonaws.apprunner#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Set to true to associate the subdomain www.DomainName\n with the App Runner service in addition to the base\n domain.

\n

Default: true\n

" + } + } + } + }, + "com.amazonaws.apprunner#AssociateCustomDomainResponse": { + "type": "structure", + "members": { + "DNSTarget": { + "target": "com.amazonaws.apprunner#String", + "traits": { + "smithy.api#documentation": "

The App Runner subdomain of the App Runner service. The custom domain name is mapped to this target name.

", + "smithy.api#required": {} + } + }, + "ServiceArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner service with which a custom domain name is associated.

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

A description of the domain name that's being associated.

", + "smithy.api#required": {} + } + }, + "VpcDNSTargets": { + "target": "com.amazonaws.apprunner#VpcDNSTargetList", + "traits": { + "smithy.api#documentation": "

DNS Target records for the custom domains of this Amazon VPC.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#AuthenticationConfiguration": { + "type": "structure", + "members": { + "ConnectionArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner connection that enables the App Runner service to connect to a source repository. It's required for GitHub code\n repositories.

" + } + }, + "AccessRoleArn": { + "target": "com.amazonaws.apprunner#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that grants the App Runner service access to a source repository. It's required for ECR image repositories\n (but not for ECR Public repositories).

" + } + } }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://apprunner.eu-west-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-west-1" - } + "traits": { + "smithy.api#documentation": "

Describes resources needed to authenticate access to some source repositories. The specific resource depends on the repository provider.

" + } + }, + "com.amazonaws.apprunner#AutoScalingConfiguration": { + "type": "structure", + "members": { + "AutoScalingConfigurationArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of this auto scaling configuration.

" + } + }, + "AutoScalingConfigurationName": { + "target": "com.amazonaws.apprunner#AutoScalingConfigurationName", + "traits": { + "smithy.api#documentation": "

The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.

" + } + }, + "AutoScalingConfigurationRevision": { + "target": "com.amazonaws.apprunner#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The revision of this auto scaling configuration. It's unique among all the active configurations (\"Status\": \"ACTIVE\") that share the same\n AutoScalingConfigurationName.

" + } + }, + "Latest": { + "target": "com.amazonaws.apprunner#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

It's set to true for the configuration with the highest Revision among all configurations that share the same\n AutoScalingConfigurationName. It's set to false otherwise.

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

The current state of the auto scaling configuration. If the status of a configuration revision is INACTIVE, it was deleted and can't be\n used. Inactive configuration revisions are permanently removed some time after they are deleted.

" + } + }, + "MaxConcurrency": { + "target": "com.amazonaws.apprunner#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of concurrent requests that an instance processes. If the number of concurrent requests exceeds this limit, App Runner scales the service\n up.

" + } + }, + "MinSize": { + "target": "com.amazonaws.apprunner#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum number of instances that App Runner provisions for a service. The service always has at least MinSize provisioned instances. Some\n of them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to be\n quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.

\n

App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.

" + } + }, + "MaxSize": { + "target": "com.amazonaws.apprunner#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of instances that a service scales up to. At most MaxSize instances actively serve traffic for your service.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.apprunner#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the auto scaling configuration was created. It's in Unix time stamp format.

" + } + }, + "DeletedAt": { + "target": "com.amazonaws.apprunner#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the auto scaling configuration was deleted. It's in Unix time stamp format.

" + } + } }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://apprunner-fips.ap-northeast-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-northeast-1" - } + "traits": { + "smithy.api#documentation": "

Describes an App Runner automatic scaling configuration resource.

\n

A higher MinSize increases the spread of your App Runner service over more Availability Zones in the Amazon Web Services Region. The tradeoff is a higher\n minimal cost.

\n

A lower MaxSize controls your cost. The tradeoff is lower responsiveness during peak demand.

\n

Multiple revisions of a configuration might have the same AutoScalingConfigurationName and different\n AutoScalingConfigurationRevision values.

" + } + }, + "com.amazonaws.apprunner#AutoScalingConfigurationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 32 + }, + "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9\\-_]{3,31}$" + } + }, + "com.amazonaws.apprunner#AutoScalingConfigurationStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + } + } + }, + "com.amazonaws.apprunner#AutoScalingConfigurationSummary": { + "type": "structure", + "members": { + "AutoScalingConfigurationArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of this auto scaling configuration.

" + } + }, + "AutoScalingConfigurationName": { + "target": "com.amazonaws.apprunner#AutoScalingConfigurationName", + "traits": { + "smithy.api#documentation": "

The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.

" + } + }, + "AutoScalingConfigurationRevision": { + "target": "com.amazonaws.apprunner#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The revision of this auto scaling configuration. It's unique among all the active configurations (\"Status\": \"ACTIVE\") with the same\n AutoScalingConfigurationName.

" + } + } }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://apprunner-fips.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-northeast-1" - } + "traits": { + "smithy.api#documentation": "

Provides summary information about an App Runner automatic scaling configuration resource.

\n

This type contains limited information about an auto scaling configuration. It includes only identification information, without configuration\n details. It's returned by the ListAutoScalingConfigurations action. Complete configuration information is returned by the CreateAutoScalingConfiguration, DescribeAutoScalingConfiguration, and DeleteAutoScalingConfiguration\n actions using the AutoScalingConfiguration type.

" + } + }, + "com.amazonaws.apprunner#AutoScalingConfigurationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.apprunner#AutoScalingConfigurationSummary" + } + }, + "com.amazonaws.apprunner#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.apprunner#BuildCommand": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[^\\x0a\\x0d]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.apprunner#CertificateValidationRecord": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.apprunner#String", + "traits": { + "smithy.api#documentation": "

The certificate CNAME record name.

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

The record type, always CNAME.

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

The certificate CNAME record value.

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

The current state of the certificate CNAME record validation. It should change to SUCCESS after App Runner completes validation with your\n DNS.

" + } + } }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://apprunner.ap-northeast-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-northeast-1" - } + "traits": { + "smithy.api#documentation": "

Describes a certificate CNAME record to add to your DNS. For more information, see AssociateCustomDomain.

" + } + }, + "com.amazonaws.apprunner#CertificateValidationRecordList": { + "type": "list", + "member": { + "target": "com.amazonaws.apprunner#CertificateValidationRecord" + } + }, + "com.amazonaws.apprunner#CertificateValidationRecordStatus": { + "type": "enum", + "members": { + "PENDING_VALIDATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_VALIDATION" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.apprunner#CodeConfiguration": { + "type": "structure", + "members": { + "ConfigurationSource": { + "target": "com.amazonaws.apprunner#ConfigurationSource", + "traits": { + "smithy.api#documentation": "

The source of the App Runner configuration. Values are interpreted as follows:

\n ", + "smithy.api#required": {} + } + }, + "CodeConfigurationValues": { + "target": "com.amazonaws.apprunner#CodeConfigurationValues", + "traits": { + "smithy.api#documentation": "

The basic configuration for building and running the App Runner service. Use it to quickly launch an App Runner service without providing a\n apprunner.yaml file in the source code repository (or ignoring the file if it exists).

" + } + } }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://apprunner.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "ap-northeast-1" - } + "traits": { + "smithy.api#documentation": "

Describes the configuration that App Runner uses to build and run an App Runner service from a source code repository.

" + } + }, + "com.amazonaws.apprunner#CodeConfigurationValues": { + "type": "structure", + "members": { + "Runtime": { + "target": "com.amazonaws.apprunner#Runtime", + "traits": { + "smithy.api#documentation": "

A runtime environment type for building and running an App Runner service.\n It represents a\n programming language runtime.

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

The command App Runner runs to build your application.

" + } + }, + "StartCommand": { + "target": "com.amazonaws.apprunner#StartCommand", + "traits": { + "smithy.api#documentation": "

The command App Runner runs to start your application.

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

The port that your application listens to in the container.

\n

Default: 8080\n

" + } + }, + "RuntimeEnvironmentVariables": { + "target": "com.amazonaws.apprunner#RuntimeEnvironmentVariables", + "traits": { + "smithy.api#documentation": "

The environment variables that are available to your running App Runner service. An array of key-value pairs.

" + } + }, + "RuntimeEnvironmentSecrets": { + "target": "com.amazonaws.apprunner#RuntimeEnvironmentSecrets", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. \n The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

\n \n \n " + } + } }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://apprunner-fips.us-east-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "us-east-1" - } + "traits": { + "smithy.api#documentation": "

Describes the basic configuration needed for building and running an App Runner service. This type doesn't support the full set of possible\n configuration options. Fur full configuration capabilities, use a apprunner.yaml file in the source code repository.

" + } + }, + "com.amazonaws.apprunner#CodeRepository": { + "type": "structure", + "members": { + "RepositoryUrl": { + "target": "com.amazonaws.apprunner#String", + "traits": { + "smithy.api#documentation": "

The location of the repository that contains the source code.

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

The version that should be used within the source code repository.

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

Configuration for building and running the service from a source code repository.

\n \n

\n CodeConfiguration is required only for CreateService request.

\n " + } + } }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://apprunner-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "us-east-1" - } + "traits": { + "smithy.api#documentation": "

Describes a source code repository.

" + } + }, + "com.amazonaws.apprunner#ConfigurationSource": { + "type": "enum", + "members": { + "REPOSITORY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPOSITORY" + } + }, + "API": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "API" + } + } + } + }, + "com.amazonaws.apprunner#Connection": { + "type": "structure", + "members": { + "ConnectionName": { + "target": "com.amazonaws.apprunner#ConnectionName", + "traits": { + "smithy.api#documentation": "

The customer-provided connection name.

" + } + }, + "ConnectionArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of this connection.

" + } + }, + "ProviderType": { + "target": "com.amazonaws.apprunner#ProviderType", + "traits": { + "smithy.api#documentation": "

The source repository provider.

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

The current state of the App Runner connection. When the state is AVAILABLE, you can use the connection to create an App Runner service.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.apprunner#Timestamp", + "traits": { + "smithy.api#documentation": "

The App Runner connection creation time, expressed as a Unix time stamp.

" + } + } }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://apprunner.us-east-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "us-east-1" - } + "traits": { + "smithy.api#documentation": "

Describes an App Runner connection resource.

" + } + }, + "com.amazonaws.apprunner#ConnectionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 32 + }, + "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9\\-_]{3,31}$" + } + }, + "com.amazonaws.apprunner#ConnectionStatus": { + "type": "enum", + "members": { + "PENDING_HANDSHAKE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_HANDSHAKE" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + } + }, + "com.amazonaws.apprunner#ConnectionSummary": { + "type": "structure", + "members": { + "ConnectionName": { + "target": "com.amazonaws.apprunner#ConnectionName", + "traits": { + "smithy.api#documentation": "

The customer-provided connection name.

" + } + }, + "ConnectionArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of this connection.

" + } + }, + "ProviderType": { + "target": "com.amazonaws.apprunner#ProviderType", + "traits": { + "smithy.api#documentation": "

The source repository provider.

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

The current state of the App Runner connection. When the state is AVAILABLE, you can use the connection to create an App Runner service.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.apprunner#Timestamp", + "traits": { + "smithy.api#documentation": "

The App Runner connection creation time, expressed as a Unix time stamp.

" + } + } }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://apprunner.us-east-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "us-east-1" - } + "traits": { + "smithy.api#documentation": "

Provides summary information about an App Runner connection resource.

" + } + }, + "com.amazonaws.apprunner#ConnectionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.apprunner#ConnectionSummary" + } + }, + "com.amazonaws.apprunner#Cpu": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 6 + }, + "smithy.api#pattern": "^1024|2048|(1|2) vCPU$" + } + }, + "com.amazonaws.apprunner#CreateAutoScalingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#CreateAutoScalingConfigurationRequest" }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://apprunner-fips.us-east-2.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "us-east-2" - } + "output": { + "target": "com.amazonaws.apprunner#CreateAutoScalingConfigurationResponse" }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://apprunner-fips.us-east-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "us-east-2" - } + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#ServiceQuotaExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Create an App Runner automatic scaling configuration resource. App Runner requires this resource when you create or update App Runner services and you require\n non-default auto scaling settings. You can share an auto scaling configuration across multiple services.

\n

Create multiple revisions of a configuration by calling this action multiple times using the same AutoScalingConfigurationName. The call\n returns incremental AutoScalingConfigurationRevision values. When you create a service and configure an auto scaling configuration resource,\n the service uses the latest active revision of the auto scaling configuration by default. You can optionally configure the service to use a specific\n revision.

\n

Configure a higher MinSize to increase the spread of your App Runner service over more Availability Zones in the Amazon Web Services Region. The tradeoff is\n a higher minimal cost.

\n

Configure a lower MaxSize to control your cost. The tradeoff is lower responsiveness during peak demand.

" + } + }, + "com.amazonaws.apprunner#CreateAutoScalingConfigurationRequest": { + "type": "structure", + "members": { + "AutoScalingConfigurationName": { + "target": "com.amazonaws.apprunner#AutoScalingConfigurationName", + "traits": { + "smithy.api#documentation": "

A name for the auto scaling configuration. When you use it for the first time in an Amazon Web Services Region, App Runner creates revision number 1 of this\n name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.

\n \n

The name DefaultConfiguration is reserved (it's the configuration that App Runner uses if you don't provide a custome one). You can't use it\n to create a new auto scaling configuration, and you can't create a revision of it.

\n

When you want to use your own auto scaling configuration for your App Runner service, create a configuration with a different name,\n and then provide it when you create or update your service.

\n ", + "smithy.api#required": {} + } + }, + "MaxConcurrency": { + "target": "com.amazonaws.apprunner#ASConfigMaxConcurrency", + "traits": { + "smithy.api#documentation": "

The maximum number of concurrent requests that you want an instance to process. If the number of concurrent requests exceeds this limit, App Runner scales\n up your service.

\n

Default: 100\n

" + } + }, + "MinSize": { + "target": "com.amazonaws.apprunner#ASConfigMinSize", + "traits": { + "smithy.api#documentation": "

The minimum number of instances that App Runner provisions for your service. The service always has at least MinSize provisioned instances.\n Some of them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to\n be quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.

\n

App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.

\n

Default: 1\n

" + } + }, + "MaxSize": { + "target": "com.amazonaws.apprunner#ASConfigMaxSize", + "traits": { + "smithy.api#documentation": "

The maximum number of instances that your service scales up to. At most MaxSize instances actively serve traffic for your service.

\n

Default: 25\n

" + } + }, + "Tags": { + "target": "com.amazonaws.apprunner#TagList", + "traits": { + "smithy.api#documentation": "

A list of metadata items that you can associate with your auto scaling configuration resource. A tag is a key-value pair.

" + } + } + } + }, + "com.amazonaws.apprunner#CreateAutoScalingConfigurationResponse": { + "type": "structure", + "members": { + "AutoScalingConfiguration": { + "target": "com.amazonaws.apprunner#AutoScalingConfiguration", + "traits": { + "smithy.api#documentation": "

A description of the App Runner auto scaling configuration that's created by this request.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#CreateConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#CreateConnectionRequest" }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://apprunner.us-east-2.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "us-east-2" - } + "output": { + "target": "com.amazonaws.apprunner#CreateConnectionResponse" }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://apprunner.us-east-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "us-east-2" - } + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#ServiceQuotaExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Create an App Runner connection resource. App Runner requires a connection resource when you create App Runner services that access private repositories from\n certain third-party providers. You can share a connection across multiple services.

\n

A connection resource is needed to access GitHub repositories. GitHub requires a user interface approval process through the App Runner console before you\n can use the connection.

" + } + }, + "com.amazonaws.apprunner#CreateConnectionRequest": { + "type": "structure", + "members": { + "ConnectionName": { + "target": "com.amazonaws.apprunner#ConnectionName", + "traits": { + "smithy.api#documentation": "

A name for the new connection. It must be unique across all App Runner connections for the Amazon Web Services account in the Amazon Web Services Region.

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

The source repository provider.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.apprunner#TagList", + "traits": { + "smithy.api#documentation": "

A list of metadata items that you can associate with your connection resource. A tag is a key-value pair.

" + } + } + } + }, + "com.amazonaws.apprunner#CreateConnectionResponse": { + "type": "structure", + "members": { + "Connection": { + "target": "com.amazonaws.apprunner#Connection", + "traits": { + "smithy.api#documentation": "

A description of the App Runner connection that's created by this request.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#CreateObservabilityConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#CreateObservabilityConfigurationRequest" }, - { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "us-east-1", - "Endpoint": "https://example.com" - } + "output": { + "target": "com.amazonaws.apprunner#CreateObservabilityConfigurationResponse" }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "us-east-1", - "Endpoint": "https://example.com" - } + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#ServiceQuotaExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Create an App Runner observability configuration resource. App Runner requires this resource when you create or update App Runner services and you want to enable\n non-default observability features. You can share an observability configuration across multiple services.

\n

Create multiple revisions of a configuration by calling this action multiple times using the same ObservabilityConfigurationName. The\n call returns incremental ObservabilityConfigurationRevision values. When you create a service and configure an observability configuration\n resource, the service uses the latest active revision of the observability configuration by default. You can optionally configure the service to use a\n specific revision.

\n

The observability configuration resource is designed to configure multiple features (currently one feature, tracing). This action takes optional\n parameters that describe the configuration of these features (currently one parameter, TraceConfiguration). If you don't specify a feature\n parameter, App Runner doesn't enable the feature.

" + } + }, + "com.amazonaws.apprunner#CreateObservabilityConfigurationRequest": { + "type": "structure", + "members": { + "ObservabilityConfigurationName": { + "target": "com.amazonaws.apprunner#ObservabilityConfigurationName", + "traits": { + "smithy.api#documentation": "

A name for the observability configuration. When you use it for the first time in an Amazon Web Services Region, App Runner creates revision number\n 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.

\n \n

The name DefaultConfiguration is reserved. You can't use it to create a new observability configuration, and you can't create a\n revision of it.

\n

When you want to use your own observability configuration for your App Runner service, create a configuration with a different name,\n and then provide it when you create or update your service.

\n ", + "smithy.api#required": {} + } + }, + "TraceConfiguration": { + "target": "com.amazonaws.apprunner#TraceConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing.

" + } + }, + "Tags": { + "target": "com.amazonaws.apprunner#TagList", + "traits": { + "smithy.api#documentation": "

A list of metadata items that you can associate with your observability configuration resource. A tag is a key-value pair.

" + } + } + } + }, + "com.amazonaws.apprunner#CreateObservabilityConfigurationResponse": { + "type": "structure", + "members": { + "ObservabilityConfiguration": { + "target": "com.amazonaws.apprunner#ObservabilityConfiguration", + "traits": { + "smithy.api#documentation": "

A description of the App Runner observability configuration that's created by this request.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#CreateService": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#CreateServiceRequest" }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "us-east-1", - "Endpoint": "https://example.com" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.apprunner#AppRunnerResourceArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1011 - }, - "smithy.api#pattern": "^arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}$" - } - }, - "com.amazonaws.apprunner#AssociateCustomDomain": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#AssociateCustomDomainRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#AssociateCustomDomainResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#InvalidStateException" - } - ], - "traits": { - "smithy.api#documentation": "

Associate your own domain name with the App Runner subdomain URL of your App Runner service.

\n

After you call AssociateCustomDomain and receive a successful response, use the information in the CustomDomain record\n that's returned to add CNAME records to your Domain Name System (DNS). For each mapped domain name, add a mapping to the target App Runner subdomain and one or\n more certificate validation records. App Runner then performs DNS validation to verify that you own or control the domain name that you associated. App Runner tracks\n domain validity in a certificate stored in AWS Certificate Manager (ACM).

" - } - }, - "com.amazonaws.apprunner#AssociateCustomDomainRequest": { - "type": "structure", - "members": { - "ServiceArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner service that you want to associate a custom domain name with.

", - "smithy.api#required": {} - } - }, - "DomainName": { - "target": "com.amazonaws.apprunner#DomainName", - "traits": { - "smithy.api#documentation": "

A custom domain endpoint to associate. Specify a root domain (for example, example.com), a subdomain (for example,\n login.example.com or admin.login.example.com), or a wildcard (for example, *.example.com).

", - "smithy.api#required": {} - } - }, - "EnableWWWSubdomain": { - "target": "com.amazonaws.apprunner#NullableBoolean", - "traits": { - "smithy.api#documentation": "

Set to true to associate the subdomain www.DomainName\n with the App Runner service in addition to the base\n domain.

\n

Default: true\n

" - } - } - } - }, - "com.amazonaws.apprunner#AssociateCustomDomainResponse": { - "type": "structure", - "members": { - "DNSTarget": { - "target": "com.amazonaws.apprunner#String", - "traits": { - "smithy.api#documentation": "

The App Runner subdomain of the App Runner service. The custom domain name is mapped to this target name.

", - "smithy.api#required": {} - } - }, - "ServiceArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner service with which a custom domain name is associated.

", - "smithy.api#required": {} - } - }, - "CustomDomain": { - "target": "com.amazonaws.apprunner#CustomDomain", - "traits": { - "smithy.api#documentation": "

A description of the domain name that's being associated.

", - "smithy.api#required": {} - } - }, - "VpcDNSTargets": { - "target": "com.amazonaws.apprunner#VpcDNSTargetList", - "traits": { - "smithy.api#documentation": "

DNS Target records for the custom domains of this Amazon VPC.\n

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#AuthenticationConfiguration": { - "type": "structure", - "members": { - "ConnectionArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner connection that enables the App Runner service to connect to a source repository. It's required for GitHub code\n repositories.

" - } - }, - "AccessRoleArn": { - "target": "com.amazonaws.apprunner#RoleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that grants the App Runner service access to a source repository. It's required for ECR image repositories\n (but not for ECR Public repositories).

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

Describes resources needed to authenticate access to some source repositories. The specific resource depends on the repository provider.

" - } - }, - "com.amazonaws.apprunner#AutoScalingConfiguration": { - "type": "structure", - "members": { - "AutoScalingConfigurationArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of this auto scaling configuration.

" - } - }, - "AutoScalingConfigurationName": { - "target": "com.amazonaws.apprunner#AutoScalingConfigurationName", - "traits": { - "smithy.api#documentation": "

The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.

" - } - }, - "AutoScalingConfigurationRevision": { - "target": "com.amazonaws.apprunner#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The revision of this auto scaling configuration. It's unique among all the active configurations (\"Status\": \"ACTIVE\") that share the same\n AutoScalingConfigurationName.

" - } - }, - "Latest": { - "target": "com.amazonaws.apprunner#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

It's set to true for the configuration with the highest Revision among all configurations that share the same\n AutoScalingConfigurationName. It's set to false otherwise.

" - } - }, - "Status": { - "target": "com.amazonaws.apprunner#AutoScalingConfigurationStatus", - "traits": { - "smithy.api#documentation": "

The current state of the auto scaling configuration. If the status of a configuration revision is INACTIVE, it was deleted and can't be\n used. Inactive configuration revisions are permanently removed some time after they are deleted.

" - } - }, - "MaxConcurrency": { - "target": "com.amazonaws.apprunner#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of concurrent requests that an instance processes. If the number of concurrent requests exceeds this limit, App Runner scales the service\n up.

" - } - }, - "MinSize": { - "target": "com.amazonaws.apprunner#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum number of instances that App Runner provisions for a service. The service always has at least MinSize provisioned instances. Some\n of them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to be\n quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.

\n

App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.

" - } - }, - "MaxSize": { - "target": "com.amazonaws.apprunner#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of instances that a service scales up to. At most MaxSize instances actively serve traffic for your service.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.apprunner#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the auto scaling configuration was created. It's in Unix time stamp format.

" - } - }, - "DeletedAt": { - "target": "com.amazonaws.apprunner#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the auto scaling configuration was deleted. It's in Unix time stamp format.

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

Describes an App Runner automatic scaling configuration resource.

\n

A higher MinSize increases the spread of your App Runner service over more Availability Zones in the Amazon Web Services Region. The tradeoff is a higher\n minimal cost.

\n

A lower MaxSize controls your cost. The tradeoff is lower responsiveness during peak demand.

\n

Multiple revisions of a configuration might have the same AutoScalingConfigurationName and different\n AutoScalingConfigurationRevision values.

" - } - }, - "com.amazonaws.apprunner#AutoScalingConfigurationName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 4, - "max": 32 - }, - "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9\\-_]{3,31}$" - } - }, - "com.amazonaws.apprunner#AutoScalingConfigurationStatus": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "INACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INACTIVE" - } - } - } - }, - "com.amazonaws.apprunner#AutoScalingConfigurationSummary": { - "type": "structure", - "members": { - "AutoScalingConfigurationArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of this auto scaling configuration.

" - } - }, - "AutoScalingConfigurationName": { - "target": "com.amazonaws.apprunner#AutoScalingConfigurationName", - "traits": { - "smithy.api#documentation": "

The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.

" - } - }, - "AutoScalingConfigurationRevision": { - "target": "com.amazonaws.apprunner#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The revision of this auto scaling configuration. It's unique among all the active configurations (\"Status\": \"ACTIVE\") with the same\n AutoScalingConfigurationName.

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

Provides summary information about an App Runner automatic scaling configuration resource.

\n

This type contains limited information about an auto scaling configuration. It includes only identification information, without configuration\n details. It's returned by the ListAutoScalingConfigurations action. Complete configuration information is returned by the CreateAutoScalingConfiguration, DescribeAutoScalingConfiguration, and DeleteAutoScalingConfiguration\n actions using the AutoScalingConfiguration type.

" - } - }, - "com.amazonaws.apprunner#AutoScalingConfigurationSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.apprunner#AutoScalingConfigurationSummary" - } - }, - "com.amazonaws.apprunner#Boolean": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.apprunner#BuildCommand": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[^\\x0a\\x0d]+$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.apprunner#CertificateValidationRecord": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.apprunner#String", - "traits": { - "smithy.api#documentation": "

The certificate CNAME record name.

" - } - }, - "Type": { - "target": "com.amazonaws.apprunner#String", - "traits": { - "smithy.api#documentation": "

The record type, always CNAME.

" - } - }, - "Value": { - "target": "com.amazonaws.apprunner#String", - "traits": { - "smithy.api#documentation": "

The certificate CNAME record value.

" - } - }, - "Status": { - "target": "com.amazonaws.apprunner#CertificateValidationRecordStatus", - "traits": { - "smithy.api#documentation": "

The current state of the certificate CNAME record validation. It should change to SUCCESS after App Runner completes validation with your\n DNS.

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

Describes a certificate CNAME record to add to your DNS. For more information, see AssociateCustomDomain.

" - } - }, - "com.amazonaws.apprunner#CertificateValidationRecordList": { - "type": "list", - "member": { - "target": "com.amazonaws.apprunner#CertificateValidationRecord" - } - }, - "com.amazonaws.apprunner#CertificateValidationRecordStatus": { - "type": "enum", - "members": { - "PENDING_VALIDATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_VALIDATION" - } - }, - "SUCCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESS" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.apprunner#CodeConfiguration": { - "type": "structure", - "members": { - "ConfigurationSource": { - "target": "com.amazonaws.apprunner#ConfigurationSource", - "traits": { - "smithy.api#documentation": "

The source of the App Runner configuration. Values are interpreted as follows:

\n ", - "smithy.api#required": {} - } - }, - "CodeConfigurationValues": { - "target": "com.amazonaws.apprunner#CodeConfigurationValues", - "traits": { - "smithy.api#documentation": "

The basic configuration for building and running the App Runner service. Use it to quickly launch an App Runner service without providing a\n apprunner.yaml file in the source code repository (or ignoring the file if it exists).

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

Describes the configuration that App Runner uses to build and run an App Runner service from a source code repository.

" - } - }, - "com.amazonaws.apprunner#CodeConfigurationValues": { - "type": "structure", - "members": { - "Runtime": { - "target": "com.amazonaws.apprunner#Runtime", - "traits": { - "smithy.api#documentation": "

A runtime environment type for building and running an App Runner service.\n It represents a\n programming language runtime.

", - "smithy.api#required": {} - } - }, - "BuildCommand": { - "target": "com.amazonaws.apprunner#BuildCommand", - "traits": { - "smithy.api#documentation": "

The command App Runner runs to build your application.

" - } - }, - "StartCommand": { - "target": "com.amazonaws.apprunner#StartCommand", - "traits": { - "smithy.api#documentation": "

The command App Runner runs to start your application.

" - } - }, - "Port": { - "target": "com.amazonaws.apprunner#String", - "traits": { - "smithy.api#documentation": "

The port that your application listens to in the container.

\n

Default: 8080\n

" - } - }, - "RuntimeEnvironmentVariables": { - "target": "com.amazonaws.apprunner#RuntimeEnvironmentVariables", - "traits": { - "smithy.api#documentation": "

The environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of\n AWSAPPRUNNER are reserved for system use and aren't valid.

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

Describes the basic configuration needed for building and running an App Runner service. This type doesn't support the full set of possible\n configuration options. Fur full configuration capabilities, use a apprunner.yaml file in the source code repository.

" - } - }, - "com.amazonaws.apprunner#CodeRepository": { - "type": "structure", - "members": { - "RepositoryUrl": { - "target": "com.amazonaws.apprunner#String", - "traits": { - "smithy.api#documentation": "

The location of the repository that contains the source code.

", - "smithy.api#required": {} - } - }, - "SourceCodeVersion": { - "target": "com.amazonaws.apprunner#SourceCodeVersion", - "traits": { - "smithy.api#documentation": "

The version that should be used within the source code repository.

", - "smithy.api#required": {} - } - }, - "CodeConfiguration": { - "target": "com.amazonaws.apprunner#CodeConfiguration", - "traits": { - "smithy.api#documentation": "

Configuration for building and running the service from a source code repository.

\n \n

\n CodeConfiguration is required only for CreateService request.

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

Describes a source code repository.

" - } - }, - "com.amazonaws.apprunner#ConfigurationSource": { - "type": "enum", - "members": { - "REPOSITORY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REPOSITORY" - } - }, - "API": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "API" - } - } - } - }, - "com.amazonaws.apprunner#Connection": { - "type": "structure", - "members": { - "ConnectionName": { - "target": "com.amazonaws.apprunner#ConnectionName", - "traits": { - "smithy.api#documentation": "

The customer-provided connection name.

" - } - }, - "ConnectionArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of this connection.

" - } - }, - "ProviderType": { - "target": "com.amazonaws.apprunner#ProviderType", - "traits": { - "smithy.api#documentation": "

The source repository provider.

" - } - }, - "Status": { - "target": "com.amazonaws.apprunner#ConnectionStatus", - "traits": { - "smithy.api#documentation": "

The current state of the App Runner connection. When the state is AVAILABLE, you can use the connection to create an App Runner service.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.apprunner#Timestamp", - "traits": { - "smithy.api#documentation": "

The App Runner connection creation time, expressed as a Unix time stamp.

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

Describes an App Runner connection resource.

" - } - }, - "com.amazonaws.apprunner#ConnectionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 4, - "max": 32 - }, - "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9\\-_]{3,31}$" - } - }, - "com.amazonaws.apprunner#ConnectionStatus": { - "type": "enum", - "members": { - "PENDING_HANDSHAKE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_HANDSHAKE" - } - }, - "AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVAILABLE" - } - }, - "ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ERROR" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - } - } - }, - "com.amazonaws.apprunner#ConnectionSummary": { - "type": "structure", - "members": { - "ConnectionName": { - "target": "com.amazonaws.apprunner#ConnectionName", - "traits": { - "smithy.api#documentation": "

The customer-provided connection name.

" - } - }, - "ConnectionArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of this connection.

" - } - }, - "ProviderType": { - "target": "com.amazonaws.apprunner#ProviderType", - "traits": { - "smithy.api#documentation": "

The source repository provider.

" - } - }, - "Status": { - "target": "com.amazonaws.apprunner#ConnectionStatus", - "traits": { - "smithy.api#documentation": "

The current state of the App Runner connection. When the state is AVAILABLE, you can use the connection to create an App Runner service.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.apprunner#Timestamp", - "traits": { - "smithy.api#documentation": "

The App Runner connection creation time, expressed as a Unix time stamp.

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

Provides summary information about an App Runner connection resource.

" - } - }, - "com.amazonaws.apprunner#ConnectionSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.apprunner#ConnectionSummary" - } - }, - "com.amazonaws.apprunner#Cpu": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 4, - "max": 6 - }, - "smithy.api#pattern": "^1024|2048|(1|2) vCPU$" - } - }, - "com.amazonaws.apprunner#CreateAutoScalingConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#CreateAutoScalingConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#CreateAutoScalingConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#ServiceQuotaExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

Create an App Runner automatic scaling configuration resource. App Runner requires this resource when you create or update App Runner services and you require\n non-default auto scaling settings. You can share an auto scaling configuration across multiple services.

\n

Create multiple revisions of a configuration by calling this action multiple times using the same AutoScalingConfigurationName. The call\n returns incremental AutoScalingConfigurationRevision values. When you create a service and configure an auto scaling configuration resource,\n the service uses the latest active revision of the auto scaling configuration by default. You can optionally configure the service to use a specific\n revision.

\n

Configure a higher MinSize to increase the spread of your App Runner service over more Availability Zones in the Amazon Web Services Region. The tradeoff is\n a higher minimal cost.

\n

Configure a lower MaxSize to control your cost. The tradeoff is lower responsiveness during peak demand.

" - } - }, - "com.amazonaws.apprunner#CreateAutoScalingConfigurationRequest": { - "type": "structure", - "members": { - "AutoScalingConfigurationName": { - "target": "com.amazonaws.apprunner#AutoScalingConfigurationName", - "traits": { - "smithy.api#documentation": "

A name for the auto scaling configuration. When you use it for the first time in an Amazon Web Services Region, App Runner creates revision number 1 of this\n name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.

\n \n

The name DefaultConfiguration is reserved (it's the configuration that App Runner uses if you don't provide a custome one). You can't use it\n to create a new auto scaling configuration, and you can't create a revision of it.

\n

When you want to use your own auto scaling configuration for your App Runner service, create a configuration with a different name,\n and then provide it when you create or update your service.

\n ", - "smithy.api#required": {} - } - }, - "MaxConcurrency": { - "target": "com.amazonaws.apprunner#ASConfigMaxConcurrency", - "traits": { - "smithy.api#documentation": "

The maximum number of concurrent requests that you want an instance to process. If the number of concurrent requests exceeds this limit, App Runner scales\n up your service.

\n

Default: 100\n

" - } - }, - "MinSize": { - "target": "com.amazonaws.apprunner#ASConfigMinSize", - "traits": { - "smithy.api#documentation": "

The minimum number of instances that App Runner provisions for your service. The service always has at least MinSize provisioned instances.\n Some of them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to\n be quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.

\n

App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.

\n

Default: 1\n

" - } - }, - "MaxSize": { - "target": "com.amazonaws.apprunner#ASConfigMaxSize", - "traits": { - "smithy.api#documentation": "

The maximum number of instances that your service scales up to. At most MaxSize instances actively serve traffic for your service.

\n

Default: 25\n

" - } - }, - "Tags": { - "target": "com.amazonaws.apprunner#TagList", - "traits": { - "smithy.api#documentation": "

A list of metadata items that you can associate with your auto scaling configuration resource. A tag is a key-value pair.

" - } - } - } - }, - "com.amazonaws.apprunner#CreateAutoScalingConfigurationResponse": { - "type": "structure", - "members": { - "AutoScalingConfiguration": { - "target": "com.amazonaws.apprunner#AutoScalingConfiguration", - "traits": { - "smithy.api#documentation": "

A description of the App Runner auto scaling configuration that's created by this request.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#CreateConnection": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#CreateConnectionRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#CreateConnectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#ServiceQuotaExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

Create an App Runner connection resource. App Runner requires a connection resource when you create App Runner services that access private repositories from\n certain third-party providers. You can share a connection across multiple services.

\n

A connection resource is needed to access GitHub repositories. GitHub requires a user interface approval process through the App Runner console before you\n can use the connection.

" - } - }, - "com.amazonaws.apprunner#CreateConnectionRequest": { - "type": "structure", - "members": { - "ConnectionName": { - "target": "com.amazonaws.apprunner#ConnectionName", - "traits": { - "smithy.api#documentation": "

A name for the new connection. It must be unique across all App Runner connections for the Amazon Web Services account in the Amazon Web Services Region.

", - "smithy.api#required": {} - } - }, - "ProviderType": { - "target": "com.amazonaws.apprunner#ProviderType", - "traits": { - "smithy.api#documentation": "

The source repository provider.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.apprunner#TagList", - "traits": { - "smithy.api#documentation": "

A list of metadata items that you can associate with your connection resource. A tag is a key-value pair.

" - } - } - } - }, - "com.amazonaws.apprunner#CreateConnectionResponse": { - "type": "structure", - "members": { - "Connection": { - "target": "com.amazonaws.apprunner#Connection", - "traits": { - "smithy.api#documentation": "

A description of the App Runner connection that's created by this request.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#CreateObservabilityConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#CreateObservabilityConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#CreateObservabilityConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#ServiceQuotaExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

Create an App Runner observability configuration resource. App Runner requires this resource when you create or update App Runner services and you want to enable\n non-default observability features. You can share an observability configuration across multiple services.

\n

Create multiple revisions of a configuration by calling this action multiple times using the same ObservabilityConfigurationName. The\n call returns incremental ObservabilityConfigurationRevision values. When you create a service and configure an observability configuration\n resource, the service uses the latest active revision of the observability configuration by default. You can optionally configure the service to use a\n specific revision.

\n

The observability configuration resource is designed to configure multiple features (currently one feature, tracing). This action takes optional\n parameters that describe the configuration of these features (currently one parameter, TraceConfiguration). If you don't specify a feature\n parameter, App Runner doesn't enable the feature.

" - } - }, - "com.amazonaws.apprunner#CreateObservabilityConfigurationRequest": { - "type": "structure", - "members": { - "ObservabilityConfigurationName": { - "target": "com.amazonaws.apprunner#ObservabilityConfigurationName", - "traits": { - "smithy.api#documentation": "

A name for the observability configuration. When you use it for the first time in an Amazon Web Services Region, App Runner creates revision number\n 1 of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.

\n \n

The name DefaultConfiguration is reserved. You can't use it to create a new observability configuration, and you can't create a\n revision of it.

\n

When you want to use your own observability configuration for your App Runner service, create a configuration with a different name,\n and then provide it when you create or update your service.

\n ", - "smithy.api#required": {} - } - }, - "TraceConfiguration": { - "target": "com.amazonaws.apprunner#TraceConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing.

" - } - }, - "Tags": { - "target": "com.amazonaws.apprunner#TagList", - "traits": { - "smithy.api#documentation": "

A list of metadata items that you can associate with your observability configuration resource. A tag is a key-value pair.

" - } - } - } - }, - "com.amazonaws.apprunner#CreateObservabilityConfigurationResponse": { - "type": "structure", - "members": { - "ObservabilityConfiguration": { - "target": "com.amazonaws.apprunner#ObservabilityConfiguration", - "traits": { - "smithy.api#documentation": "

A description of the App Runner observability configuration that's created by this request.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#CreateService": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#CreateServiceRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#CreateServiceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#ServiceQuotaExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

Create an App Runner service. After the service is created, the action also automatically starts a deployment.

\n

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.

" - } - }, - "com.amazonaws.apprunner#CreateServiceRequest": { - "type": "structure", - "members": { - "ServiceName": { - "target": "com.amazonaws.apprunner#ServiceName", - "traits": { - "smithy.api#documentation": "

A name for the App Runner service. It must be unique across all the running App Runner services in your Amazon Web Services account in the Amazon Web Services Region.

", - "smithy.api#required": {} - } - }, - "SourceConfiguration": { - "target": "com.amazonaws.apprunner#SourceConfiguration", - "traits": { - "smithy.api#documentation": "

The source to deploy to the App Runner service. It can be a code or an image repository.

", - "smithy.api#required": {} - } - }, - "InstanceConfiguration": { - "target": "com.amazonaws.apprunner#InstanceConfiguration", - "traits": { - "smithy.api#documentation": "

The runtime configuration of instances (scaling units) of your service.

" - } - }, - "Tags": { - "target": "com.amazonaws.apprunner#TagList", - "traits": { - "smithy.api#documentation": "

An optional list of metadata items that you can associate with the App Runner service resource. A tag is a key-value pair.

" - } - }, - "EncryptionConfiguration": { - "target": "com.amazonaws.apprunner#EncryptionConfiguration", - "traits": { - "smithy.api#documentation": "

An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs. By default,\n App Runner uses an Amazon Web Services managed key.

" - } - }, - "HealthCheckConfiguration": { - "target": "com.amazonaws.apprunner#HealthCheckConfiguration", - "traits": { - "smithy.api#documentation": "

The settings for the health check that App Runner performs to monitor the health of the App Runner service.

" - } - }, - "AutoScalingConfigurationArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service. If not provided, App Runner\n associates the latest revision of a default auto scaling configuration.

\n

Specify an ARN with a name and a revision number to associate that revision. For example:\n arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3\n

\n

Specify just the name to associate the latest revision. For example:\n arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability\n

" - } - }, - "NetworkConfiguration": { - "target": "com.amazonaws.apprunner#NetworkConfiguration", - "traits": { - "smithy.api#documentation": "

Configuration settings related to network traffic of the web application that the App Runner service runs.

" - } - }, - "ObservabilityConfiguration": { - "target": "com.amazonaws.apprunner#ServiceObservabilityConfiguration", - "traits": { - "smithy.api#documentation": "

The observability configuration of your service.

" - } - } - } - }, - "com.amazonaws.apprunner#CreateServiceResponse": { - "type": "structure", - "members": { - "Service": { - "target": "com.amazonaws.apprunner#Service", - "traits": { - "smithy.api#documentation": "

A description of the App Runner service that's created by this request.

", - "smithy.api#required": {} - } - }, - "OperationId": { - "target": "com.amazonaws.apprunner#UUID", - "traits": { - "smithy.api#documentation": "

The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track the operation's progress.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#CreateVpcConnector": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#CreateVpcConnectorRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#CreateVpcConnectorResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#ServiceQuotaExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

Create an App Runner VPC connector resource. App Runner requires this resource when you want to associate your App Runner service to a custom Amazon Virtual Private Cloud\n (Amazon VPC).

" - } - }, - "com.amazonaws.apprunner#CreateVpcConnectorRequest": { - "type": "structure", - "members": { - "VpcConnectorName": { - "target": "com.amazonaws.apprunner#VpcConnectorName", - "traits": { - "smithy.api#documentation": "

A name for the VPC connector.

", - "smithy.api#required": {} - } - }, - "Subnets": { - "target": "com.amazonaws.apprunner#StringList", - "traits": { - "smithy.api#documentation": "

A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single\n Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.

\n \n

\n App Runner currently only provides support for IPv4.\n

\n ", - "smithy.api#required": {} - } - }, - "SecurityGroups": { - "target": "com.amazonaws.apprunner#StringList", - "traits": { - "smithy.api#documentation": "

A list of IDs of security groups that App Runner should use for access to Amazon Web Services resources under the specified subnets. If not specified, App Runner uses the\n default security group of the Amazon VPC. The default security group allows all outbound traffic.

" - } - }, - "Tags": { - "target": "com.amazonaws.apprunner#TagList", - "traits": { - "smithy.api#documentation": "

A list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.

" - } - } - } - }, - "com.amazonaws.apprunner#CreateVpcConnectorResponse": { - "type": "structure", - "members": { - "VpcConnector": { - "target": "com.amazonaws.apprunner#VpcConnector", - "traits": { - "smithy.api#documentation": "

A description of the App Runner VPC connector that's created by this request.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#CreateVpcIngressConnection": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#CreateVpcIngressConnectionRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#CreateVpcIngressConnectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#InvalidStateException" - }, - { - "target": "com.amazonaws.apprunner#ServiceQuotaExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

Create an App Runner VPC Ingress Connection resource. App Runner requires this resource when you want to associate your App Runner service with an Amazon VPC endpoint.

" - } - }, - "com.amazonaws.apprunner#CreateVpcIngressConnectionRequest": { - "type": "structure", - "members": { - "ServiceArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.

", - "smithy.api#required": {} - } - }, - "VpcIngressConnectionName": { - "target": "com.amazonaws.apprunner#VpcIngressConnectionName", - "traits": { - "smithy.api#documentation": "

A name for the VPC Ingress Connection resource. It must be unique across all the active VPC Ingress Connections in your Amazon Web Services account in the Amazon Web Services Region.\n

", - "smithy.api#required": {} - } - }, - "IngressVpcConfiguration": { - "target": "com.amazonaws.apprunner#IngressVpcConfiguration", - "traits": { - "smithy.api#documentation": "

Specifications for the customerā€™s Amazon VPC and the related Amazon Web Services PrivateLink VPC endpoint that are used to create the VPC Ingress Connection\n resource.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.apprunner#TagList", - "traits": { - "smithy.api#documentation": "

An optional list of metadata items that you can associate with the VPC Ingress Connection resource. A tag is a key-value pair.

" - } - } - } - }, - "com.amazonaws.apprunner#CreateVpcIngressConnectionResponse": { - "type": "structure", - "members": { - "VpcIngressConnection": { - "target": "com.amazonaws.apprunner#VpcIngressConnection", - "traits": { - "smithy.api#documentation": "

A description of the App Runner VPC Ingress Connection resource that's created by this request.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#CustomDomain": { - "type": "structure", - "members": { - "DomainName": { - "target": "com.amazonaws.apprunner#DomainName", - "traits": { - "smithy.api#documentation": "

An associated custom domain endpoint. It can be a root domain (for example, example.com), a subdomain (for example,\n login.example.com or admin.login.example.com), or a wildcard (for example, *.example.com).

", - "smithy.api#required": {} - } - }, - "EnableWWWSubdomain": { - "target": "com.amazonaws.apprunner#NullableBoolean", - "traits": { - "smithy.api#documentation": "

When true, the subdomain www.DomainName\n is associated with the App Runner service in addition to the base\n domain.

", - "smithy.api#required": {} - } - }, - "CertificateValidationRecords": { - "target": "com.amazonaws.apprunner#CertificateValidationRecordList", - "traits": { - "smithy.api#documentation": "

A list of certificate CNAME records that's used for this domain name.

" - } - }, - "Status": { - "target": "com.amazonaws.apprunner#CustomDomainAssociationStatus", - "traits": { - "smithy.api#documentation": "

The current state of the domain name association.

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

Describes a custom domain that's associated with an App Runner service.

" - } - }, - "com.amazonaws.apprunner#CustomDomainAssociationStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "CREATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_FAILED" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_FAILED" - } - }, - "PENDING_CERTIFICATE_DNS_VALIDATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_CERTIFICATE_DNS_VALIDATION" - } - }, - "BINDING_CERTIFICATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BINDING_CERTIFICATE" - } - } - } - }, - "com.amazonaws.apprunner#CustomDomainList": { - "type": "list", - "member": { - "target": "com.amazonaws.apprunner#CustomDomain" - } - }, - "com.amazonaws.apprunner#CustomerAccountId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 12, - "max": 12 - }, - "smithy.api#pattern": "^[0-9]{12}$" - } - }, - "com.amazonaws.apprunner#DeleteAutoScalingConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#DeleteAutoScalingConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#DeleteAutoScalingConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Delete an App Runner automatic scaling configuration resource. You can delete a specific revision or the latest active revision. You can't delete a\n configuration that's used by one or more App Runner services.

" - } - }, - "com.amazonaws.apprunner#DeleteAutoScalingConfigurationRequest": { - "type": "structure", - "members": { - "AutoScalingConfigurationArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want to delete.

\n

The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either .../name\n or\n .../name/revision\n . If a revision isn't specified, the latest active revision is deleted.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#DeleteAutoScalingConfigurationResponse": { - "type": "structure", - "members": { - "AutoScalingConfiguration": { - "target": "com.amazonaws.apprunner#AutoScalingConfiguration", - "traits": { - "smithy.api#documentation": "

A description of the App Runner auto scaling configuration that this request just deleted.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#DeleteConnection": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#DeleteConnectionRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#DeleteConnectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Delete an App Runner connection. You must first ensure that there are no running App Runner services that use this connection. If there are any, the\n DeleteConnection action fails.

" - } - }, - "com.amazonaws.apprunner#DeleteConnectionRequest": { - "type": "structure", - "members": { - "ConnectionArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner connection that you want to delete.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#DeleteConnectionResponse": { - "type": "structure", - "members": { - "Connection": { - "target": "com.amazonaws.apprunner#Connection", - "traits": { - "smithy.api#documentation": "

A description of the App Runner connection that this request just deleted.

" - } - } - } - }, - "com.amazonaws.apprunner#DeleteObservabilityConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#DeleteObservabilityConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#DeleteObservabilityConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Delete an App Runner observability configuration resource. You can delete a specific revision or the latest active revision. You can't delete a\n configuration that's used by one or more App Runner services.

" - } - }, - "com.amazonaws.apprunner#DeleteObservabilityConfigurationRequest": { - "type": "structure", - "members": { - "ObservabilityConfigurationArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner observability configuration that you want to delete.

\n

The ARN can be a full observability configuration ARN, or a partial ARN ending with either .../name\n or\n .../name/revision\n . If a revision isn't specified, the latest active revision is deleted.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#DeleteObservabilityConfigurationResponse": { - "type": "structure", - "members": { - "ObservabilityConfiguration": { - "target": "com.amazonaws.apprunner#ObservabilityConfiguration", - "traits": { - "smithy.api#documentation": "

A description of the App Runner observability configuration that this request just deleted.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#DeleteService": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#DeleteServiceRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#DeleteServiceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#InvalidStateException" - }, - { - "target": "com.amazonaws.apprunner#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Delete an App Runner service.

\n

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations\n call to track the operation's progress.

\n \n

Make sure that you don't have any active VPCIngressConnections associated with the service you want to delete. \n

\n " - } - }, - "com.amazonaws.apprunner#DeleteServiceRequest": { - "type": "structure", - "members": { - "ServiceArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner service that you want to delete.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#DeleteServiceResponse": { - "type": "structure", - "members": { - "Service": { - "target": "com.amazonaws.apprunner#Service", - "traits": { - "smithy.api#documentation": "

A description of the App Runner service that this request just deleted.

", - "smithy.api#required": {} - } - }, - "OperationId": { - "target": "com.amazonaws.apprunner#UUID", - "traits": { - "smithy.api#documentation": "

The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track\n the operation's progress.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#DeleteVpcConnector": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#DeleteVpcConnectorRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#DeleteVpcConnectorResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Delete an App Runner VPC connector resource. You can't delete a\n connector that's used by one or more App Runner services.

" - } - }, - "com.amazonaws.apprunner#DeleteVpcConnectorRequest": { - "type": "structure", - "members": { - "VpcConnectorArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to delete.

\n

The ARN must be a full VPC connector ARN.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#DeleteVpcConnectorResponse": { - "type": "structure", - "members": { - "VpcConnector": { - "target": "com.amazonaws.apprunner#VpcConnector", - "traits": { - "smithy.api#documentation": "

A description of the App Runner VPC connector that this request just deleted.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#DeleteVpcIngressConnection": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#DeleteVpcIngressConnectionRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#DeleteVpcIngressConnectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#InvalidStateException" - }, - { - "target": "com.amazonaws.apprunner#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Delete an App Runner VPC Ingress Connection resource that's associated with an App Runner service. The VPC Ingress Connection must be in one of the following states to be deleted:\n

\n " - } - }, - "com.amazonaws.apprunner#DeleteVpcIngressConnectionRequest": { - "type": "structure", - "members": { - "VpcIngressConnectionArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that you want to delete.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#DeleteVpcIngressConnectionResponse": { - "type": "structure", - "members": { - "VpcIngressConnection": { - "target": "com.amazonaws.apprunner#VpcIngressConnection", - "traits": { - "smithy.api#documentation": "

A description of the App Runner VPC Ingress Connection that this request just deleted.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#DescribeAutoScalingConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#DescribeAutoScalingConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#DescribeAutoScalingConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Return a full description of an App Runner automatic scaling configuration resource.

" - } - }, - "com.amazonaws.apprunner#DescribeAutoScalingConfigurationRequest": { - "type": "structure", - "members": { - "AutoScalingConfigurationArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want a description for.

\n

The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either .../name\n or\n .../name/revision\n . If a revision isn't specified, the latest active revision is\n described.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#DescribeAutoScalingConfigurationResponse": { - "type": "structure", - "members": { - "AutoScalingConfiguration": { - "target": "com.amazonaws.apprunner#AutoScalingConfiguration", - "traits": { - "smithy.api#documentation": "

A full description of the App Runner auto scaling configuration that you specified in this request.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#DescribeCustomDomains": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#DescribeCustomDomainsRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#DescribeCustomDomainsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Return a description of custom domain names that are associated with an App Runner service.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.apprunner#DescribeCustomDomainsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.apprunner#DescribeCustomDomainsRequest": { - "type": "structure", - "members": { - "ServiceArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner service that you want associated custom domain names to be described for.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.apprunner#String", - "traits": { - "smithy.api#documentation": "

A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be\n identical to the ones that are specified in the initial request.

\n

If you don't specify NextToken, the request retrieves the first result page.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.apprunner#DescribeCustomDomainsMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results that each response (result page) can include. It's used for a paginated request.

\n

If you don't specify MaxResults, the request retrieves all available results in a single response.

" - } - } - } - }, - "com.amazonaws.apprunner#DescribeCustomDomainsResponse": { - "type": "structure", - "members": { - "DNSTarget": { - "target": "com.amazonaws.apprunner#String", - "traits": { - "smithy.api#documentation": "

The App Runner subdomain of the App Runner service. The associated custom domain names are mapped to this target name.

", - "smithy.api#required": {} - } - }, - "ServiceArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner service whose associated custom domain names you want to describe.

", - "smithy.api#required": {} - } - }, - "CustomDomains": { - "target": "com.amazonaws.apprunner#CustomDomainList", - "traits": { - "smithy.api#documentation": "

A list of descriptions of custom domain names that are associated with the service. In a paginated request, the request returns up to\n MaxResults records per call.

", - "smithy.api#required": {} - } - }, - "VpcDNSTargets": { - "target": "com.amazonaws.apprunner#VpcDNSTargetList", - "traits": { - "smithy.api#documentation": "

DNS Target records for the custom domains of this Amazon VPC.\n

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.apprunner#String", - "traits": { - "smithy.api#documentation": "

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

" - } - } - } - }, - "com.amazonaws.apprunner#DescribeObservabilityConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#DescribeObservabilityConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#DescribeObservabilityConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Return a full description of an App Runner observability configuration resource.

" - } - }, - "com.amazonaws.apprunner#DescribeObservabilityConfigurationRequest": { - "type": "structure", - "members": { - "ObservabilityConfigurationArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner observability configuration that you want a description for.

\n

The ARN can be a full observability configuration ARN, or a partial ARN ending with either .../name\n or\n .../name/revision\n . If a revision isn't specified, the latest active revision is\n described.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#DescribeObservabilityConfigurationResponse": { - "type": "structure", - "members": { - "ObservabilityConfiguration": { - "target": "com.amazonaws.apprunner#ObservabilityConfiguration", - "traits": { - "smithy.api#documentation": "

A full description of the App Runner observability configuration that you specified in this request.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#DescribeService": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#DescribeServiceRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#DescribeServiceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Return a full description of an App Runner service.

" - } - }, - "com.amazonaws.apprunner#DescribeServiceRequest": { - "type": "structure", - "members": { - "ServiceArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner service that you want a description for.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#DescribeServiceResponse": { - "type": "structure", - "members": { - "Service": { - "target": "com.amazonaws.apprunner#Service", - "traits": { - "smithy.api#documentation": "

A full description of the App Runner service that you specified in this request.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#DescribeVpcConnector": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#DescribeVpcConnectorRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#DescribeVpcConnectorResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Return a description of an App Runner VPC connector resource.

" - } - }, - "com.amazonaws.apprunner#DescribeVpcConnectorRequest": { - "type": "structure", - "members": { - "VpcConnectorArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner VPC connector that you want a description for.

\n

The ARN must be a full VPC connector ARN.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#DescribeVpcConnectorResponse": { - "type": "structure", - "members": { - "VpcConnector": { - "target": "com.amazonaws.apprunner#VpcConnector", - "traits": { - "smithy.api#documentation": "

A description of the App Runner VPC connector that you specified in this request.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#DescribeVpcIngressConnection": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#DescribeVpcIngressConnectionRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#DescribeVpcIngressConnectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Return a full description of an App Runner VPC Ingress Connection resource.

" - } - }, - "com.amazonaws.apprunner#DescribeVpcIngressConnectionRequest": { - "type": "structure", - "members": { - "VpcIngressConnectionArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that you want a description for.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#DescribeVpcIngressConnectionResponse": { - "type": "structure", - "members": { - "VpcIngressConnection": { - "target": "com.amazonaws.apprunner#VpcIngressConnection", - "traits": { - "smithy.api#documentation": "

A description of the App Runner VPC Ingress Connection that you specified in this request.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#DisassociateCustomDomain": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#DisassociateCustomDomainRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#DisassociateCustomDomainResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#InvalidStateException" - }, - { - "target": "com.amazonaws.apprunner#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Disassociate a custom domain name from an App Runner service.

\n

Certificates tracking domain validity are associated with a custom domain and are stored in AWS\n Certificate Manager (ACM). These certificates aren't deleted as part of this action. App Runner delays certificate deletion for\n 30 days after a domain is disassociated from your service.

" - } - }, - "com.amazonaws.apprunner#DisassociateCustomDomainRequest": { - "type": "structure", - "members": { - "ServiceArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner service that you want to disassociate a custom domain name from.

", - "smithy.api#required": {} - } - }, - "DomainName": { - "target": "com.amazonaws.apprunner#DomainName", - "traits": { - "smithy.api#documentation": "

The domain name that you want to disassociate from the App Runner service.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#DisassociateCustomDomainResponse": { - "type": "structure", - "members": { - "DNSTarget": { - "target": "com.amazonaws.apprunner#String", - "traits": { - "smithy.api#documentation": "

The App Runner subdomain of the App Runner service. The disassociated custom domain name was mapped to this target name.

", - "smithy.api#required": {} - } - }, - "ServiceArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner service that a custom domain name is disassociated from.

", - "smithy.api#required": {} - } - }, - "CustomDomain": { - "target": "com.amazonaws.apprunner#CustomDomain", - "traits": { - "smithy.api#documentation": "

A description of the domain name that's being disassociated.

", - "smithy.api#required": {} - } - }, - "VpcDNSTargets": { - "target": "com.amazonaws.apprunner#VpcDNSTargetList", - "traits": { - "smithy.api#documentation": "

DNS Target records for the custom domains of this Amazon VPC.\n

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#DomainName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[A-Za-z0-9*.-]{1,255}$" - } - }, - "com.amazonaws.apprunner#EgressConfiguration": { - "type": "structure", - "members": { - "EgressType": { - "target": "com.amazonaws.apprunner#EgressType", - "traits": { - "smithy.api#documentation": "

The type of egress configuration.

\n

Set to DEFAULT for access to resources hosted on public networks.

\n

Set to VPC to associate your service to a custom VPC specified by VpcConnectorArn.

" - } - }, - "VpcConnectorArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to associate with your App Runner service. Only valid when EgressType =\n VPC.

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

Describes configuration settings related to outbound network traffic of an App Runner service.

" - } - }, - "com.amazonaws.apprunner#EgressType": { - "type": "enum", - "members": { - "DEFAULT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEFAULT" - } - }, - "VPC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VPC" - } - } - } - }, - "com.amazonaws.apprunner#EncryptionConfiguration": { - "type": "structure", - "members": { - "KmsKey": { - "target": "com.amazonaws.apprunner#KmsKeyArn", - "traits": { - "smithy.api#documentation": "

The ARN of the KMS key that's used for encryption.

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

Describes a custom encryption key that App Runner uses to encrypt copies of the source repository and service logs.

" - } - }, - "com.amazonaws.apprunner#ErrorMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 600 - } - } - }, - "com.amazonaws.apprunner#HealthCheckConfiguration": { - "type": "structure", - "members": { - "Protocol": { - "target": "com.amazonaws.apprunner#HealthCheckProtocol", - "traits": { - "smithy.api#documentation": "

The IP protocol that App Runner uses to perform health checks for your service.

\n

If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.

\n

Default: TCP\n

" - } - }, - "Path": { - "target": "com.amazonaws.apprunner#HealthCheckPath", - "traits": { - "smithy.api#documentation": "

The URL that health check requests are sent to.

\n

\n Path is only applicable when you set Protocol to HTTP.

\n

Default: \"/\"\n

" - } - }, - "Interval": { - "target": "com.amazonaws.apprunner#HealthCheckInterval", - "traits": { - "smithy.api#documentation": "

The time interval, in seconds, between health checks.

\n

Default: 5\n

" - } - }, - "Timeout": { - "target": "com.amazonaws.apprunner#HealthCheckTimeout", - "traits": { - "smithy.api#documentation": "

The time, in seconds, to wait for a health check response before deciding it failed.

\n

Default: 2\n

" - } - }, - "HealthyThreshold": { - "target": "com.amazonaws.apprunner#HealthCheckHealthyThreshold", - "traits": { - "smithy.api#documentation": "

The number of consecutive checks that must succeed before App Runner decides that the service is healthy.

\n

Default: 1\n

" - } - }, - "UnhealthyThreshold": { - "target": "com.amazonaws.apprunner#HealthCheckUnhealthyThreshold", - "traits": { - "smithy.api#documentation": "

The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.

\n

Default: 5\n

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

Describes the settings for the health check that App Runner performs to monitor the health of a service.

" - } - }, - "com.amazonaws.apprunner#HealthCheckHealthyThreshold": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.apprunner#HealthCheckInterval": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.apprunner#HealthCheckPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.apprunner#HealthCheckProtocol": { - "type": "enum", - "members": { - "TCP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TCP" - } - }, - "HTTP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTP" - } - } - } - }, - "com.amazonaws.apprunner#HealthCheckTimeout": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.apprunner#HealthCheckUnhealthyThreshold": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.apprunner#ImageConfiguration": { - "type": "structure", - "members": { - "RuntimeEnvironmentVariables": { - "target": "com.amazonaws.apprunner#RuntimeEnvironmentVariables", - "traits": { - "smithy.api#documentation": "

Environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of AWSAPPRUNNER\n are reserved for system use and aren't valid.

" - } - }, - "StartCommand": { - "target": "com.amazonaws.apprunner#StartCommand", - "traits": { - "smithy.api#documentation": "

An optional command that App Runner runs to start the application in the source image. If specified, this command overrides the Docker imageā€™s default start\n command.

" - } - }, - "Port": { - "target": "com.amazonaws.apprunner#String", - "traits": { - "smithy.api#documentation": "

The port that your application listens to in the container.

\n

Default: 8080\n

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

Describes the configuration that App Runner uses to run an App Runner service using an image pulled from a source image repository.

" - } - }, - "com.amazonaws.apprunner#ImageIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^([0-9]{12}.dkr.ecr.[a-z\\-]+-[0-9]{1}.amazonaws.com\\/((?:[a-z0-9]+(?:[._-][a-z0-9]+)*\\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)(:([\\w\\d+\\-=._:\\/@])+|@([\\w\\d\\:]+))?)|(^public\\.ecr\\.aws\\/.+\\/((?:[a-z0-9]+(?:[._-][a-z0-9]+)*\\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)(:([\\w\\d+\\-=._:\\/@])+|@([\\w\\d\\:]+))?)$" - } - }, - "com.amazonaws.apprunner#ImageRepository": { - "type": "structure", - "members": { - "ImageIdentifier": { - "target": "com.amazonaws.apprunner#ImageIdentifier", - "traits": { - "smithy.api#documentation": "

The identifier of an image.

\n

For an image in Amazon Elastic Container Registry (Amazon ECR), this is an image name. For the image name format, see Pulling an image in the Amazon ECR User Guide.

", - "smithy.api#required": {} - } - }, - "ImageConfiguration": { - "target": "com.amazonaws.apprunner#ImageConfiguration", - "traits": { - "smithy.api#documentation": "

Configuration for running the identified image.

" - } - }, - "ImageRepositoryType": { - "target": "com.amazonaws.apprunner#ImageRepositoryType", - "traits": { - "smithy.api#documentation": "

The type of the image repository. This reflects the repository provider and whether the repository is private or public.

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

Describes a source image repository.

" - } - }, - "com.amazonaws.apprunner#ImageRepositoryType": { - "type": "enum", - "members": { - "ECR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ECR" - } - }, - "ECR_PUBLIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ECR_PUBLIC" - } - } - } - }, - "com.amazonaws.apprunner#IngressConfiguration": { - "type": "structure", - "members": { - "IsPubliclyAccessible": { - "target": "com.amazonaws.apprunner#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether your App Runner service is publicly accessible. To make the service publicly accessible set it to True. To make the service\n privately accessible, from only within an Amazon VPC set it to False.

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

Network configuration settings for inbound network traffic.

" - } - }, - "com.amazonaws.apprunner#IngressVpcConfiguration": { - "type": "structure", - "members": { - "VpcId": { - "target": "com.amazonaws.apprunner#String", - "traits": { - "smithy.api#documentation": "

The ID of the VPC that is used for the VPC endpoint.

" - } - }, - "VpcEndpointId": { - "target": "com.amazonaws.apprunner#String", - "traits": { - "smithy.api#documentation": "

The ID of the VPC endpoint that your App Runner service connects to.\n

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

The configuration of your VPC and the associated VPC endpoint. The VPC endpoint is an Amazon Web Services PrivateLink resource that allows access to your App Runner\n services from within an Amazon VPC.

" - } - }, - "com.amazonaws.apprunner#InstanceConfiguration": { - "type": "structure", - "members": { - "Cpu": { - "target": "com.amazonaws.apprunner#Cpu", - "traits": { - "smithy.api#documentation": "

The number of CPU units reserved for each instance of your App Runner service.

\n

Default: 1 vCPU\n

" - } - }, - "Memory": { - "target": "com.amazonaws.apprunner#Memory", - "traits": { - "smithy.api#documentation": "

The amount of memory, in MB or GB, reserved for each instance of your App Runner service.

\n

Default: 2 GB\n

" - } - }, - "InstanceRoleArn": { - "target": "com.amazonaws.apprunner#RoleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that provides permissions to your App Runner service. These are permissions that your code needs when it calls\n any Amazon Web Services APIs.

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

Describes the runtime configuration of an App Runner service instance (scaling unit).

" - } - }, - "com.amazonaws.apprunner#Integer": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.apprunner#InternalServiceErrorException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.apprunner#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InternalServiceError", - "httpResponseCode": 500 - }, - "smithy.api#documentation": "

An unexpected service exception occurred.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.apprunner#InvalidRequestException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.apprunner#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidRequest", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.apprunner#InvalidStateException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.apprunner#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidState", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

You can't perform this action when the resource is in its current state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.apprunner#KmsKeyArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws(-[\\w]+)*:kms:[a-z\\-]+-[0-9]{1}:[0-9]{12}:key\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" - } - }, - "com.amazonaws.apprunner#ListAutoScalingConfigurations": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#ListAutoScalingConfigurationsRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#ListAutoScalingConfigurationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of active App Runner automatic scaling configurations in your Amazon Web Services account. You can query the revisions for a specific\n configuration name or the revisions for all active configurations in your account. You can optionally query only the latest revision of each requested\n name.

\n

To retrieve a full description of a particular configuration revision, call and provide one of\n the ARNs returned by ListAutoScalingConfigurations.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.apprunner#ListAutoScalingConfigurationsRequest": { - "type": "structure", - "members": { - "AutoScalingConfigurationName": { - "target": "com.amazonaws.apprunner#AutoScalingConfigurationName", - "traits": { - "smithy.api#documentation": "

The name of the App Runner auto scaling configuration that you want to list. If specified, App Runner lists revisions that share this name. If not specified, App Runner\n returns revisions of all active configurations.

" - } - }, - "LatestOnly": { - "target": "com.amazonaws.apprunner#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Set to true to list only the latest revision for each requested configuration name.

\n

Set to false to list all revisions for each requested configuration name.

\n

Default: true\n

" - } - }, - "MaxResults": { - "target": "com.amazonaws.apprunner#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to include in each response (result page). It's used for a paginated request.

\n

If you don't specify MaxResults, the request retrieves all available results in a single response.

" - } - }, - "NextToken": { - "target": "com.amazonaws.apprunner#NextToken", - "traits": { - "smithy.api#documentation": "

A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be\n identical to the ones that are specified in the initial request.

\n

If you don't specify NextToken, the request retrieves the first result page.

" - } - } - } - }, - "com.amazonaws.apprunner#ListAutoScalingConfigurationsResponse": { - "type": "structure", - "members": { - "AutoScalingConfigurationSummaryList": { - "target": "com.amazonaws.apprunner#AutoScalingConfigurationSummaryList", - "traits": { - "smithy.api#documentation": "

A list of summary information records for auto scaling configurations. In a paginated request, the request returns up to MaxResults\n records for each call.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.apprunner#NextToken", - "traits": { - "smithy.api#documentation": "

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

" - } - } - } - }, - "com.amazonaws.apprunner#ListConnections": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#ListConnectionsRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#ListConnectionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of App Runner connections that are associated with your Amazon Web Services account.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.apprunner#ListConnectionsRequest": { - "type": "structure", - "members": { - "ConnectionName": { - "target": "com.amazonaws.apprunner#ConnectionName", - "traits": { - "smithy.api#documentation": "

If specified, only this connection is returned. If not specified, the result isn't filtered by name.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.apprunner#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to include in each response (result page). Used for a paginated request.

\n

If you don't specify MaxResults, the request retrieves all available results in a single response.

" - } - }, - "NextToken": { - "target": "com.amazonaws.apprunner#NextToken", - "traits": { - "smithy.api#documentation": "

A token from a previous result page. Used for a paginated request. The request retrieves the next result page. All other parameter values must be\n identical to the ones specified in the initial request.

\n

If you don't specify NextToken, the request retrieves the first result page.

" - } - } - } - }, - "com.amazonaws.apprunner#ListConnectionsResponse": { - "type": "structure", - "members": { - "ConnectionSummaryList": { - "target": "com.amazonaws.apprunner#ConnectionSummaryList", - "traits": { - "smithy.api#documentation": "

A list of summary information records for connections. In a paginated request, the request returns up to MaxResults records for each\n call.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.apprunner#NextToken", - "traits": { - "smithy.api#documentation": "

The token that you can pass in a subsequent request to get the next result page. Returned in a paginated request.

" - } - } - } - }, - "com.amazonaws.apprunner#ListObservabilityConfigurations": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#ListObservabilityConfigurationsRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#ListObservabilityConfigurationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of active App Runner observability configurations in your Amazon Web Services account. You can query the revisions for a specific\n configuration name or the revisions for all active configurations in your account. You can optionally query only the latest revision of each requested\n name.

\n

To retrieve a full description of a particular configuration revision, call and provide one\n of the ARNs returned by ListObservabilityConfigurations.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.apprunner#ListObservabilityConfigurationsRequest": { - "type": "structure", - "members": { - "ObservabilityConfigurationName": { - "target": "com.amazonaws.apprunner#ObservabilityConfigurationName", - "traits": { - "smithy.api#documentation": "

The name of the App Runner observability configuration that you want to list. If specified, App Runner lists revisions that share this name. If not specified,\n App Runner returns revisions of all active configurations.

" - } - }, - "LatestOnly": { - "target": "com.amazonaws.apprunner#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Set to true to list only the latest revision for each requested configuration name.

\n

Set to false to list all revisions for each requested configuration name.

\n

Default: true\n

" - } - }, - "MaxResults": { - "target": "com.amazonaws.apprunner#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to include in each response (result page). It's used for a paginated request.

\n

If you don't specify MaxResults, the request retrieves all available results in a single response.

" - } - }, - "NextToken": { - "target": "com.amazonaws.apprunner#NextToken", - "traits": { - "smithy.api#documentation": "

A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be\n identical to the ones that are specified in the initial request.

\n

If you don't specify NextToken, the request retrieves the first result page.

" - } - } - } - }, - "com.amazonaws.apprunner#ListObservabilityConfigurationsResponse": { - "type": "structure", - "members": { - "ObservabilityConfigurationSummaryList": { - "target": "com.amazonaws.apprunner#ObservabilityConfigurationSummaryList", - "traits": { - "smithy.api#documentation": "

A list of summary information records for observability configurations. In a paginated request, the request returns up to MaxResults\n records for each call.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.apprunner#NextToken", - "traits": { - "smithy.api#documentation": "

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

" - } - } - } - }, - "com.amazonaws.apprunner#ListOperations": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#ListOperationsRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#ListOperationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Return a list of operations that occurred on an App Runner service.

\n

The resulting list of OperationSummary objects is sorted in reverse chronological order. The first object on the list represents the\n last started operation.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.apprunner#ListOperationsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.apprunner#ListOperationsRequest": { - "type": "structure", - "members": { - "ServiceArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner service that you want a list of operations for.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.apprunner#String", - "traits": { - "smithy.api#documentation": "

A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be\n identical to the ones specified in the initial request.

\n

If you don't specify NextToken, the request retrieves the first result page.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.apprunner#ListOperationsMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to include in each response (result page). It's used for a paginated request.

\n

If you don't specify MaxResults, the request retrieves all available results in a single response.

" - } - } - } - }, - "com.amazonaws.apprunner#ListOperationsResponse": { - "type": "structure", - "members": { - "OperationSummaryList": { - "target": "com.amazonaws.apprunner#OperationSummaryList", - "traits": { - "smithy.api#documentation": "

A list of operation summary information records. In a paginated request, the request returns up to MaxResults records for each\n call.

" - } - }, - "NextToken": { - "target": "com.amazonaws.apprunner#String", - "traits": { - "smithy.api#documentation": "

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

" - } - } - } - }, - "com.amazonaws.apprunner#ListServices": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#ListServicesRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#ListServicesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of running App Runner services in your Amazon Web Services account.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.apprunner#ListServicesRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.apprunner#String", - "traits": { - "smithy.api#documentation": "

A token from a previous result page. Used for a paginated request. The request retrieves the next result page. All other parameter values must be\n identical to the ones specified in the initial request.

\n

If you don't specify NextToken, the request retrieves the first result page.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.apprunner#ServiceMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to include in each response (result page). It's used for a paginated request.

\n

If you don't specify MaxResults, the request retrieves all available results in a single response.

" - } - } - } - }, - "com.amazonaws.apprunner#ListServicesResponse": { - "type": "structure", - "members": { - "ServiceSummaryList": { - "target": "com.amazonaws.apprunner#ServiceSummaryList", - "traits": { - "smithy.api#documentation": "

A list of service summary information records. In a paginated request, the request returns up to MaxResults records for each call.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.apprunner#String", - "traits": { - "smithy.api#documentation": "

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

" - } - } - } - }, - "com.amazonaws.apprunner#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#InvalidStateException" - }, - { - "target": "com.amazonaws.apprunner#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

List tags that are associated with for an App Runner resource. The response contains a list of tag key-value pairs.

" - } - }, - "com.amazonaws.apprunner#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that a tag list is requested for.

\n

It must be the ARN of an App Runner resource.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.apprunner#TagList", - "traits": { - "smithy.api#documentation": "

A list of the tag key-value pairs that are associated with the resource.

" - } - } - } - }, - "com.amazonaws.apprunner#ListVpcConnectors": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#ListVpcConnectorsRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#ListVpcConnectorsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of App Runner VPC connectors in your Amazon Web Services account.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.apprunner#ListVpcConnectorsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.apprunner#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to include in each response (result page). It's used for a paginated request.

\n

If you don't specify MaxResults, the request retrieves all available results in a single response.

" - } - }, - "NextToken": { - "target": "com.amazonaws.apprunner#NextToken", - "traits": { - "smithy.api#documentation": "

A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be\n identical to the ones that are specified in the initial request.

\n

If you don't specify NextToken, the request retrieves the first result page.

" - } - } - } - }, - "com.amazonaws.apprunner#ListVpcConnectorsResponse": { - "type": "structure", - "members": { - "VpcConnectors": { - "target": "com.amazonaws.apprunner#VpcConnectors", - "traits": { - "smithy.api#documentation": "

A list of information records for VPC connectors. In a paginated request, the request returns up to MaxResults records for each\n call.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.apprunner#NextToken", - "traits": { - "smithy.api#documentation": "

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

" - } - } - } - }, - "com.amazonaws.apprunner#ListVpcIngressConnections": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#ListVpcIngressConnectionsRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#ListVpcIngressConnectionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - } - ], - "traits": { - "smithy.api#documentation": "

Return a list of App Runner VPC Ingress Connections in your Amazon Web Services account.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.apprunner#ListVpcIngressConnectionsFilter": { - "type": "structure", - "members": { - "ServiceArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a service to filter by.\n

" - } - }, - "VpcEndpointId": { - "target": "com.amazonaws.apprunner#String", - "traits": { - "smithy.api#documentation": "

The ID of a VPC Endpoint to filter by.\n

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

Returns a list of VPC Ingress Connections based on the filter provided. It can return either ServiceArn or VpcEndpointId, or both.

" - } - }, - "com.amazonaws.apprunner#ListVpcIngressConnectionsRequest": { - "type": "structure", - "members": { - "Filter": { - "target": "com.amazonaws.apprunner#ListVpcIngressConnectionsFilter", - "traits": { - "smithy.api#documentation": "

The VPC Ingress Connections to be listed based on either the Service Arn or Vpc Endpoint Id, or both.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.apprunner#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to include in each response (result page). It's used for a paginated request.

\n

If you don't specify MaxResults, the request retrieves all available results in a single response.

" - } - }, - "NextToken": { - "target": "com.amazonaws.apprunner#NextToken", - "traits": { - "smithy.api#documentation": "

A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be\n identical to the ones that are specified in the initial request.

\n

If you don't specify NextToken, the request retrieves the first result page.

" - } - } - } - }, - "com.amazonaws.apprunner#ListVpcIngressConnectionsResponse": { - "type": "structure", - "members": { - "VpcIngressConnectionSummaryList": { - "target": "com.amazonaws.apprunner#VpcIngressConnectionSummaryList", - "traits": { - "smithy.api#documentation": "

A list of summary information records for VPC Ingress Connections. In a paginated request, the request returns up to MaxResults records for each call.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.apprunner#NextToken", - "traits": { - "smithy.api#documentation": "

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

" - } - } - } - }, - "com.amazonaws.apprunner#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.apprunner#Memory": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 4, - "max": 4 - }, - "smithy.api#pattern": "^2048|3072|4096|(2|3|4) GB$" - } - }, - "com.amazonaws.apprunner#NetworkConfiguration": { - "type": "structure", - "members": { - "EgressConfiguration": { - "target": "com.amazonaws.apprunner#EgressConfiguration", - "traits": { - "smithy.api#documentation": "

Network configuration settings for outbound message traffic.

" - } - }, - "IngressConfiguration": { - "target": "com.amazonaws.apprunner#IngressConfiguration", - "traits": { - "smithy.api#documentation": "

Network configuration settings for inbound message traffic.

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

Describes configuration settings related to network traffic of an App Runner service. Consists of embedded objects for each configurable network\n feature.

" - } - }, - "com.amazonaws.apprunner#NextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.apprunner#NullableBoolean": { - "type": "boolean" - }, - "com.amazonaws.apprunner#ObservabilityConfiguration": { - "type": "structure", - "members": { - "ObservabilityConfigurationArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of this observability configuration.

" - } - }, - "ObservabilityConfigurationName": { - "target": "com.amazonaws.apprunner#ObservabilityConfigurationName", - "traits": { - "smithy.api#documentation": "

The customer-provided observability configuration name. It can be used in multiple revisions of a configuration.

" - } - }, - "TraceConfiguration": { - "target": "com.amazonaws.apprunner#TraceConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of the tracing feature within this observability configuration. If not specified, tracing isn't enabled.

" - } - }, - "ObservabilityConfigurationRevision": { - "target": "com.amazonaws.apprunner#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The revision of this observability configuration. It's unique among all the active configurations (\"Status\": \"ACTIVE\") that share the\n same ObservabilityConfigurationName.

" - } - }, - "Latest": { - "target": "com.amazonaws.apprunner#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

It's set to true for the configuration with the highest Revision among all configurations that share the same\n ObservabilityConfigurationName. It's set to false otherwise.

" - } - }, - "Status": { - "target": "com.amazonaws.apprunner#ObservabilityConfigurationStatus", - "traits": { - "smithy.api#documentation": "

The current state of the observability configuration. If the status of a configuration revision is INACTIVE, it was deleted and can't be\n used. Inactive configuration revisions are permanently removed some time after they are deleted.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.apprunner#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the observability configuration was created. It's in Unix time stamp format.

" - } - }, - "DeletedAt": { - "target": "com.amazonaws.apprunner#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the observability configuration was deleted. It's in Unix time stamp format.

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

Describes an App Runner observability configuration resource. Multiple revisions of a configuration have the same\n ObservabilityConfigurationName and different ObservabilityConfigurationRevision values.

\n

The resource is designed to configure multiple features (currently one feature, tracing). This type contains optional members that describe the\n configuration of these features (currently one member, TraceConfiguration). If a feature member isn't specified, the feature isn't\n enabled.

" - } - }, - "com.amazonaws.apprunner#ObservabilityConfigurationName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 4, - "max": 32 - }, - "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9\\-_]{3,31}$" - } - }, - "com.amazonaws.apprunner#ObservabilityConfigurationStatus": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "INACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INACTIVE" - } - } - } - }, - "com.amazonaws.apprunner#ObservabilityConfigurationSummary": { - "type": "structure", - "members": { - "ObservabilityConfigurationArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of this observability configuration.

" - } - }, - "ObservabilityConfigurationName": { - "target": "com.amazonaws.apprunner#ObservabilityConfigurationName", - "traits": { - "smithy.api#documentation": "

The customer-provided observability configuration name. It can be used in multiple revisions of a configuration.

" - } - }, - "ObservabilityConfigurationRevision": { - "target": "com.amazonaws.apprunner#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The revision of this observability configuration. It's unique among all the active configurations (\"Status\": \"ACTIVE\") that share the\n same ObservabilityConfigurationName.

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

Provides summary information about an App Runner observability configuration resource.

\n

This type contains limited information about an observability configuration. It includes only identification information, without configuration\n details. It's returned by the ListObservabilityConfigurations action. Complete configuration information is returned by the CreateObservabilityConfiguration, DescribeObservabilityConfiguration, and DeleteObservabilityConfiguration\n actions using the ObservabilityConfiguration type.

" - } - }, - "com.amazonaws.apprunner#ObservabilityConfigurationSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.apprunner#ObservabilityConfigurationSummary" - } - }, - "com.amazonaws.apprunner#OperationStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "SUCCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCEEDED" - } - }, - "ROLLBACK_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROLLBACK_IN_PROGRESS" - } - }, - "ROLLBACK_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROLLBACK_FAILED" - } - }, - "ROLLBACK_SUCCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROLLBACK_SUCCEEDED" - } - } - } - }, - "com.amazonaws.apprunner#OperationSummary": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.apprunner#UUID", - "traits": { - "smithy.api#documentation": "

A unique ID of this operation. It's unique in the scope of the App Runner service.

" - } - }, - "Type": { - "target": "com.amazonaws.apprunner#OperationType", - "traits": { - "smithy.api#documentation": "

The type of operation. It indicates a specific action that occured.

" - } - }, - "Status": { - "target": "com.amazonaws.apprunner#OperationStatus", - "traits": { - "smithy.api#documentation": "

The current state of the operation.

" - } - }, - "TargetArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that the operation acted on (for example, an App Runner service).

" - } - }, - "StartedAt": { - "target": "com.amazonaws.apprunner#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the operation started. It's in the Unix time stamp format.

" - } - }, - "EndedAt": { - "target": "com.amazonaws.apprunner#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the operation ended. It's in the Unix time stamp format.

" - } - }, - "UpdatedAt": { - "target": "com.amazonaws.apprunner#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the operation was last updated. It's in the Unix time stamp format.

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

Provides summary information for an operation that occurred on an App Runner service.

" - } - }, - "com.amazonaws.apprunner#OperationSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.apprunner#OperationSummary" - } - }, - "com.amazonaws.apprunner#OperationType": { - "type": "enum", - "members": { - "START_DEPLOYMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "START_DEPLOYMENT" - } - }, - "CREATE_SERVICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_SERVICE" - } - }, - "PAUSE_SERVICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PAUSE_SERVICE" - } - }, - "RESUME_SERVICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESUME_SERVICE" - } - }, - "DELETE_SERVICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_SERVICE" - } - } - } - }, - "com.amazonaws.apprunner#PauseService": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#PauseServiceRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#PauseServiceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#InvalidStateException" - }, - { - "target": "com.amazonaws.apprunner#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Pause an active App Runner service. App Runner reduces compute capacity for the service to zero and loses state (for example, ephemeral storage is\n removed).

\n

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations\n call to track the operation's progress.

" - } - }, - "com.amazonaws.apprunner#PauseServiceRequest": { - "type": "structure", - "members": { - "ServiceArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner service that you want to pause.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#PauseServiceResponse": { - "type": "structure", - "members": { - "Service": { - "target": "com.amazonaws.apprunner#Service", - "traits": { - "smithy.api#documentation": "

A description of the App Runner service that this request just paused.

", - "smithy.api#required": {} - } - }, - "OperationId": { - "target": "com.amazonaws.apprunner#UUID", - "traits": { - "smithy.api#documentation": "

The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track\n the operation's progress.

" - } - } - } - }, - "com.amazonaws.apprunner#ProviderType": { - "type": "enum", - "members": { - "GITHUB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GITHUB" - } - } - } - }, - "com.amazonaws.apprunner#ResourceNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.apprunner#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ResourceNotfound", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.apprunner#ResumeService": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#ResumeServiceRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#ResumeServiceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#InvalidStateException" - }, - { - "target": "com.amazonaws.apprunner#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Resume an active App Runner service. App Runner provisions compute capacity for the service.

\n

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations\n call to track the operation's progress.

" - } - }, - "com.amazonaws.apprunner#ResumeServiceRequest": { - "type": "structure", - "members": { - "ServiceArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner service that you want to resume.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#ResumeServiceResponse": { - "type": "structure", - "members": { - "Service": { - "target": "com.amazonaws.apprunner#Service", - "traits": { - "smithy.api#documentation": "

A description of the App Runner service that this request just resumed.

", - "smithy.api#required": {} - } - }, - "OperationId": { - "target": "com.amazonaws.apprunner#UUID", - "traits": { - "smithy.api#documentation": "

The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track\n the operation's progress.

" - } - } - } - }, - "com.amazonaws.apprunner#RoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 29, - "max": 1024 - }, - "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):iam::[0-9]{12}:(role|role\\/service-role)\\/[\\w+=,.@\\-/]{1,1000}$" - } - }, - "com.amazonaws.apprunner#Runtime": { - "type": "enum", - "members": { - "PYTHON_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PYTHON_3" - } - }, - "NODEJS_12": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NODEJS_12" - } - }, - "NODEJS_14": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NODEJS_14" - } - }, - "CORRETTO_8": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CORRETTO_8" - } - }, - "CORRETTO_11": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CORRETTO_11" - } - }, - "NODEJS_16": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NODEJS_16" - } - }, - "GO_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GO_1" - } - }, - "DOTNET_6": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOTNET_6" - } - }, - "PHP_81": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PHP_81" - } - }, - "RUBY_31": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUBY_31" - } - } - } - }, - "com.amazonaws.apprunner#RuntimeEnvironmentVariables": { - "type": "map", - "key": { - "target": "com.amazonaws.apprunner#RuntimeEnvironmentVariablesKey" - }, - "value": { - "target": "com.amazonaws.apprunner#RuntimeEnvironmentVariablesValue" - } - }, - "com.amazonaws.apprunner#RuntimeEnvironmentVariablesKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 51200 - }, - "smithy.api#pattern": ".*", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.apprunner#RuntimeEnvironmentVariablesValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 51200 - }, - "smithy.api#pattern": ".*", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.apprunner#Service": { - "type": "structure", - "members": { - "ServiceName": { - "target": "com.amazonaws.apprunner#ServiceName", - "traits": { - "smithy.api#documentation": "

The customer-provided service name.

", - "smithy.api#required": {} - } - }, - "ServiceId": { - "target": "com.amazonaws.apprunner#ServiceId", - "traits": { - "smithy.api#documentation": "

An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.

", - "smithy.api#required": {} - } - }, - "ServiceArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of this service.

", - "smithy.api#required": {} - } - }, - "ServiceUrl": { - "target": "com.amazonaws.apprunner#String", - "traits": { - "smithy.api#documentation": "

A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.apprunner#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the App Runner service was created. It's in the Unix time stamp format.

", - "smithy.api#required": {} - } - }, - "UpdatedAt": { - "target": "com.amazonaws.apprunner#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the App Runner service was last updated at. It's in the Unix time stamp format.

", - "smithy.api#required": {} - } - }, - "DeletedAt": { - "target": "com.amazonaws.apprunner#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the App Runner service was deleted. It's in the Unix time stamp format.

" - } - }, - "Status": { - "target": "com.amazonaws.apprunner#ServiceStatus", - "traits": { - "smithy.api#documentation": "

The current state of the App Runner service. These particular values mean the following.

\n ", - "smithy.api#required": {} - } - }, - "SourceConfiguration": { - "target": "com.amazonaws.apprunner#SourceConfiguration", - "traits": { - "smithy.api#documentation": "

The source deployed to the App Runner service. It can be a code or an image repository.

", - "smithy.api#required": {} - } - }, - "InstanceConfiguration": { - "target": "com.amazonaws.apprunner#InstanceConfiguration", - "traits": { - "smithy.api#documentation": "

The runtime configuration of instances (scaling units) of this service.

", - "smithy.api#required": {} - } - }, - "EncryptionConfiguration": { - "target": "com.amazonaws.apprunner#EncryptionConfiguration", - "traits": { - "smithy.api#documentation": "

The encryption key that App Runner uses to encrypt the service logs and the copy of the source repository that App Runner maintains for the service. It can be\n either a customer-provided encryption key or an Amazon Web Services managed key.

" - } - }, - "HealthCheckConfiguration": { - "target": "com.amazonaws.apprunner#HealthCheckConfiguration", - "traits": { - "smithy.api#documentation": "

The settings for the health check that App Runner performs to monitor the health of this service.

" - } - }, - "AutoScalingConfigurationSummary": { - "target": "com.amazonaws.apprunner#AutoScalingConfigurationSummary", - "traits": { - "smithy.api#documentation": "

Summary information for the App Runner automatic scaling configuration resource that's associated with this service.

", - "smithy.api#required": {} - } - }, - "NetworkConfiguration": { - "target": "com.amazonaws.apprunner#NetworkConfiguration", - "traits": { - "smithy.api#documentation": "

Configuration settings related to network traffic of the web application that this service runs.

", - "smithy.api#required": {} - } - }, - "ObservabilityConfiguration": { - "target": "com.amazonaws.apprunner#ServiceObservabilityConfiguration", - "traits": { - "smithy.api#documentation": "

The observability configuration of this service.

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

Describes an App Runner service. It can describe a service in any state, including deleted services.

\n

This type contains the full information about a service, including configuration details. It's returned by the CreateService, DescribeService, and DeleteService actions. A subset of this\n information is returned by the ListServices action using the ServiceSummary type.

" - } - }, - "com.amazonaws.apprunner#ServiceId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 32, - "max": 32 - }, - "smithy.api#pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" - } - }, - "com.amazonaws.apprunner#ServiceMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.apprunner#ServiceName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 4, - "max": 40 - }, - "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9-_]{3,39}$" - } - }, - "com.amazonaws.apprunner#ServiceObservabilityConfiguration": { - "type": "structure", - "members": { - "ObservabilityEnabled": { - "target": "com.amazonaws.apprunner#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

When true, an observability configuration resource is associated with the service, and an ObservabilityConfigurationArn is\n specified.

", - "smithy.api#required": {} - } - }, - "ObservabilityConfigurationArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the observability configuration that is associated with the service. Specified only when\n ObservabilityEnabled is true.

\n

Specify an ARN with a name and a revision number to associate that revision. For example:\n arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3\n

\n

Specify just the name to associate the latest revision. For example:\n arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing\n

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

Describes the observability configuration of an App Runner service. These are additional observability features, like tracing, that you choose to\n enable. They're configured in a separate resource that you associate with your service.

" - } - }, - "com.amazonaws.apprunner#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.apprunner#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ServiceQuotaExceeded", - "httpResponseCode": 402 - }, - "smithy.api#documentation": "

App Runner can't create this resource. You've reached your account quota for this resource type.

\n

For App Runner per-resource quotas, see App Runner endpoints and quotas in the\n Amazon Web Services General Reference.

", - "smithy.api#error": "client", - "smithy.api#httpError": 402 - } - }, - "com.amazonaws.apprunner#ServiceStatus": { - "type": "enum", - "members": { - "CREATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_FAILED" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_FAILED" - } - }, - "PAUSED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PAUSED" - } - }, - "OPERATION_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OPERATION_IN_PROGRESS" - } - } - } - }, - "com.amazonaws.apprunner#ServiceSummary": { - "type": "structure", - "members": { - "ServiceName": { - "target": "com.amazonaws.apprunner#ServiceName", - "traits": { - "smithy.api#documentation": "

The customer-provided service name.

" - } - }, - "ServiceId": { - "target": "com.amazonaws.apprunner#ServiceId", - "traits": { - "smithy.api#documentation": "

An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.

" - } - }, - "ServiceArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of this service.

" - } - }, - "ServiceUrl": { - "target": "com.amazonaws.apprunner#String", - "traits": { - "smithy.api#documentation": "

A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.apprunner#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the App Runner service was created. It's in the Unix time stamp format.

" - } - }, - "UpdatedAt": { - "target": "com.amazonaws.apprunner#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the App Runner service was last updated. It's in theUnix time stamp format.

" - } - }, - "Status": { - "target": "com.amazonaws.apprunner#ServiceStatus", - "traits": { - "smithy.api#documentation": "

The current state of the App Runner service. These particular values mean the following.

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

Provides summary information for an App Runner service.

\n

This type contains limited information about a service. It doesn't include configuration details. It's returned by the ListServices action. Complete service information is returned by the CreateService, DescribeService, and DeleteService actions using the Service type.

" - } - }, - "com.amazonaws.apprunner#ServiceSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.apprunner#ServiceSummary" - } - }, - "com.amazonaws.apprunner#SourceCodeVersion": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.apprunner#SourceCodeVersionType", - "traits": { - "smithy.api#documentation": "

The type of version identifier.

\n

For a git-based repository, branches represent versions.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.apprunner#String", - "traits": { - "smithy.api#documentation": "

A source code version.

\n

For a git-based repository, a branch name maps to a specific version. App Runner uses the most recent commit to the branch.

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

Identifies a version of code that App Runner refers to within a source code repository.

" - } - }, - "com.amazonaws.apprunner#SourceCodeVersionType": { - "type": "enum", - "members": { - "BRANCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BRANCH" - } - } - } - }, - "com.amazonaws.apprunner#SourceConfiguration": { - "type": "structure", - "members": { - "CodeRepository": { - "target": "com.amazonaws.apprunner#CodeRepository", - "traits": { - "smithy.api#documentation": "

The description of a source code repository.

\n

You must provide either this member or ImageRepository (but not both).

" - } - }, - "ImageRepository": { - "target": "com.amazonaws.apprunner#ImageRepository", - "traits": { - "smithy.api#documentation": "

The description of a source image\n repository.

\n

You must provide either this member or CodeRepository (but not both).

" - } - }, - "AutoDeploymentsEnabled": { - "target": "com.amazonaws.apprunner#NullableBoolean", - "traits": { - "smithy.api#documentation": "

If true, continuous integration from the source repository is enabled for the App Runner service. Each repository change (including any source\n code commit or new image version) starts a deployment.

\n

Default: App Runner sets to false for a source image that uses an ECR Public repository or an ECR repository that's in an Amazon Web Services account other than the one that the service is in. App Runner sets to true in all other cases (which currently include a source code\n repository or a source image using a same-account ECR repository).

" - } - }, - "AuthenticationConfiguration": { - "target": "com.amazonaws.apprunner#AuthenticationConfiguration", - "traits": { - "smithy.api#documentation": "

Describes the resources that are needed to authenticate access to some source repositories.

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

Describes the source deployed to an App Runner service. It can be a code or an image repository.

" - } - }, - "com.amazonaws.apprunner#StartCommand": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[^\\x0a\\x0d]+$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.apprunner#StartDeployment": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#StartDeploymentRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#StartDeploymentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Initiate a manual deployment of the latest commit in a source code repository or the latest image in a source image repository to an App Runner\n service.

\n

For a source code repository, App Runner retrieves the commit and builds a Docker image. For a source image repository, App Runner retrieves the latest Docker\n image. In both cases, App Runner then deploys the new image to your service and starts a new container instance.

\n

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations\n call to track the operation's progress.

" - } - }, - "com.amazonaws.apprunner#StartDeploymentRequest": { - "type": "structure", - "members": { - "ServiceArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner service that you want to manually deploy to.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#StartDeploymentResponse": { - "type": "structure", - "members": { - "OperationId": { - "target": "com.amazonaws.apprunner#UUID", - "traits": { - "smithy.api#documentation": "

The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track\n the operation's progress.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#String": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 51200 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.apprunner#StringList": { - "type": "list", - "member": { - "target": "com.amazonaws.apprunner#String" - } - }, - "com.amazonaws.apprunner#Tag": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.apprunner#TagKey", - "traits": { - "smithy.api#documentation": "

The key of the tag.

" - } - }, - "Value": { - "target": "com.amazonaws.apprunner#TagValue", - "traits": { - "smithy.api#documentation": "

The value of the tag.

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

Describes a tag that is applied to an App Runner resource. A tag is a metadata item consisting of a key-value pair.

" - } - }, - "com.amazonaws.apprunner#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^(?!aws:).+$" - } - }, - "com.amazonaws.apprunner#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.apprunner#TagKey" - } - }, - "com.amazonaws.apprunner#TagList": { - "type": "list", - "member": { - "target": "com.amazonaws.apprunner#Tag" - } - }, - "com.amazonaws.apprunner#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#InvalidStateException" - }, - { - "target": "com.amazonaws.apprunner#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Add tags to, or update the tag values of, an App Runner resource. A tag is a key-value pair.

" - } - }, - "com.amazonaws.apprunner#TagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to update tags for.

\n

It must be the ARN of an App Runner resource.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.apprunner#TagList", - "traits": { - "smithy.api#documentation": "

A list of tag key-value pairs to add or update. If a key is new to the resource, the tag is added with the provided value. If a key is already\n associated with the resource, the value of the tag is updated.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#TagResourceResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.apprunner#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.apprunner#Timestamp": { - "type": "timestamp" - }, - "com.amazonaws.apprunner#TraceConfiguration": { - "type": "structure", - "members": { - "Vendor": { - "target": "com.amazonaws.apprunner#TracingVendor", - "traits": { - "smithy.api#documentation": "

The implementation provider chosen for tracing App Runner services.

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

Describes the configuration of the tracing feature within an App Runner observability configuration.

" - } - }, - "com.amazonaws.apprunner#TracingVendor": { - "type": "enum", - "members": { - "AWSXRAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AWSXRAY" - } - } - } - }, - "com.amazonaws.apprunner#UUID": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 36, - "max": 36 - }, - "smithy.api#pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" - } - }, - "com.amazonaws.apprunner#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#InvalidStateException" - }, - { - "target": "com.amazonaws.apprunner#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Remove tags from an App Runner resource.

" - } - }, - "com.amazonaws.apprunner#UntagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to remove tags from.

\n

It must be the ARN of an App Runner resource.

", - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.apprunner#TagKeyList", - "traits": { - "smithy.api#documentation": "

A list of tag keys that you want to remove.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#UntagResourceResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.apprunner#UpdateService": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#UpdateServiceRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#UpdateServiceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#InvalidStateException" - }, - { - "target": "com.amazonaws.apprunner#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Update an App Runner service. You can update the source configuration and instance configuration of the service. You can also update the ARN of the auto\n scaling configuration resource that's associated with the service. However, you can't change the name or the encryption configuration of the service.\n These can be set only when you create the service.

\n

To update the tags applied to your service, use the separate actions TagResource and UntagResource.

\n

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations\n call to track the operation's progress.

" - } - }, - "com.amazonaws.apprunner#UpdateServiceRequest": { - "type": "structure", - "members": { - "ServiceArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner service that you want to update.

", - "smithy.api#required": {} - } - }, - "SourceConfiguration": { - "target": "com.amazonaws.apprunner#SourceConfiguration", - "traits": { - "smithy.api#documentation": "

The source configuration to apply to the App Runner service.

\n

You can change the configuration of the code or image repository that the service uses. However, you can't switch from code to image or the other way\n around. This means that you must provide the same structure member of SourceConfiguration that you originally included when you created the\n service. Specifically, you can include either CodeRepository or ImageRepository. To update the source configuration, set the\n values to members of the structure that you include.

" - } - }, - "InstanceConfiguration": { - "target": "com.amazonaws.apprunner#InstanceConfiguration", - "traits": { - "smithy.api#documentation": "

The runtime configuration to apply to instances (scaling units) of your service.

" - } - }, - "AutoScalingConfigurationArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with the App Runner service.

" - } - }, - "HealthCheckConfiguration": { - "target": "com.amazonaws.apprunner#HealthCheckConfiguration", - "traits": { - "smithy.api#documentation": "

The settings for the health check that App Runner performs to monitor the health of the App Runner service.

" - } - }, - "NetworkConfiguration": { - "target": "com.amazonaws.apprunner#NetworkConfiguration", - "traits": { - "smithy.api#documentation": "

Configuration settings related to network traffic of the web application that the App Runner service runs.

" - } - }, - "ObservabilityConfiguration": { - "target": "com.amazonaws.apprunner#ServiceObservabilityConfiguration", - "traits": { - "smithy.api#documentation": "

The observability configuration of your service.

" - } - } - } - }, - "com.amazonaws.apprunner#UpdateServiceResponse": { - "type": "structure", - "members": { - "Service": { - "target": "com.amazonaws.apprunner#Service", - "traits": { - "smithy.api#documentation": "

A description of the App Runner service updated by this request. All configuration values in the returned Service structure reflect\n configuration changes that are being applied by this request.

", - "smithy.api#required": {} - } - }, - "OperationId": { - "target": "com.amazonaws.apprunner#UUID", - "traits": { - "smithy.api#documentation": "

The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track\n the operation's progress.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#UpdateVpcIngressConnection": { - "type": "operation", - "input": { - "target": "com.amazonaws.apprunner#UpdateVpcIngressConnectionRequest" - }, - "output": { - "target": "com.amazonaws.apprunner#UpdateVpcIngressConnectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apprunner#InternalServiceErrorException" - }, - { - "target": "com.amazonaws.apprunner#InvalidRequestException" - }, - { - "target": "com.amazonaws.apprunner#InvalidStateException" - }, - { - "target": "com.amazonaws.apprunner#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Update an existing App Runner VPC Ingress Connection resource. The VPC Ingress Connection must be in one of the following states to be updated:

\n " - } - }, - "com.amazonaws.apprunner#UpdateVpcIngressConnectionRequest": { - "type": "structure", - "members": { - "VpcIngressConnectionArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (Arn) for the App Runner VPC Ingress Connection resource that you want to update.

", - "smithy.api#required": {} - } - }, - "IngressVpcConfiguration": { - "target": "com.amazonaws.apprunner#IngressVpcConfiguration", - "traits": { - "smithy.api#documentation": "

Specifications for the customerā€™s Amazon VPC and the related Amazon Web Services PrivateLink VPC endpoint that are used to update the VPC Ingress Connection\n resource.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#UpdateVpcIngressConnectionResponse": { - "type": "structure", - "members": { - "VpcIngressConnection": { - "target": "com.amazonaws.apprunner#VpcIngressConnection", - "traits": { - "smithy.api#documentation": "

A description of the App Runner VPC Ingress Connection resource that's updated by this request.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.apprunner#VpcConnector": { - "type": "structure", - "members": { - "VpcConnectorName": { - "target": "com.amazonaws.apprunner#VpcConnectorName", - "traits": { - "smithy.api#documentation": "

The customer-provided VPC connector name.

" - } - }, - "VpcConnectorArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of this VPC connector.

" - } - }, - "VpcConnectorRevision": { - "target": "com.amazonaws.apprunner#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The revision of this VPC connector. It's unique among all the active connectors (\"Status\": \"ACTIVE\") that share the same\n Name.

\n \n

At this time, App Runner supports only one revision per name.

\n " - } - }, - "Subnets": { - "target": "com.amazonaws.apprunner#StringList", - "traits": { - "smithy.api#documentation": "

A list of IDs of subnets that App Runner uses for your service. All IDs are of subnets of a single Amazon VPC.

" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.apprunner#StringList", - "traits": { - "smithy.api#documentation": "

A list of IDs of security groups that App Runner uses for access to Amazon Web Services resources under the specified subnets. If not specified, App Runner uses the default\n security group of the Amazon VPC. The default security group allows all outbound traffic.

" - } - }, - "Status": { - "target": "com.amazonaws.apprunner#VpcConnectorStatus", - "traits": { - "smithy.api#documentation": "

The current state of the VPC connector. If the status of a connector revision is INACTIVE, it was deleted and can't be\n used. Inactive connector revisions are permanently removed some time after they are deleted.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.apprunner#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the VPC connector was created. It's in Unix time stamp format.

" - } - }, - "DeletedAt": { - "target": "com.amazonaws.apprunner#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the VPC connector was deleted. It's in Unix time stamp format.

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

Describes an App Runner VPC connector resource. A VPC connector describes the Amazon Virtual Private Cloud (Amazon VPC) that an App Runner service is\n associated with, and the subnets and security group that are used.

\n

Multiple revisions of a connector might have the same Name and different Revision values.

\n \n

At this time, App Runner supports only one revision per name.

\n " - } - }, - "com.amazonaws.apprunner#VpcConnectorName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 4, - "max": 40 - }, - "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9\\-_]{3,39}$" - } - }, - "com.amazonaws.apprunner#VpcConnectorStatus": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "INACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INACTIVE" - } - } - } - }, - "com.amazonaws.apprunner#VpcConnectors": { - "type": "list", - "member": { - "target": "com.amazonaws.apprunner#VpcConnector" - } - }, - "com.amazonaws.apprunner#VpcDNSTarget": { - "type": "structure", - "members": { - "VpcIngressConnectionArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC Ingress Connection that is associated with your service.

" - } - }, - "VpcId": { - "target": "com.amazonaws.apprunner#String", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon VPC that is associated with the custom domain name of the target DNS.

" - } - }, - "DomainName": { - "target": "com.amazonaws.apprunner#DomainName", - "traits": { - "smithy.api#documentation": "

The domain name of your target DNS that is associated with the Amazon VPC.

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

DNS Target record for a custom domain of this Amazon VPC.

" - } - }, - "com.amazonaws.apprunner#VpcDNSTargetList": { - "type": "list", - "member": { - "target": "com.amazonaws.apprunner#VpcDNSTarget" - } - }, - "com.amazonaws.apprunner#VpcIngressConnection": { - "type": "structure", - "members": { - "VpcIngressConnectionArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC Ingress Connection.\n

" - } - }, - "VpcIngressConnectionName": { - "target": "com.amazonaws.apprunner#VpcIngressConnectionName", - "traits": { - "smithy.api#documentation": "

The customer-provided VPC Ingress Connection name.

" - } - }, - "ServiceArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service associated with the VPC Ingress Connection.\n

" - } - }, - "Status": { - "target": "com.amazonaws.apprunner#VpcIngressConnectionStatus", - "traits": { - "smithy.api#documentation": "

The current status of the VPC Ingress Connection. \n The VPC Ingress Connection displays one of the following statuses: AVAILABLE, PENDING_CREATION, PENDING_UPDATE, PENDING_DELETION,FAILED_CREATION, FAILED_UPDATE, FAILED_DELETION, and DELETED..\n

" - } - }, - "AccountId": { - "target": "com.amazonaws.apprunner#CustomerAccountId", - "traits": { - "smithy.api#documentation": "

The Account Id you use to create the VPC Ingress Connection resource.

" - } - }, - "DomainName": { - "target": "com.amazonaws.apprunner#DomainName", - "traits": { - "smithy.api#documentation": "

The domain name associated with the VPC Ingress Connection resource.

" - } - }, - "IngressVpcConfiguration": { - "target": "com.amazonaws.apprunner#IngressVpcConfiguration", - "traits": { - "smithy.api#documentation": "

Specifications for the customerā€™s VPC and related PrivateLink VPC endpoint that are used to associate with the VPC Ingress Connection resource.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.apprunner#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the VPC Ingress Connection was created. It's in the Unix time stamp format.

\n " - } - }, - "DeletedAt": { - "target": "com.amazonaws.apprunner#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the App Runner service was deleted. It's in the Unix time stamp format.

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

The App Runner resource that specifies an App Runner endpoint for incoming traffic. It establishes a connection between a VPC interface endpoint and a App Runner\n service, to make your App Runner service accessible from only within an Amazon VPC.

" - } - }, - "com.amazonaws.apprunner#VpcIngressConnectionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 4, - "max": 40 - }, - "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9\\-_]{3,39}$" - } - }, - "com.amazonaws.apprunner#VpcIngressConnectionStatus": { - "type": "enum", - "members": { - "AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVAILABLE" - } - }, - "PENDING_CREATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_CREATION" - } - }, - "PENDING_UPDATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_UPDATE" - } - }, - "PENDING_DELETION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_DELETION" - } - }, - "FAILED_CREATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_CREATION" - } - }, - "FAILED_UPDATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_UPDATE" - } - }, - "FAILED_DELETION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_DELETION" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - } - } - }, - "com.amazonaws.apprunner#VpcIngressConnectionSummary": { - "type": "structure", - "members": { - "VpcIngressConnectionArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC Ingress Connection.\n

" - } - }, - "ServiceArn": { - "target": "com.amazonaws.apprunner#AppRunnerResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service associated with the VPC Ingress Connection.\n

" - } + "output": { + "target": "com.amazonaws.apprunner#CreateServiceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#ServiceQuotaExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Create an App Runner service. After the service is created, the action also automatically starts a deployment.

\n

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations call to track the operation's progress.

" + } + }, + "com.amazonaws.apprunner#CreateServiceRequest": { + "type": "structure", + "members": { + "ServiceName": { + "target": "com.amazonaws.apprunner#ServiceName", + "traits": { + "smithy.api#documentation": "

A name for the App Runner service. It must be unique across all the running App Runner services in your Amazon Web Services account in the Amazon Web Services Region.

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

The source to deploy to the App Runner service. It can be a code or an image repository.

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

The runtime configuration of instances (scaling units) of your service.

" + } + }, + "Tags": { + "target": "com.amazonaws.apprunner#TagList", + "traits": { + "smithy.api#documentation": "

An optional list of metadata items that you can associate with the App Runner service resource. A tag is a key-value pair.

" + } + }, + "EncryptionConfiguration": { + "target": "com.amazonaws.apprunner#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs. By default,\n App Runner uses an Amazon Web Services managed key.

" + } + }, + "HealthCheckConfiguration": { + "target": "com.amazonaws.apprunner#HealthCheckConfiguration", + "traits": { + "smithy.api#documentation": "

The settings for the health check that App Runner performs to monitor the health of the App Runner service.

" + } + }, + "AutoScalingConfigurationArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service. If not provided, App Runner\n associates the latest revision of a default auto scaling configuration.

\n

Specify an ARN with a name and a revision number to associate that revision. For example:\n arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3\n

\n

Specify just the name to associate the latest revision. For example:\n arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability\n

" + } + }, + "NetworkConfiguration": { + "target": "com.amazonaws.apprunner#NetworkConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration settings related to network traffic of the web application that the App Runner service runs.

" + } + }, + "ObservabilityConfiguration": { + "target": "com.amazonaws.apprunner#ServiceObservabilityConfiguration", + "traits": { + "smithy.api#documentation": "

The observability configuration of your service.

" + } + } + } + }, + "com.amazonaws.apprunner#CreateServiceResponse": { + "type": "structure", + "members": { + "Service": { + "target": "com.amazonaws.apprunner#Service", + "traits": { + "smithy.api#documentation": "

A description of the App Runner service that's created by this request.

", + "smithy.api#required": {} + } + }, + "OperationId": { + "target": "com.amazonaws.apprunner#UUID", + "traits": { + "smithy.api#documentation": "

The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track the operation's progress.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#CreateVpcConnector": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#CreateVpcConnectorRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#CreateVpcConnectorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#ServiceQuotaExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Create an App Runner VPC connector resource. App Runner requires this resource when you want to associate your App Runner service to a custom Amazon Virtual Private Cloud\n (Amazon VPC).

" + } + }, + "com.amazonaws.apprunner#CreateVpcConnectorRequest": { + "type": "structure", + "members": { + "VpcConnectorName": { + "target": "com.amazonaws.apprunner#VpcConnectorName", + "traits": { + "smithy.api#documentation": "

A name for the VPC connector.

", + "smithy.api#required": {} + } + }, + "Subnets": { + "target": "com.amazonaws.apprunner#StringList", + "traits": { + "smithy.api#documentation": "

A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single\n Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.

\n \n

\n App Runner currently only provides support for IPv4.\n

\n ", + "smithy.api#required": {} + } + }, + "SecurityGroups": { + "target": "com.amazonaws.apprunner#StringList", + "traits": { + "smithy.api#documentation": "

A list of IDs of security groups that App Runner should use for access to Amazon Web Services resources under the specified subnets. If not specified, App Runner uses the\n default security group of the Amazon VPC. The default security group allows all outbound traffic.

" + } + }, + "Tags": { + "target": "com.amazonaws.apprunner#TagList", + "traits": { + "smithy.api#documentation": "

A list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.

" + } + } + } + }, + "com.amazonaws.apprunner#CreateVpcConnectorResponse": { + "type": "structure", + "members": { + "VpcConnector": { + "target": "com.amazonaws.apprunner#VpcConnector", + "traits": { + "smithy.api#documentation": "

A description of the App Runner VPC connector that's created by this request.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#CreateVpcIngressConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#CreateVpcIngressConnectionRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#CreateVpcIngressConnectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#InvalidStateException" + }, + { + "target": "com.amazonaws.apprunner#ServiceQuotaExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Create an App Runner VPC Ingress Connection resource. App Runner requires this resource when you want to associate your App Runner service with an Amazon VPC endpoint.

" + } + }, + "com.amazonaws.apprunner#CreateVpcIngressConnectionRequest": { + "type": "structure", + "members": { + "ServiceArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.

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

A name for the VPC Ingress Connection resource. It must be unique across all the active VPC Ingress Connections in your Amazon Web Services account in the Amazon Web Services Region.\n

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

Specifications for the customerā€™s Amazon VPC and the related Amazon Web Services PrivateLink VPC endpoint that are used to create the VPC Ingress Connection\n resource.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.apprunner#TagList", + "traits": { + "smithy.api#documentation": "

An optional list of metadata items that you can associate with the VPC Ingress Connection resource. A tag is a key-value pair.

" + } + } + } + }, + "com.amazonaws.apprunner#CreateVpcIngressConnectionResponse": { + "type": "structure", + "members": { + "VpcIngressConnection": { + "target": "com.amazonaws.apprunner#VpcIngressConnection", + "traits": { + "smithy.api#documentation": "

A description of the App Runner VPC Ingress Connection resource that's created by this request.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#CustomDomain": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.apprunner#DomainName", + "traits": { + "smithy.api#documentation": "

An associated custom domain endpoint. It can be a root domain (for example, example.com), a subdomain (for example,\n login.example.com or admin.login.example.com), or a wildcard (for example, *.example.com).

", + "smithy.api#required": {} + } + }, + "EnableWWWSubdomain": { + "target": "com.amazonaws.apprunner#NullableBoolean", + "traits": { + "smithy.api#documentation": "

When true, the subdomain www.DomainName\n is associated with the App Runner service in addition to the base\n domain.

", + "smithy.api#required": {} + } + }, + "CertificateValidationRecords": { + "target": "com.amazonaws.apprunner#CertificateValidationRecordList", + "traits": { + "smithy.api#documentation": "

A list of certificate CNAME records that's used for this domain name.

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

The current state of the domain name association.

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

Describes a custom domain that's associated with an App Runner service.

" + } + }, + "com.amazonaws.apprunner#CustomDomainAssociationStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + }, + "PENDING_CERTIFICATE_DNS_VALIDATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_CERTIFICATE_DNS_VALIDATION" + } + }, + "BINDING_CERTIFICATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BINDING_CERTIFICATE" + } + } + } + }, + "com.amazonaws.apprunner#CustomDomainList": { + "type": "list", + "member": { + "target": "com.amazonaws.apprunner#CustomDomain" + } + }, + "com.amazonaws.apprunner#CustomerAccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^[0-9]{12}$" + } + }, + "com.amazonaws.apprunner#DeleteAutoScalingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#DeleteAutoScalingConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#DeleteAutoScalingConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete an App Runner automatic scaling configuration resource. You can delete a specific revision or the latest active revision. You can't delete a\n configuration that's used by one or more App Runner services.

" + } + }, + "com.amazonaws.apprunner#DeleteAutoScalingConfigurationRequest": { + "type": "structure", + "members": { + "AutoScalingConfigurationArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want to delete.

\n

The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either .../name\n or\n .../name/revision\n . If a revision isn't specified, the latest active revision is deleted.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#DeleteAutoScalingConfigurationResponse": { + "type": "structure", + "members": { + "AutoScalingConfiguration": { + "target": "com.amazonaws.apprunner#AutoScalingConfiguration", + "traits": { + "smithy.api#documentation": "

A description of the App Runner auto scaling configuration that this request just deleted.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#DeleteConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#DeleteConnectionRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#DeleteConnectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete an App Runner connection. You must first ensure that there are no running App Runner services that use this connection. If there are any, the\n DeleteConnection action fails.

" + } + }, + "com.amazonaws.apprunner#DeleteConnectionRequest": { + "type": "structure", + "members": { + "ConnectionArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner connection that you want to delete.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#DeleteConnectionResponse": { + "type": "structure", + "members": { + "Connection": { + "target": "com.amazonaws.apprunner#Connection", + "traits": { + "smithy.api#documentation": "

A description of the App Runner connection that this request just deleted.

" + } + } + } + }, + "com.amazonaws.apprunner#DeleteObservabilityConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#DeleteObservabilityConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#DeleteObservabilityConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete an App Runner observability configuration resource. You can delete a specific revision or the latest active revision. You can't delete a\n configuration that's used by one or more App Runner services.

" + } + }, + "com.amazonaws.apprunner#DeleteObservabilityConfigurationRequest": { + "type": "structure", + "members": { + "ObservabilityConfigurationArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner observability configuration that you want to delete.

\n

The ARN can be a full observability configuration ARN, or a partial ARN ending with either .../name\n or\n .../name/revision\n . If a revision isn't specified, the latest active revision is deleted.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#DeleteObservabilityConfigurationResponse": { + "type": "structure", + "members": { + "ObservabilityConfiguration": { + "target": "com.amazonaws.apprunner#ObservabilityConfiguration", + "traits": { + "smithy.api#documentation": "

A description of the App Runner observability configuration that this request just deleted.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#DeleteService": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#DeleteServiceRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#DeleteServiceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#InvalidStateException" + }, + { + "target": "com.amazonaws.apprunner#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete an App Runner service.

\n

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations\n call to track the operation's progress.

\n \n

Make sure that you don't have any active VPCIngressConnections associated with the service you want to delete. \n

\n " + } + }, + "com.amazonaws.apprunner#DeleteServiceRequest": { + "type": "structure", + "members": { + "ServiceArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner service that you want to delete.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#DeleteServiceResponse": { + "type": "structure", + "members": { + "Service": { + "target": "com.amazonaws.apprunner#Service", + "traits": { + "smithy.api#documentation": "

A description of the App Runner service that this request just deleted.

", + "smithy.api#required": {} + } + }, + "OperationId": { + "target": "com.amazonaws.apprunner#UUID", + "traits": { + "smithy.api#documentation": "

The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track\n the operation's progress.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#DeleteVpcConnector": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#DeleteVpcConnectorRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#DeleteVpcConnectorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete an App Runner VPC connector resource. You can't delete a\n connector that's used by one or more App Runner services.

" + } + }, + "com.amazonaws.apprunner#DeleteVpcConnectorRequest": { + "type": "structure", + "members": { + "VpcConnectorArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to delete.

\n

The ARN must be a full VPC connector ARN.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#DeleteVpcConnectorResponse": { + "type": "structure", + "members": { + "VpcConnector": { + "target": "com.amazonaws.apprunner#VpcConnector", + "traits": { + "smithy.api#documentation": "

A description of the App Runner VPC connector that this request just deleted.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#DeleteVpcIngressConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#DeleteVpcIngressConnectionRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#DeleteVpcIngressConnectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#InvalidStateException" + }, + { + "target": "com.amazonaws.apprunner#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete an App Runner VPC Ingress Connection resource that's associated with an App Runner service. The VPC Ingress Connection must be in one of the following states to be deleted:\n

\n " + } + }, + "com.amazonaws.apprunner#DeleteVpcIngressConnectionRequest": { + "type": "structure", + "members": { + "VpcIngressConnectionArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that you want to delete.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#DeleteVpcIngressConnectionResponse": { + "type": "structure", + "members": { + "VpcIngressConnection": { + "target": "com.amazonaws.apprunner#VpcIngressConnection", + "traits": { + "smithy.api#documentation": "

A description of the App Runner VPC Ingress Connection that this request just deleted.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#DescribeAutoScalingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#DescribeAutoScalingConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#DescribeAutoScalingConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Return a full description of an App Runner automatic scaling configuration resource.

" + } + }, + "com.amazonaws.apprunner#DescribeAutoScalingConfigurationRequest": { + "type": "structure", + "members": { + "AutoScalingConfigurationArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want a description for.

\n

The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either .../name\n or\n .../name/revision\n . If a revision isn't specified, the latest active revision is\n described.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#DescribeAutoScalingConfigurationResponse": { + "type": "structure", + "members": { + "AutoScalingConfiguration": { + "target": "com.amazonaws.apprunner#AutoScalingConfiguration", + "traits": { + "smithy.api#documentation": "

A full description of the App Runner auto scaling configuration that you specified in this request.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#DescribeCustomDomains": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#DescribeCustomDomainsRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#DescribeCustomDomainsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Return a description of custom domain names that are associated with an App Runner service.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.apprunner#DescribeCustomDomainsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.apprunner#DescribeCustomDomainsRequest": { + "type": "structure", + "members": { + "ServiceArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner service that you want associated custom domain names to be described for.

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

A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be\n identical to the ones that are specified in the initial request.

\n

If you don't specify NextToken, the request retrieves the first result page.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.apprunner#DescribeCustomDomainsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results that each response (result page) can include. It's used for a paginated request.

\n

If you don't specify MaxResults, the request retrieves all available results in a single response.

" + } + } + } + }, + "com.amazonaws.apprunner#DescribeCustomDomainsResponse": { + "type": "structure", + "members": { + "DNSTarget": { + "target": "com.amazonaws.apprunner#String", + "traits": { + "smithy.api#documentation": "

The App Runner subdomain of the App Runner service. The associated custom domain names are mapped to this target name.

", + "smithy.api#required": {} + } + }, + "ServiceArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner service whose associated custom domain names you want to describe.

", + "smithy.api#required": {} + } + }, + "CustomDomains": { + "target": "com.amazonaws.apprunner#CustomDomainList", + "traits": { + "smithy.api#documentation": "

A list of descriptions of custom domain names that are associated with the service. In a paginated request, the request returns up to\n MaxResults records per call.

", + "smithy.api#required": {} + } + }, + "VpcDNSTargets": { + "target": "com.amazonaws.apprunner#VpcDNSTargetList", + "traits": { + "smithy.api#documentation": "

DNS Target records for the custom domains of this Amazon VPC.\n

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

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

" + } + } + } + }, + "com.amazonaws.apprunner#DescribeObservabilityConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#DescribeObservabilityConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#DescribeObservabilityConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Return a full description of an App Runner observability configuration resource.

" + } + }, + "com.amazonaws.apprunner#DescribeObservabilityConfigurationRequest": { + "type": "structure", + "members": { + "ObservabilityConfigurationArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner observability configuration that you want a description for.

\n

The ARN can be a full observability configuration ARN, or a partial ARN ending with either .../name\n or\n .../name/revision\n . If a revision isn't specified, the latest active revision is\n described.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#DescribeObservabilityConfigurationResponse": { + "type": "structure", + "members": { + "ObservabilityConfiguration": { + "target": "com.amazonaws.apprunner#ObservabilityConfiguration", + "traits": { + "smithy.api#documentation": "

A full description of the App Runner observability configuration that you specified in this request.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#DescribeService": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#DescribeServiceRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#DescribeServiceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Return a full description of an App Runner service.

" + } + }, + "com.amazonaws.apprunner#DescribeServiceRequest": { + "type": "structure", + "members": { + "ServiceArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner service that you want a description for.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#DescribeServiceResponse": { + "type": "structure", + "members": { + "Service": { + "target": "com.amazonaws.apprunner#Service", + "traits": { + "smithy.api#documentation": "

A full description of the App Runner service that you specified in this request.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#DescribeVpcConnector": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#DescribeVpcConnectorRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#DescribeVpcConnectorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Return a description of an App Runner VPC connector resource.

" + } + }, + "com.amazonaws.apprunner#DescribeVpcConnectorRequest": { + "type": "structure", + "members": { + "VpcConnectorArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner VPC connector that you want a description for.

\n

The ARN must be a full VPC connector ARN.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#DescribeVpcConnectorResponse": { + "type": "structure", + "members": { + "VpcConnector": { + "target": "com.amazonaws.apprunner#VpcConnector", + "traits": { + "smithy.api#documentation": "

A description of the App Runner VPC connector that you specified in this request.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#DescribeVpcIngressConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#DescribeVpcIngressConnectionRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#DescribeVpcIngressConnectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Return a full description of an App Runner VPC Ingress Connection resource.

" + } + }, + "com.amazonaws.apprunner#DescribeVpcIngressConnectionRequest": { + "type": "structure", + "members": { + "VpcIngressConnectionArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that you want a description for.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#DescribeVpcIngressConnectionResponse": { + "type": "structure", + "members": { + "VpcIngressConnection": { + "target": "com.amazonaws.apprunner#VpcIngressConnection", + "traits": { + "smithy.api#documentation": "

A description of the App Runner VPC Ingress Connection that you specified in this request.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#DisassociateCustomDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#DisassociateCustomDomainRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#DisassociateCustomDomainResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#InvalidStateException" + }, + { + "target": "com.amazonaws.apprunner#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociate a custom domain name from an App Runner service.

\n

Certificates tracking domain validity are associated with a custom domain and are stored in AWS\n Certificate Manager (ACM). These certificates aren't deleted as part of this action. App Runner delays certificate deletion for\n 30 days after a domain is disassociated from your service.

" + } + }, + "com.amazonaws.apprunner#DisassociateCustomDomainRequest": { + "type": "structure", + "members": { + "ServiceArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner service that you want to disassociate a custom domain name from.

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

The domain name that you want to disassociate from the App Runner service.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#DisassociateCustomDomainResponse": { + "type": "structure", + "members": { + "DNSTarget": { + "target": "com.amazonaws.apprunner#String", + "traits": { + "smithy.api#documentation": "

The App Runner subdomain of the App Runner service. The disassociated custom domain name was mapped to this target name.

", + "smithy.api#required": {} + } + }, + "ServiceArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner service that a custom domain name is disassociated from.

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

A description of the domain name that's being disassociated.

", + "smithy.api#required": {} + } + }, + "VpcDNSTargets": { + "target": "com.amazonaws.apprunner#VpcDNSTargetList", + "traits": { + "smithy.api#documentation": "

DNS Target records for the custom domains of this Amazon VPC.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#DomainName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z0-9*.-]{1,255}$" + } + }, + "com.amazonaws.apprunner#EgressConfiguration": { + "type": "structure", + "members": { + "EgressType": { + "target": "com.amazonaws.apprunner#EgressType", + "traits": { + "smithy.api#documentation": "

The type of egress configuration.

\n

Set to DEFAULT for access to resources hosted on public networks.

\n

Set to VPC to associate your service to a custom VPC specified by VpcConnectorArn.

" + } + }, + "VpcConnectorArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to associate with your App Runner service. Only valid when EgressType =\n VPC.

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

Describes configuration settings related to outbound network traffic of an App Runner service.

" + } + }, + "com.amazonaws.apprunner#EgressType": { + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } + }, + "VPC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC" + } + } + } + }, + "com.amazonaws.apprunner#EncryptionConfiguration": { + "type": "structure", + "members": { + "KmsKey": { + "target": "com.amazonaws.apprunner#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key that's used for encryption.

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

Describes a custom encryption key that App Runner uses to encrypt copies of the source repository and service logs.

" + } + }, + "com.amazonaws.apprunner#ErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 600 + } + } + }, + "com.amazonaws.apprunner#HealthCheckConfiguration": { + "type": "structure", + "members": { + "Protocol": { + "target": "com.amazonaws.apprunner#HealthCheckProtocol", + "traits": { + "smithy.api#documentation": "

The IP protocol that App Runner uses to perform health checks for your service.

\n

If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.

\n

Default: TCP\n

" + } + }, + "Path": { + "target": "com.amazonaws.apprunner#HealthCheckPath", + "traits": { + "smithy.api#documentation": "

The URL that health check requests are sent to.

\n

\n Path is only applicable when you set Protocol to HTTP.

\n

Default: \"/\"\n

" + } + }, + "Interval": { + "target": "com.amazonaws.apprunner#HealthCheckInterval", + "traits": { + "smithy.api#documentation": "

The time interval, in seconds, between health checks.

\n

Default: 5\n

" + } + }, + "Timeout": { + "target": "com.amazonaws.apprunner#HealthCheckTimeout", + "traits": { + "smithy.api#documentation": "

The time, in seconds, to wait for a health check response before deciding it failed.

\n

Default: 2\n

" + } + }, + "HealthyThreshold": { + "target": "com.amazonaws.apprunner#HealthCheckHealthyThreshold", + "traits": { + "smithy.api#documentation": "

The number of consecutive checks that must succeed before App Runner decides that the service is healthy.

\n

Default: 1\n

" + } + }, + "UnhealthyThreshold": { + "target": "com.amazonaws.apprunner#HealthCheckUnhealthyThreshold", + "traits": { + "smithy.api#documentation": "

The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.

\n

Default: 5\n

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

Describes the settings for the health check that App Runner performs to monitor the health of a service.

" + } + }, + "com.amazonaws.apprunner#HealthCheckHealthyThreshold": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.apprunner#HealthCheckInterval": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.apprunner#HealthCheckPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.apprunner#HealthCheckProtocol": { + "type": "enum", + "members": { + "TCP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TCP" + } + }, + "HTTP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP" + } + } + } + }, + "com.amazonaws.apprunner#HealthCheckTimeout": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.apprunner#HealthCheckUnhealthyThreshold": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.apprunner#ImageConfiguration": { + "type": "structure", + "members": { + "RuntimeEnvironmentVariables": { + "target": "com.amazonaws.apprunner#RuntimeEnvironmentVariables", + "traits": { + "smithy.api#documentation": "

Environment variables that are available to your running App Runner service. An array of key-value pairs.

" + } + }, + "StartCommand": { + "target": "com.amazonaws.apprunner#StartCommand", + "traits": { + "smithy.api#documentation": "

An optional command that App Runner runs to start the application in the source image. If specified, this command overrides the Docker imageā€™s default start\n command.

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

The port that your application listens to in the container.

\n

Default: 8080\n

" + } + }, + "RuntimeEnvironmentSecrets": { + "target": "com.amazonaws.apprunner#RuntimeEnvironmentSecrets", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. \n The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

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

Describes the configuration that App Runner uses to run an App Runner service using an image pulled from a source image repository.

" + } + }, + "com.amazonaws.apprunner#ImageIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^([0-9]{12}.dkr.ecr.[a-z\\-]+-[0-9]{1}.amazonaws.com\\/((?:[a-z0-9]+(?:[._-][a-z0-9]+)*\\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)(:([\\w\\d+\\-=._:\\/@])+|@([\\w\\d\\:]+))?)|(^public\\.ecr\\.aws\\/.+\\/((?:[a-z0-9]+(?:[._-][a-z0-9]+)*\\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)(:([\\w\\d+\\-=._:\\/@])+|@([\\w\\d\\:]+))?)$" + } + }, + "com.amazonaws.apprunner#ImageRepository": { + "type": "structure", + "members": { + "ImageIdentifier": { + "target": "com.amazonaws.apprunner#ImageIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of an image.

\n

For an image in Amazon Elastic Container Registry (Amazon ECR), this is an image name. For the image name format, see Pulling an image in the Amazon ECR User Guide.

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

Configuration for running the identified image.

" + } + }, + "ImageRepositoryType": { + "target": "com.amazonaws.apprunner#ImageRepositoryType", + "traits": { + "smithy.api#documentation": "

The type of the image repository. This reflects the repository provider and whether the repository is private or public.

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

Describes a source image repository.

" + } + }, + "com.amazonaws.apprunner#ImageRepositoryType": { + "type": "enum", + "members": { + "ECR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECR" + } + }, + "ECR_PUBLIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECR_PUBLIC" + } + } + } + }, + "com.amazonaws.apprunner#IngressConfiguration": { + "type": "structure", + "members": { + "IsPubliclyAccessible": { + "target": "com.amazonaws.apprunner#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether your App Runner service is publicly accessible. To make the service publicly accessible set it to True. To make the service\n privately accessible, from only within an Amazon VPC set it to False.

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

Network configuration settings for inbound network traffic.

" + } + }, + "com.amazonaws.apprunner#IngressVpcConfiguration": { + "type": "structure", + "members": { + "VpcId": { + "target": "com.amazonaws.apprunner#String", + "traits": { + "smithy.api#documentation": "

The ID of the VPC that is used for the VPC endpoint.

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

The ID of the VPC endpoint that your App Runner service connects to.\n

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

The configuration of your VPC and the associated VPC endpoint. The VPC endpoint is an Amazon Web Services PrivateLink resource that allows access to your App Runner\n services from within an Amazon VPC.

" + } + }, + "com.amazonaws.apprunner#InstanceConfiguration": { + "type": "structure", + "members": { + "Cpu": { + "target": "com.amazonaws.apprunner#Cpu", + "traits": { + "smithy.api#documentation": "

The number of CPU units reserved for each instance of your App Runner service.

\n

Default: 1 vCPU\n

" + } + }, + "Memory": { + "target": "com.amazonaws.apprunner#Memory", + "traits": { + "smithy.api#documentation": "

The amount of memory, in MB or GB, reserved for each instance of your App Runner service.

\n

Default: 2 GB\n

" + } + }, + "InstanceRoleArn": { + "target": "com.amazonaws.apprunner#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that provides permissions to your App Runner service. These are permissions that your code needs when it calls\n any Amazon Web Services APIs.

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

Describes the runtime configuration of an App Runner service instance (scaling unit).

" + } + }, + "com.amazonaws.apprunner#Integer": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.apprunner#InternalServiceErrorException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.apprunner#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InternalServiceError", + "httpResponseCode": 500 + }, + "smithy.api#documentation": "

An unexpected service exception occurred.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.apprunner#InvalidRequestException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.apprunner#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidRequest", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.apprunner#InvalidStateException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.apprunner#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You can't perform this action when the resource is in its current state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.apprunner#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws(-[\\w]+)*:kms:[a-z\\-]+-[0-9]{1}:[0-9]{12}:key\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + } + }, + "com.amazonaws.apprunner#ListAutoScalingConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#ListAutoScalingConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#ListAutoScalingConfigurationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of active App Runner automatic scaling configurations in your Amazon Web Services account. You can query the revisions for a specific\n configuration name or the revisions for all active configurations in your account. You can optionally query only the latest revision of each requested\n name.

\n

To retrieve a full description of a particular configuration revision, call and provide one of\n the ARNs returned by ListAutoScalingConfigurations.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.apprunner#ListAutoScalingConfigurationsRequest": { + "type": "structure", + "members": { + "AutoScalingConfigurationName": { + "target": "com.amazonaws.apprunner#AutoScalingConfigurationName", + "traits": { + "smithy.api#documentation": "

The name of the App Runner auto scaling configuration that you want to list. If specified, App Runner lists revisions that share this name. If not specified, App Runner\n returns revisions of all active configurations.

" + } + }, + "LatestOnly": { + "target": "com.amazonaws.apprunner#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Set to true to list only the latest revision for each requested configuration name.

\n

Set to false to list all revisions for each requested configuration name.

\n

Default: true\n

" + } + }, + "MaxResults": { + "target": "com.amazonaws.apprunner#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to include in each response (result page). It's used for a paginated request.

\n

If you don't specify MaxResults, the request retrieves all available results in a single response.

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

A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be\n identical to the ones that are specified in the initial request.

\n

If you don't specify NextToken, the request retrieves the first result page.

" + } + } + } + }, + "com.amazonaws.apprunner#ListAutoScalingConfigurationsResponse": { + "type": "structure", + "members": { + "AutoScalingConfigurationSummaryList": { + "target": "com.amazonaws.apprunner#AutoScalingConfigurationSummaryList", + "traits": { + "smithy.api#documentation": "

A list of summary information records for auto scaling configurations. In a paginated request, the request returns up to MaxResults\n records for each call.

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

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

" + } + } + } + }, + "com.amazonaws.apprunner#ListConnections": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#ListConnectionsRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#ListConnectionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of App Runner connections that are associated with your Amazon Web Services account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.apprunner#ListConnectionsRequest": { + "type": "structure", + "members": { + "ConnectionName": { + "target": "com.amazonaws.apprunner#ConnectionName", + "traits": { + "smithy.api#documentation": "

If specified, only this connection is returned. If not specified, the result isn't filtered by name.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.apprunner#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to include in each response (result page). Used for a paginated request.

\n

If you don't specify MaxResults, the request retrieves all available results in a single response.

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

A token from a previous result page. Used for a paginated request. The request retrieves the next result page. All other parameter values must be\n identical to the ones specified in the initial request.

\n

If you don't specify NextToken, the request retrieves the first result page.

" + } + } + } + }, + "com.amazonaws.apprunner#ListConnectionsResponse": { + "type": "structure", + "members": { + "ConnectionSummaryList": { + "target": "com.amazonaws.apprunner#ConnectionSummaryList", + "traits": { + "smithy.api#documentation": "

A list of summary information records for connections. In a paginated request, the request returns up to MaxResults records for each\n call.

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

The token that you can pass in a subsequent request to get the next result page. Returned in a paginated request.

" + } + } + } + }, + "com.amazonaws.apprunner#ListObservabilityConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#ListObservabilityConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#ListObservabilityConfigurationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of active App Runner observability configurations in your Amazon Web Services account. You can query the revisions for a specific\n configuration name or the revisions for all active configurations in your account. You can optionally query only the latest revision of each requested\n name.

\n

To retrieve a full description of a particular configuration revision, call and provide one\n of the ARNs returned by ListObservabilityConfigurations.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.apprunner#ListObservabilityConfigurationsRequest": { + "type": "structure", + "members": { + "ObservabilityConfigurationName": { + "target": "com.amazonaws.apprunner#ObservabilityConfigurationName", + "traits": { + "smithy.api#documentation": "

The name of the App Runner observability configuration that you want to list. If specified, App Runner lists revisions that share this name. If not specified,\n App Runner returns revisions of all active configurations.

" + } + }, + "LatestOnly": { + "target": "com.amazonaws.apprunner#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Set to true to list only the latest revision for each requested configuration name.

\n

Set to false to list all revisions for each requested configuration name.

\n

Default: true\n

" + } + }, + "MaxResults": { + "target": "com.amazonaws.apprunner#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to include in each response (result page). It's used for a paginated request.

\n

If you don't specify MaxResults, the request retrieves all available results in a single response.

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

A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be\n identical to the ones that are specified in the initial request.

\n

If you don't specify NextToken, the request retrieves the first result page.

" + } + } + } + }, + "com.amazonaws.apprunner#ListObservabilityConfigurationsResponse": { + "type": "structure", + "members": { + "ObservabilityConfigurationSummaryList": { + "target": "com.amazonaws.apprunner#ObservabilityConfigurationSummaryList", + "traits": { + "smithy.api#documentation": "

A list of summary information records for observability configurations. In a paginated request, the request returns up to MaxResults\n records for each call.

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

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

" + } + } + } + }, + "com.amazonaws.apprunner#ListOperations": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#ListOperationsRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#ListOperationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Return a list of operations that occurred on an App Runner service.

\n

The resulting list of OperationSummary objects is sorted in reverse chronological order. The first object on the list represents the\n last started operation.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.apprunner#ListOperationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.apprunner#ListOperationsRequest": { + "type": "structure", + "members": { + "ServiceArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner service that you want a list of operations for.

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

A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be\n identical to the ones specified in the initial request.

\n

If you don't specify NextToken, the request retrieves the first result page.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.apprunner#ListOperationsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to include in each response (result page). It's used for a paginated request.

\n

If you don't specify MaxResults, the request retrieves all available results in a single response.

" + } + } + } + }, + "com.amazonaws.apprunner#ListOperationsResponse": { + "type": "structure", + "members": { + "OperationSummaryList": { + "target": "com.amazonaws.apprunner#OperationSummaryList", + "traits": { + "smithy.api#documentation": "

A list of operation summary information records. In a paginated request, the request returns up to MaxResults records for each\n call.

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

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

" + } + } + } + }, + "com.amazonaws.apprunner#ListServices": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#ListServicesRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#ListServicesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of running App Runner services in your Amazon Web Services account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.apprunner#ListServicesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.apprunner#String", + "traits": { + "smithy.api#documentation": "

A token from a previous result page. Used for a paginated request. The request retrieves the next result page. All other parameter values must be\n identical to the ones specified in the initial request.

\n

If you don't specify NextToken, the request retrieves the first result page.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.apprunner#ServiceMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to include in each response (result page). It's used for a paginated request.

\n

If you don't specify MaxResults, the request retrieves all available results in a single response.

" + } + } + } + }, + "com.amazonaws.apprunner#ListServicesResponse": { + "type": "structure", + "members": { + "ServiceSummaryList": { + "target": "com.amazonaws.apprunner#ServiceSummaryList", + "traits": { + "smithy.api#documentation": "

A list of service summary information records. In a paginated request, the request returns up to MaxResults records for each call.

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

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

" + } + } + } + }, + "com.amazonaws.apprunner#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#InvalidStateException" + }, + { + "target": "com.amazonaws.apprunner#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

List tags that are associated with for an App Runner resource. The response contains a list of tag key-value pairs.

" + } + }, + "com.amazonaws.apprunner#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that a tag list is requested for.

\n

It must be the ARN of an App Runner resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.apprunner#TagList", + "traits": { + "smithy.api#documentation": "

A list of the tag key-value pairs that are associated with the resource.

" + } + } + } + }, + "com.amazonaws.apprunner#ListVpcConnectors": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#ListVpcConnectorsRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#ListVpcConnectorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of App Runner VPC connectors in your Amazon Web Services account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.apprunner#ListVpcConnectorsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.apprunner#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to include in each response (result page). It's used for a paginated request.

\n

If you don't specify MaxResults, the request retrieves all available results in a single response.

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

A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be\n identical to the ones that are specified in the initial request.

\n

If you don't specify NextToken, the request retrieves the first result page.

" + } + } + } + }, + "com.amazonaws.apprunner#ListVpcConnectorsResponse": { + "type": "structure", + "members": { + "VpcConnectors": { + "target": "com.amazonaws.apprunner#VpcConnectors", + "traits": { + "smithy.api#documentation": "

A list of information records for VPC connectors. In a paginated request, the request returns up to MaxResults records for each\n call.

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

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

" + } + } + } + }, + "com.amazonaws.apprunner#ListVpcIngressConnections": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#ListVpcIngressConnectionsRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#ListVpcIngressConnectionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

Return a list of App Runner VPC Ingress Connections in your Amazon Web Services account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.apprunner#ListVpcIngressConnectionsFilter": { + "type": "structure", + "members": { + "ServiceArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a service to filter by.\n

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

The ID of a VPC Endpoint to filter by.\n

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

Returns a list of VPC Ingress Connections based on the filter provided. It can return either ServiceArn or VpcEndpointId, or both.

" + } + }, + "com.amazonaws.apprunner#ListVpcIngressConnectionsRequest": { + "type": "structure", + "members": { + "Filter": { + "target": "com.amazonaws.apprunner#ListVpcIngressConnectionsFilter", + "traits": { + "smithy.api#documentation": "

The VPC Ingress Connections to be listed based on either the Service Arn or Vpc Endpoint Id, or both.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.apprunner#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to include in each response (result page). It's used for a paginated request.

\n

If you don't specify MaxResults, the request retrieves all available results in a single response.

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

A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be\n identical to the ones that are specified in the initial request.

\n

If you don't specify NextToken, the request retrieves the first result page.

" + } + } + } + }, + "com.amazonaws.apprunner#ListVpcIngressConnectionsResponse": { + "type": "structure", + "members": { + "VpcIngressConnectionSummaryList": { + "target": "com.amazonaws.apprunner#VpcIngressConnectionSummaryList", + "traits": { + "smithy.api#documentation": "

A list of summary information records for VPC Ingress Connections. In a paginated request, the request returns up to MaxResults records for each call.

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

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

" + } + } + } + }, + "com.amazonaws.apprunner#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.apprunner#Memory": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 4 + }, + "smithy.api#pattern": "^2048|3072|4096|(2|3|4) GB$" + } + }, + "com.amazonaws.apprunner#NetworkConfiguration": { + "type": "structure", + "members": { + "EgressConfiguration": { + "target": "com.amazonaws.apprunner#EgressConfiguration", + "traits": { + "smithy.api#documentation": "

Network configuration settings for outbound message traffic.

" + } + }, + "IngressConfiguration": { + "target": "com.amazonaws.apprunner#IngressConfiguration", + "traits": { + "smithy.api#documentation": "

Network configuration settings for inbound message traffic.

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

Describes configuration settings related to network traffic of an App Runner service. Consists of embedded objects for each configurable network\n feature.

" + } + }, + "com.amazonaws.apprunner#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.apprunner#NullableBoolean": { + "type": "boolean" + }, + "com.amazonaws.apprunner#ObservabilityConfiguration": { + "type": "structure", + "members": { + "ObservabilityConfigurationArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of this observability configuration.

" + } + }, + "ObservabilityConfigurationName": { + "target": "com.amazonaws.apprunner#ObservabilityConfigurationName", + "traits": { + "smithy.api#documentation": "

The customer-provided observability configuration name. It can be used in multiple revisions of a configuration.

" + } + }, + "TraceConfiguration": { + "target": "com.amazonaws.apprunner#TraceConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the tracing feature within this observability configuration. If not specified, tracing isn't enabled.

" + } + }, + "ObservabilityConfigurationRevision": { + "target": "com.amazonaws.apprunner#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The revision of this observability configuration. It's unique among all the active configurations (\"Status\": \"ACTIVE\") that share the\n same ObservabilityConfigurationName.

" + } + }, + "Latest": { + "target": "com.amazonaws.apprunner#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

It's set to true for the configuration with the highest Revision among all configurations that share the same\n ObservabilityConfigurationName. It's set to false otherwise.

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

The current state of the observability configuration. If the status of a configuration revision is INACTIVE, it was deleted and can't be\n used. Inactive configuration revisions are permanently removed some time after they are deleted.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.apprunner#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the observability configuration was created. It's in Unix time stamp format.

" + } + }, + "DeletedAt": { + "target": "com.amazonaws.apprunner#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the observability configuration was deleted. It's in Unix time stamp format.

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

Describes an App Runner observability configuration resource. Multiple revisions of a configuration have the same\n ObservabilityConfigurationName and different ObservabilityConfigurationRevision values.

\n

The resource is designed to configure multiple features (currently one feature, tracing). This type contains optional members that describe the\n configuration of these features (currently one member, TraceConfiguration). If a feature member isn't specified, the feature isn't\n enabled.

" + } + }, + "com.amazonaws.apprunner#ObservabilityConfigurationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 32 + }, + "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9\\-_]{3,31}$" + } + }, + "com.amazonaws.apprunner#ObservabilityConfigurationStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + } + } + }, + "com.amazonaws.apprunner#ObservabilityConfigurationSummary": { + "type": "structure", + "members": { + "ObservabilityConfigurationArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of this observability configuration.

" + } + }, + "ObservabilityConfigurationName": { + "target": "com.amazonaws.apprunner#ObservabilityConfigurationName", + "traits": { + "smithy.api#documentation": "

The customer-provided observability configuration name. It can be used in multiple revisions of a configuration.

" + } + }, + "ObservabilityConfigurationRevision": { + "target": "com.amazonaws.apprunner#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The revision of this observability configuration. It's unique among all the active configurations (\"Status\": \"ACTIVE\") that share the\n same ObservabilityConfigurationName.

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

Provides summary information about an App Runner observability configuration resource.

\n

This type contains limited information about an observability configuration. It includes only identification information, without configuration\n details. It's returned by the ListObservabilityConfigurations action. Complete configuration information is returned by the CreateObservabilityConfiguration, DescribeObservabilityConfiguration, and DeleteObservabilityConfiguration\n actions using the ObservabilityConfiguration type.

" + } + }, + "com.amazonaws.apprunner#ObservabilityConfigurationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.apprunner#ObservabilityConfigurationSummary" + } + }, + "com.amazonaws.apprunner#OperationStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "ROLLBACK_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK_IN_PROGRESS" + } + }, + "ROLLBACK_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK_FAILED" + } + }, + "ROLLBACK_SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK_SUCCEEDED" + } + } + } + }, + "com.amazonaws.apprunner#OperationSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.apprunner#UUID", + "traits": { + "smithy.api#documentation": "

A unique ID of this operation. It's unique in the scope of the App Runner service.

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

The type of operation. It indicates a specific action that occured.

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

The current state of the operation.

" + } + }, + "TargetArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that the operation acted on (for example, an App Runner service).

" + } + }, + "StartedAt": { + "target": "com.amazonaws.apprunner#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the operation started. It's in the Unix time stamp format.

" + } + }, + "EndedAt": { + "target": "com.amazonaws.apprunner#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the operation ended. It's in the Unix time stamp format.

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.apprunner#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the operation was last updated. It's in the Unix time stamp format.

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

Provides summary information for an operation that occurred on an App Runner service.

" + } + }, + "com.amazonaws.apprunner#OperationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.apprunner#OperationSummary" + } + }, + "com.amazonaws.apprunner#OperationType": { + "type": "enum", + "members": { + "START_DEPLOYMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "START_DEPLOYMENT" + } + }, + "CREATE_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_SERVICE" + } + }, + "PAUSE_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAUSE_SERVICE" + } + }, + "RESUME_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESUME_SERVICE" + } + }, + "DELETE_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_SERVICE" + } + } + } + }, + "com.amazonaws.apprunner#PauseService": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#PauseServiceRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#PauseServiceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#InvalidStateException" + }, + { + "target": "com.amazonaws.apprunner#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Pause an active App Runner service. App Runner reduces compute capacity for the service to zero and loses state (for example, ephemeral storage is\n removed).

\n

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations\n call to track the operation's progress.

" + } + }, + "com.amazonaws.apprunner#PauseServiceRequest": { + "type": "structure", + "members": { + "ServiceArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner service that you want to pause.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#PauseServiceResponse": { + "type": "structure", + "members": { + "Service": { + "target": "com.amazonaws.apprunner#Service", + "traits": { + "smithy.api#documentation": "

A description of the App Runner service that this request just paused.

", + "smithy.api#required": {} + } + }, + "OperationId": { + "target": "com.amazonaws.apprunner#UUID", + "traits": { + "smithy.api#documentation": "

The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track\n the operation's progress.

" + } + } + } + }, + "com.amazonaws.apprunner#ProviderType": { + "type": "enum", + "members": { + "GITHUB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GITHUB" + } + } + } + }, + "com.amazonaws.apprunner#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.apprunner#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceNotfound", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.apprunner#ResumeService": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#ResumeServiceRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#ResumeServiceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#InvalidStateException" + }, + { + "target": "com.amazonaws.apprunner#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Resume an active App Runner service. App Runner provisions compute capacity for the service.

\n

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations\n call to track the operation's progress.

" + } + }, + "com.amazonaws.apprunner#ResumeServiceRequest": { + "type": "structure", + "members": { + "ServiceArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner service that you want to resume.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#ResumeServiceResponse": { + "type": "structure", + "members": { + "Service": { + "target": "com.amazonaws.apprunner#Service", + "traits": { + "smithy.api#documentation": "

A description of the App Runner service that this request just resumed.

", + "smithy.api#required": {} + } + }, + "OperationId": { + "target": "com.amazonaws.apprunner#UUID", + "traits": { + "smithy.api#documentation": "

The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track\n the operation's progress.

" + } + } + } + }, + "com.amazonaws.apprunner#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 29, + "max": 1024 + }, + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):iam::[0-9]{12}:(role|role\\/service-role)\\/[\\w+=,.@\\-/]{1,1000}$" + } + }, + "com.amazonaws.apprunner#Runtime": { + "type": "enum", + "members": { + "PYTHON_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PYTHON_3" + } + }, + "NODEJS_12": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NODEJS_12" + } + }, + "NODEJS_14": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NODEJS_14" + } + }, + "CORRETTO_8": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CORRETTO_8" + } + }, + "CORRETTO_11": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CORRETTO_11" + } + }, + "NODEJS_16": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NODEJS_16" + } + }, + "GO_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GO_1" + } + }, + "DOTNET_6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOTNET_6" + } + }, + "PHP_81": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PHP_81" + } + }, + "RUBY_31": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUBY_31" + } + } + } + }, + "com.amazonaws.apprunner#RuntimeEnvironmentSecrets": { + "type": "map", + "key": { + "target": "com.amazonaws.apprunner#RuntimeEnvironmentSecretsName" + }, + "value": { + "target": "com.amazonaws.apprunner#RuntimeEnvironmentSecretsValue" + } + }, + "com.amazonaws.apprunner#RuntimeEnvironmentSecretsName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.apprunner#RuntimeEnvironmentSecretsValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.apprunner#RuntimeEnvironmentVariables": { + "type": "map", + "key": { + "target": "com.amazonaws.apprunner#RuntimeEnvironmentVariablesKey" + }, + "value": { + "target": "com.amazonaws.apprunner#RuntimeEnvironmentVariablesValue" + } + }, + "com.amazonaws.apprunner#RuntimeEnvironmentVariablesKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 51200 + }, + "smithy.api#pattern": ".*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.apprunner#RuntimeEnvironmentVariablesValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 51200 + }, + "smithy.api#pattern": ".*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.apprunner#Service": { + "type": "structure", + "members": { + "ServiceName": { + "target": "com.amazonaws.apprunner#ServiceName", + "traits": { + "smithy.api#documentation": "

The customer-provided service name.

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

An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.

", + "smithy.api#required": {} + } + }, + "ServiceArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of this service.

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

A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.apprunner#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the App Runner service was created. It's in the Unix time stamp format.

", + "smithy.api#required": {} + } + }, + "UpdatedAt": { + "target": "com.amazonaws.apprunner#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the App Runner service was last updated at. It's in the Unix time stamp format.

", + "smithy.api#required": {} + } + }, + "DeletedAt": { + "target": "com.amazonaws.apprunner#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the App Runner service was deleted. It's in the Unix time stamp format.

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

The current state of the App Runner service. These particular values mean the following.

\n ", + "smithy.api#required": {} + } + }, + "SourceConfiguration": { + "target": "com.amazonaws.apprunner#SourceConfiguration", + "traits": { + "smithy.api#documentation": "

The source deployed to the App Runner service. It can be a code or an image repository.

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

The runtime configuration of instances (scaling units) of this service.

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

The encryption key that App Runner uses to encrypt the service logs and the copy of the source repository that App Runner maintains for the service. It can be\n either a customer-provided encryption key or an Amazon Web Services managed key.

" + } + }, + "HealthCheckConfiguration": { + "target": "com.amazonaws.apprunner#HealthCheckConfiguration", + "traits": { + "smithy.api#documentation": "

The settings for the health check that App Runner performs to monitor the health of this service.

" + } + }, + "AutoScalingConfigurationSummary": { + "target": "com.amazonaws.apprunner#AutoScalingConfigurationSummary", + "traits": { + "smithy.api#documentation": "

Summary information for the App Runner automatic scaling configuration resource that's associated with this service.

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

Configuration settings related to network traffic of the web application that this service runs.

", + "smithy.api#required": {} + } + }, + "ObservabilityConfiguration": { + "target": "com.amazonaws.apprunner#ServiceObservabilityConfiguration", + "traits": { + "smithy.api#documentation": "

The observability configuration of this service.

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

Describes an App Runner service. It can describe a service in any state, including deleted services.

\n

This type contains the full information about a service, including configuration details. It's returned by the CreateService, DescribeService, and DeleteService actions. A subset of this\n information is returned by the ListServices action using the ServiceSummary type.

" + } + }, + "com.amazonaws.apprunner#ServiceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 32, + "max": 32 + }, + "smithy.api#pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" + } + }, + "com.amazonaws.apprunner#ServiceMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.apprunner#ServiceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 40 + }, + "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9-_]{3,39}$" + } + }, + "com.amazonaws.apprunner#ServiceObservabilityConfiguration": { + "type": "structure", + "members": { + "ObservabilityEnabled": { + "target": "com.amazonaws.apprunner#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

When true, an observability configuration resource is associated with the service, and an ObservabilityConfigurationArn is\n specified.

", + "smithy.api#required": {} + } + }, + "ObservabilityConfigurationArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the observability configuration that is associated with the service. Specified only when\n ObservabilityEnabled is true.

\n

Specify an ARN with a name and a revision number to associate that revision. For example:\n arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3\n

\n

Specify just the name to associate the latest revision. For example:\n arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing\n

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

Describes the observability configuration of an App Runner service. These are additional observability features, like tracing, that you choose to\n enable. They're configured in a separate resource that you associate with your service.

" + } + }, + "com.amazonaws.apprunner#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.apprunner#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ServiceQuotaExceeded", + "httpResponseCode": 402 + }, + "smithy.api#documentation": "

App Runner can't create this resource. You've reached your account quota for this resource type.

\n

For App Runner per-resource quotas, see App Runner endpoints and quotas in the\n Amazon Web Services General Reference.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.apprunner#ServiceStatus": { + "type": "enum", + "members": { + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + }, + "PAUSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAUSED" + } + }, + "OPERATION_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPERATION_IN_PROGRESS" + } + } + } + }, + "com.amazonaws.apprunner#ServiceSummary": { + "type": "structure", + "members": { + "ServiceName": { + "target": "com.amazonaws.apprunner#ServiceName", + "traits": { + "smithy.api#documentation": "

The customer-provided service name.

" + } + }, + "ServiceId": { + "target": "com.amazonaws.apprunner#ServiceId", + "traits": { + "smithy.api#documentation": "

An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.

" + } + }, + "ServiceArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of this service.

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

A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.apprunner#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the App Runner service was created. It's in the Unix time stamp format.

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.apprunner#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the App Runner service was last updated. It's in theUnix time stamp format.

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

The current state of the App Runner service. These particular values mean the following.

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

Provides summary information for an App Runner service.

\n

This type contains limited information about a service. It doesn't include configuration details. It's returned by the ListServices action. Complete service information is returned by the CreateService, DescribeService, and DeleteService actions using the Service type.

" + } + }, + "com.amazonaws.apprunner#ServiceSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.apprunner#ServiceSummary" + } + }, + "com.amazonaws.apprunner#SourceCodeVersion": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.apprunner#SourceCodeVersionType", + "traits": { + "smithy.api#documentation": "

The type of version identifier.

\n

For a git-based repository, branches represent versions.

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

A source code version.

\n

For a git-based repository, a branch name maps to a specific version. App Runner uses the most recent commit to the branch.

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

Identifies a version of code that App Runner refers to within a source code repository.

" + } + }, + "com.amazonaws.apprunner#SourceCodeVersionType": { + "type": "enum", + "members": { + "BRANCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BRANCH" + } + } + } + }, + "com.amazonaws.apprunner#SourceConfiguration": { + "type": "structure", + "members": { + "CodeRepository": { + "target": "com.amazonaws.apprunner#CodeRepository", + "traits": { + "smithy.api#documentation": "

The description of a source code repository.

\n

You must provide either this member or ImageRepository (but not both).

" + } + }, + "ImageRepository": { + "target": "com.amazonaws.apprunner#ImageRepository", + "traits": { + "smithy.api#documentation": "

The description of a source image\n repository.

\n

You must provide either this member or CodeRepository (but not both).

" + } + }, + "AutoDeploymentsEnabled": { + "target": "com.amazonaws.apprunner#NullableBoolean", + "traits": { + "smithy.api#documentation": "

If true, continuous integration from the source repository is enabled for the App Runner service. Each repository change (including any source\n code commit or new image version) starts a deployment.

\n

Default: App Runner sets to false for a source image that uses an ECR Public repository or an ECR repository that's in an Amazon Web Services account other than the one that the service is in. App Runner sets to true in all other cases (which currently include a source code\n repository or a source image using a same-account ECR repository).

" + } + }, + "AuthenticationConfiguration": { + "target": "com.amazonaws.apprunner#AuthenticationConfiguration", + "traits": { + "smithy.api#documentation": "

Describes the resources that are needed to authenticate access to some source repositories.

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

Describes the source deployed to an App Runner service. It can be a code or an image repository.

" + } + }, + "com.amazonaws.apprunner#StartCommand": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[^\\x0a\\x0d]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.apprunner#StartDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#StartDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#StartDeploymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Initiate a manual deployment of the latest commit in a source code repository or the latest image in a source image repository to an App Runner\n service.

\n

For a source code repository, App Runner retrieves the commit and builds a Docker image. For a source image repository, App Runner retrieves the latest Docker\n image. In both cases, App Runner then deploys the new image to your service and starts a new container instance.

\n

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations\n call to track the operation's progress.

" + } + }, + "com.amazonaws.apprunner#StartDeploymentRequest": { + "type": "structure", + "members": { + "ServiceArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner service that you want to manually deploy to.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#StartDeploymentResponse": { + "type": "structure", + "members": { + "OperationId": { + "target": "com.amazonaws.apprunner#UUID", + "traits": { + "smithy.api#documentation": "

The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track\n the operation's progress.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#String": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 51200 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.apprunner#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.apprunner#String" + } + }, + "com.amazonaws.apprunner#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.apprunner#TagKey", + "traits": { + "smithy.api#documentation": "

The key of the tag.

" + } + }, + "Value": { + "target": "com.amazonaws.apprunner#TagValue", + "traits": { + "smithy.api#documentation": "

The value of the tag.

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

Describes a tag that is applied to an App Runner resource. A tag is a metadata item consisting of a key-value pair.

" + } + }, + "com.amazonaws.apprunner#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:).+$" + } + }, + "com.amazonaws.apprunner#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.apprunner#TagKey" + } + }, + "com.amazonaws.apprunner#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.apprunner#Tag" + } + }, + "com.amazonaws.apprunner#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#InvalidStateException" + }, + { + "target": "com.amazonaws.apprunner#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Add tags to, or update the tag values of, an App Runner resource. A tag is a key-value pair.

" + } + }, + "com.amazonaws.apprunner#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to update tags for.

\n

It must be the ARN of an App Runner resource.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.apprunner#TagList", + "traits": { + "smithy.api#documentation": "

A list of tag key-value pairs to add or update. If a key is new to the resource, the tag is added with the provided value. If a key is already\n associated with the resource, the value of the tag is updated.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.apprunner#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.apprunner#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.apprunner#TraceConfiguration": { + "type": "structure", + "members": { + "Vendor": { + "target": "com.amazonaws.apprunner#TracingVendor", + "traits": { + "smithy.api#documentation": "

The implementation provider chosen for tracing App Runner services.

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

Describes the configuration of the tracing feature within an App Runner observability configuration.

" + } + }, + "com.amazonaws.apprunner#TracingVendor": { + "type": "enum", + "members": { + "AWSXRAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWSXRAY" + } + } + } + }, + "com.amazonaws.apprunner#UUID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" + } + }, + "com.amazonaws.apprunner#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#InvalidStateException" + }, + { + "target": "com.amazonaws.apprunner#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Remove tags from an App Runner resource.

" + } + }, + "com.amazonaws.apprunner#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to remove tags from.

\n

It must be the ARN of an App Runner resource.

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.apprunner#TagKeyList", + "traits": { + "smithy.api#documentation": "

A list of tag keys that you want to remove.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.apprunner#UpdateService": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#UpdateServiceRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#UpdateServiceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#InvalidStateException" + }, + { + "target": "com.amazonaws.apprunner#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Update an App Runner service. You can update the source configuration and instance configuration of the service. You can also update the ARN of the auto\n scaling configuration resource that's associated with the service. However, you can't change the name or the encryption configuration of the service.\n These can be set only when you create the service.

\n

To update the tags applied to your service, use the separate actions TagResource and UntagResource.

\n

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations\n call to track the operation's progress.

" + } + }, + "com.amazonaws.apprunner#UpdateServiceRequest": { + "type": "structure", + "members": { + "ServiceArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the App Runner service that you want to update.

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

The source configuration to apply to the App Runner service.

\n

You can change the configuration of the code or image repository that the service uses. However, you can't switch from code to image or the other way\n around. This means that you must provide the same structure member of SourceConfiguration that you originally included when you created the\n service. Specifically, you can include either CodeRepository or ImageRepository. To update the source configuration, set the\n values to members of the structure that you include.

" + } + }, + "InstanceConfiguration": { + "target": "com.amazonaws.apprunner#InstanceConfiguration", + "traits": { + "smithy.api#documentation": "

The runtime configuration to apply to instances (scaling units) of your service.

" + } + }, + "AutoScalingConfigurationArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with the App Runner service.

" + } + }, + "HealthCheckConfiguration": { + "target": "com.amazonaws.apprunner#HealthCheckConfiguration", + "traits": { + "smithy.api#documentation": "

The settings for the health check that App Runner performs to monitor the health of the App Runner service.

" + } + }, + "NetworkConfiguration": { + "target": "com.amazonaws.apprunner#NetworkConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration settings related to network traffic of the web application that the App Runner service runs.

" + } + }, + "ObservabilityConfiguration": { + "target": "com.amazonaws.apprunner#ServiceObservabilityConfiguration", + "traits": { + "smithy.api#documentation": "

The observability configuration of your service.

" + } + } + } + }, + "com.amazonaws.apprunner#UpdateServiceResponse": { + "type": "structure", + "members": { + "Service": { + "target": "com.amazonaws.apprunner#Service", + "traits": { + "smithy.api#documentation": "

A description of the App Runner service updated by this request. All configuration values in the returned Service structure reflect\n configuration changes that are being applied by this request.

", + "smithy.api#required": {} + } + }, + "OperationId": { + "target": "com.amazonaws.apprunner#UUID", + "traits": { + "smithy.api#documentation": "

The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations call to track\n the operation's progress.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#UpdateVpcIngressConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.apprunner#UpdateVpcIngressConnectionRequest" + }, + "output": { + "target": "com.amazonaws.apprunner#UpdateVpcIngressConnectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.apprunner#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.apprunner#InvalidRequestException" + }, + { + "target": "com.amazonaws.apprunner#InvalidStateException" + }, + { + "target": "com.amazonaws.apprunner#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Update an existing App Runner VPC Ingress Connection resource. The VPC Ingress Connection must be in one of the following states to be updated:

\n " + } + }, + "com.amazonaws.apprunner#UpdateVpcIngressConnectionRequest": { + "type": "structure", + "members": { + "VpcIngressConnectionArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (Arn) for the App Runner VPC Ingress Connection resource that you want to update.

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

Specifications for the customerā€™s Amazon VPC and the related Amazon Web Services PrivateLink VPC endpoint that are used to update the VPC Ingress Connection\n resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#UpdateVpcIngressConnectionResponse": { + "type": "structure", + "members": { + "VpcIngressConnection": { + "target": "com.amazonaws.apprunner#VpcIngressConnection", + "traits": { + "smithy.api#documentation": "

A description of the App Runner VPC Ingress Connection resource that's updated by this request.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.apprunner#VpcConnector": { + "type": "structure", + "members": { + "VpcConnectorName": { + "target": "com.amazonaws.apprunner#VpcConnectorName", + "traits": { + "smithy.api#documentation": "

The customer-provided VPC connector name.

" + } + }, + "VpcConnectorArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of this VPC connector.

" + } + }, + "VpcConnectorRevision": { + "target": "com.amazonaws.apprunner#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The revision of this VPC connector. It's unique among all the active connectors (\"Status\": \"ACTIVE\") that share the same\n Name.

\n \n

At this time, App Runner supports only one revision per name.

\n " + } + }, + "Subnets": { + "target": "com.amazonaws.apprunner#StringList", + "traits": { + "smithy.api#documentation": "

A list of IDs of subnets that App Runner uses for your service. All IDs are of subnets of a single Amazon VPC.

" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.apprunner#StringList", + "traits": { + "smithy.api#documentation": "

A list of IDs of security groups that App Runner uses for access to Amazon Web Services resources under the specified subnets. If not specified, App Runner uses the default\n security group of the Amazon VPC. The default security group allows all outbound traffic.

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

The current state of the VPC connector. If the status of a connector revision is INACTIVE, it was deleted and can't be\n used. Inactive connector revisions are permanently removed some time after they are deleted.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.apprunner#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the VPC connector was created. It's in Unix time stamp format.

" + } + }, + "DeletedAt": { + "target": "com.amazonaws.apprunner#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the VPC connector was deleted. It's in Unix time stamp format.

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

Describes an App Runner VPC connector resource. A VPC connector describes the Amazon Virtual Private Cloud (Amazon VPC) that an App Runner service is\n associated with, and the subnets and security group that are used.

\n

Multiple revisions of a connector might have the same Name and different Revision values.

\n \n

At this time, App Runner supports only one revision per name.

\n " + } + }, + "com.amazonaws.apprunner#VpcConnectorName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 40 + }, + "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9\\-_]{3,39}$" + } + }, + "com.amazonaws.apprunner#VpcConnectorStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + } + } + }, + "com.amazonaws.apprunner#VpcConnectors": { + "type": "list", + "member": { + "target": "com.amazonaws.apprunner#VpcConnector" + } + }, + "com.amazonaws.apprunner#VpcDNSTarget": { + "type": "structure", + "members": { + "VpcIngressConnectionArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC Ingress Connection that is associated with your service.

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

The ID of the Amazon VPC that is associated with the custom domain name of the target DNS.

" + } + }, + "DomainName": { + "target": "com.amazonaws.apprunner#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name of your target DNS that is associated with the Amazon VPC.

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

DNS Target record for a custom domain of this Amazon VPC.

" + } + }, + "com.amazonaws.apprunner#VpcDNSTargetList": { + "type": "list", + "member": { + "target": "com.amazonaws.apprunner#VpcDNSTarget" + } + }, + "com.amazonaws.apprunner#VpcIngressConnection": { + "type": "structure", + "members": { + "VpcIngressConnectionArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC Ingress Connection.\n

" + } + }, + "VpcIngressConnectionName": { + "target": "com.amazonaws.apprunner#VpcIngressConnectionName", + "traits": { + "smithy.api#documentation": "

The customer-provided VPC Ingress Connection name.

" + } + }, + "ServiceArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service associated with the VPC Ingress Connection.\n

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

The current status of the VPC Ingress Connection. \n The VPC Ingress Connection displays one of the following statuses: AVAILABLE, PENDING_CREATION, PENDING_UPDATE, PENDING_DELETION,FAILED_CREATION, FAILED_UPDATE, FAILED_DELETION, and DELETED..\n

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

The Account Id you use to create the VPC Ingress Connection resource.

" + } + }, + "DomainName": { + "target": "com.amazonaws.apprunner#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name associated with the VPC Ingress Connection resource.

" + } + }, + "IngressVpcConfiguration": { + "target": "com.amazonaws.apprunner#IngressVpcConfiguration", + "traits": { + "smithy.api#documentation": "

Specifications for the customerā€™s VPC and related PrivateLink VPC endpoint that are used to associate with the VPC Ingress Connection resource.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.apprunner#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the VPC Ingress Connection was created. It's in the Unix time stamp format.

\n " + } + }, + "DeletedAt": { + "target": "com.amazonaws.apprunner#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the App Runner service was deleted. It's in the Unix time stamp format.

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

The App Runner resource that specifies an App Runner endpoint for incoming traffic. It establishes a connection between a VPC interface endpoint and a App Runner\n service, to make your App Runner service accessible from only within an Amazon VPC.

" + } + }, + "com.amazonaws.apprunner#VpcIngressConnectionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 40 + }, + "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9\\-_]{3,39}$" + } + }, + "com.amazonaws.apprunner#VpcIngressConnectionStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "PENDING_CREATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_CREATION" + } + }, + "PENDING_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_UPDATE" + } + }, + "PENDING_DELETION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_DELETION" + } + }, + "FAILED_CREATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_CREATION" + } + }, + "FAILED_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_UPDATE" + } + }, + "FAILED_DELETION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_DELETION" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + } + }, + "com.amazonaws.apprunner#VpcIngressConnectionSummary": { + "type": "structure", + "members": { + "VpcIngressConnectionArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC Ingress Connection.\n

" + } + }, + "ServiceArn": { + "target": "com.amazonaws.apprunner#AppRunnerResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service associated with the VPC Ingress Connection.\n

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

Provides summary information about an VPC Ingress Connection, which includes its VPC Ingress Connection ARN and its associated Service ARN.

" + } + }, + "com.amazonaws.apprunner#VpcIngressConnectionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.apprunner#VpcIngressConnectionSummary" + } } - }, - "traits": { - "smithy.api#documentation": "

Provides summary information about an VPC Ingress Connection, which includes its VPC Ingress Connection ARN and its associated Service ARN.

" - } - }, - "com.amazonaws.apprunner#VpcIngressConnectionSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.apprunner#VpcIngressConnectionSummary" - } } - } } diff --git a/codegen/sdk-codegen/aws-models/connect.json b/codegen/sdk-codegen/aws-models/connect.json index 372c6c8b4345..6f3c48e89fcb 100644 --- a/codegen/sdk-codegen/aws-models/connect.json +++ b/codegen/sdk-codegen/aws-models/connect.json @@ -1,24597 +1,24609 @@ { - "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.connect#ARN": { - "type": "string" - }, - "com.amazonaws.connect#AccessDeniedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.connect#Message" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "AccessDeniedException", - "httpResponseCode": 403 - }, - "smithy.api#documentation": "

You do not have sufficient permissions to perform this action.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.connect#ActionSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#ActionSummary" - } - }, - "com.amazonaws.connect#ActionSummary": { - "type": "structure", - "members": { - "ActionType": { - "target": "com.amazonaws.connect#ActionType", - "traits": { - "smithy.api#documentation": "

The action type.

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

Information about an action.

" - } - }, - "com.amazonaws.connect#ActionType": { - "type": "enum", - "members": { - "CREATE_TASK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_TASK" - } - }, - "ASSIGN_CONTACT_CATEGORY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASSIGN_CONTACT_CATEGORY" - } - }, - "GENERATE_EVENTBRIDGE_EVENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GENERATE_EVENTBRIDGE_EVENT" - } - }, - "SEND_NOTIFICATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SEND_NOTIFICATION" - } - } - } - }, - "com.amazonaws.connect#AfterContactWorkTimeLimit": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.connect#AgentContactReference": { - "type": "structure", - "members": { - "ContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the contact in this instance of Amazon Connect.

" - } - }, - "Channel": { - "target": "com.amazonaws.connect#Channel", - "traits": { - "smithy.api#documentation": "

The channel of the contact.

" - } - }, - "InitiationMethod": { - "target": "com.amazonaws.connect#ContactInitiationMethod", - "traits": { - "smithy.api#documentation": "

How the contact was initiated.

" - } - }, - "AgentContactState": { - "target": "com.amazonaws.connect#ContactState", - "traits": { - "smithy.api#documentation": "

The state of the contact.

" - } - }, - "StateStartTimestamp": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

The epoch timestamp when the contact state started.

" - } - }, - "ConnectedToAgentTimestamp": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the contact was connected to an agent.

" - } - }, - "Queue": { - "target": "com.amazonaws.connect#QueueReference" - } - }, - "traits": { - "smithy.api#documentation": "

Information about the contact associated to the\n user.

" - } - }, - "com.amazonaws.connect#AgentContactReferenceList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#AgentContactReference" - } - }, - "com.amazonaws.connect#AgentFirstName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.connect#AgentInfo": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#AgentResourceId", - "traits": { - "smithy.api#documentation": "

The identifier of the agent who accepted the contact.

" - } - }, - "ConnectedToAgentTimestamp": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp when the contact was connected to the agent.

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

Information about the agent who accepted the contact.

" - } - }, - "com.amazonaws.connect#AgentLastName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.connect#AgentResourceId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.connect#AgentStatus": { - "type": "structure", - "members": { - "AgentStatusARN": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agent status.

" - } - }, - "AgentStatusId": { - "target": "com.amazonaws.connect#AgentStatusId", - "traits": { - "smithy.api#documentation": "

The identifier of the agent status.

" - } - }, - "Name": { - "target": "com.amazonaws.connect#AgentStatusName", - "traits": { - "smithy.api#documentation": "

The name of the agent status.

" - } - }, - "Description": { - "target": "com.amazonaws.connect#AgentStatusDescription", - "traits": { - "smithy.api#documentation": "

The description of the agent status.

" - } - }, - "Type": { - "target": "com.amazonaws.connect#AgentStatusType", - "traits": { - "smithy.api#documentation": "

The type of agent status.

" - } - }, - "DisplayOrder": { - "target": "com.amazonaws.connect#AgentStatusOrderNumber", - "traits": { - "smithy.api#documentation": "

The display order of the agent status.

" - } - }, - "State": { - "target": "com.amazonaws.connect#AgentStatusState", - "traits": { - "smithy.api#documentation": "

The state of the agent status.

" - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

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

Contains information about an agent status.

" - } - }, - "com.amazonaws.connect#AgentStatusDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 250 - } - } - }, - "com.amazonaws.connect#AgentStatusId": { - "type": "string" - }, - "com.amazonaws.connect#AgentStatusName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 127 - } - } - }, - "com.amazonaws.connect#AgentStatusOrderNumber": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.connect#AgentStatusReference": { - "type": "structure", - "members": { - "StatusStartTimestamp": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

The start timestamp of the agent's status.

" - } - }, - "StatusArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agent's status.

" - } - }, - "StatusName": { - "target": "com.amazonaws.connect#AgentStatusName", - "traits": { - "smithy.api#documentation": "

The name of the agent status.

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

Information about the agent's status.

" - } - }, - "com.amazonaws.connect#AgentStatusState": { - "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.connect#AgentStatusSummary": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#AgentStatusId", - "traits": { - "smithy.api#documentation": "

The identifier for an agent status.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the agent status.

" - } - }, - "Name": { - "target": "com.amazonaws.connect#AgentStatusName", - "traits": { - "smithy.api#documentation": "

The name of the agent status.

" - } - }, - "Type": { - "target": "com.amazonaws.connect#AgentStatusType", - "traits": { - "smithy.api#documentation": "

The type of the agent status.

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

Summary information for an agent status.

" - } - }, - "com.amazonaws.connect#AgentStatusSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#AgentStatusSummary" - } - }, - "com.amazonaws.connect#AgentStatusType": { - "type": "enum", - "members": { - "ROUTABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROUTABLE" - } - }, - "CUSTOM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOM" - } - }, - "OFFLINE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OFFLINE" - } - } - } - }, - "com.amazonaws.connect#AgentStatusTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#AgentStatusType" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 3 - } - } - }, - "com.amazonaws.connect#AgentUsername": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.connect#AgentsMinOneMaxHundred": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#UserId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.connect#AliasArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.connect#AllowedAccessControlTags": { - "type": "map", - "key": { - "target": "com.amazonaws.connect#SecurityProfilePolicyKey" - }, - "value": { - "target": "com.amazonaws.connect#SecurityProfilePolicyValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2 - } - } - }, - "com.amazonaws.connect#AllowedMonitorCapabilities": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#MonitorCapability" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2 - } - } + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] }, - "com.amazonaws.connect#AmazonConnectService": { - "type": "service", - "version": "2017-08-08", - "operations": [ - { - "target": "com.amazonaws.connect#AssociateApprovedOrigin" - }, - { - "target": "com.amazonaws.connect#AssociateBot" - }, - { - "target": "com.amazonaws.connect#AssociateDefaultVocabulary" - }, - { - "target": "com.amazonaws.connect#AssociateInstanceStorageConfig" - }, - { - "target": "com.amazonaws.connect#AssociateLambdaFunction" - }, - { - "target": "com.amazonaws.connect#AssociateLexBot" - }, - { - "target": "com.amazonaws.connect#AssociatePhoneNumberContactFlow" - }, - { - "target": "com.amazonaws.connect#AssociateQueueQuickConnects" - }, - { - "target": "com.amazonaws.connect#AssociateRoutingProfileQueues" - }, - { - "target": "com.amazonaws.connect#AssociateSecurityKey" - }, - { - "target": "com.amazonaws.connect#ClaimPhoneNumber" - }, - { - "target": "com.amazonaws.connect#CreateAgentStatus" - }, - { - "target": "com.amazonaws.connect#CreateContactFlow" - }, - { - "target": "com.amazonaws.connect#CreateContactFlowModule" - }, - { - "target": "com.amazonaws.connect#CreateHoursOfOperation" - }, - { - "target": "com.amazonaws.connect#CreateInstance" - }, - { - "target": "com.amazonaws.connect#CreateIntegrationAssociation" - }, - { - "target": "com.amazonaws.connect#CreateQueue" - }, - { - "target": "com.amazonaws.connect#CreateQuickConnect" - }, - { - "target": "com.amazonaws.connect#CreateRoutingProfile" - }, - { - "target": "com.amazonaws.connect#CreateRule" - }, - { - "target": "com.amazonaws.connect#CreateSecurityProfile" - }, - { - "target": "com.amazonaws.connect#CreateTaskTemplate" - }, - { - "target": "com.amazonaws.connect#CreateTrafficDistributionGroup" - }, - { - "target": "com.amazonaws.connect#CreateUseCase" - }, - { - "target": "com.amazonaws.connect#CreateUser" - }, - { - "target": "com.amazonaws.connect#CreateUserHierarchyGroup" - }, - { - "target": "com.amazonaws.connect#CreateVocabulary" - }, - { - "target": "com.amazonaws.connect#DeleteContactFlow" - }, - { - "target": "com.amazonaws.connect#DeleteContactFlowModule" - }, - { - "target": "com.amazonaws.connect#DeleteHoursOfOperation" - }, - { - "target": "com.amazonaws.connect#DeleteInstance" - }, - { - "target": "com.amazonaws.connect#DeleteIntegrationAssociation" - }, - { - "target": "com.amazonaws.connect#DeleteQuickConnect" - }, - { - "target": "com.amazonaws.connect#DeleteRule" - }, - { - "target": "com.amazonaws.connect#DeleteSecurityProfile" - }, - { - "target": "com.amazonaws.connect#DeleteTaskTemplate" - }, - { - "target": "com.amazonaws.connect#DeleteTrafficDistributionGroup" - }, - { - "target": "com.amazonaws.connect#DeleteUseCase" - }, - { - "target": "com.amazonaws.connect#DeleteUser" - }, - { - "target": "com.amazonaws.connect#DeleteUserHierarchyGroup" - }, - { - "target": "com.amazonaws.connect#DeleteVocabulary" - }, - { - "target": "com.amazonaws.connect#DescribeAgentStatus" - }, - { - "target": "com.amazonaws.connect#DescribeContact" - }, - { - "target": "com.amazonaws.connect#DescribeContactFlow" - }, - { - "target": "com.amazonaws.connect#DescribeContactFlowModule" - }, - { - "target": "com.amazonaws.connect#DescribeHoursOfOperation" - }, - { - "target": "com.amazonaws.connect#DescribeInstance" - }, - { - "target": "com.amazonaws.connect#DescribeInstanceAttribute" - }, - { - "target": "com.amazonaws.connect#DescribeInstanceStorageConfig" - }, - { - "target": "com.amazonaws.connect#DescribePhoneNumber" - }, - { - "target": "com.amazonaws.connect#DescribeQueue" - }, - { - "target": "com.amazonaws.connect#DescribeQuickConnect" - }, - { - "target": "com.amazonaws.connect#DescribeRoutingProfile" - }, - { - "target": "com.amazonaws.connect#DescribeRule" - }, - { - "target": "com.amazonaws.connect#DescribeSecurityProfile" - }, - { - "target": "com.amazonaws.connect#DescribeTrafficDistributionGroup" - }, - { - "target": "com.amazonaws.connect#DescribeUser" - }, - { - "target": "com.amazonaws.connect#DescribeUserHierarchyGroup" - }, - { - "target": "com.amazonaws.connect#DescribeUserHierarchyStructure" - }, - { - "target": "com.amazonaws.connect#DescribeVocabulary" - }, - { - "target": "com.amazonaws.connect#DisassociateApprovedOrigin" - }, - { - "target": "com.amazonaws.connect#DisassociateBot" - }, - { - "target": "com.amazonaws.connect#DisassociateInstanceStorageConfig" - }, - { - "target": "com.amazonaws.connect#DisassociateLambdaFunction" - }, - { - "target": "com.amazonaws.connect#DisassociateLexBot" - }, - { - "target": "com.amazonaws.connect#DisassociatePhoneNumberContactFlow" + "shapes": { + "com.amazonaws.connect#ARN": { + "type": "string" }, - { - "target": "com.amazonaws.connect#DisassociateQueueQuickConnects" - }, - { - "target": "com.amazonaws.connect#DisassociateRoutingProfileQueues" - }, - { - "target": "com.amazonaws.connect#DisassociateSecurityKey" - }, - { - "target": "com.amazonaws.connect#DismissUserContact" - }, - { - "target": "com.amazonaws.connect#GetContactAttributes" - }, - { - "target": "com.amazonaws.connect#GetCurrentMetricData" - }, - { - "target": "com.amazonaws.connect#GetCurrentUserData" - }, - { - "target": "com.amazonaws.connect#GetFederationToken" - }, - { - "target": "com.amazonaws.connect#GetMetricData" + "com.amazonaws.connect#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AccessDeniedException", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

You do not have sufficient permissions to perform this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } }, - { - "target": "com.amazonaws.connect#GetTaskTemplate" + "com.amazonaws.connect#ActionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ActionSummary" + } }, - { - "target": "com.amazonaws.connect#GetTrafficDistribution" + "com.amazonaws.connect#ActionSummary": { + "type": "structure", + "members": { + "ActionType": { + "target": "com.amazonaws.connect#ActionType", + "traits": { + "smithy.api#documentation": "

The action type.

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

Information about an action.

" + } }, - { - "target": "com.amazonaws.connect#ListAgentStatuses" + "com.amazonaws.connect#ActionType": { + "type": "enum", + "members": { + "CREATE_TASK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_TASK" + } + }, + "ASSIGN_CONTACT_CATEGORY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSIGN_CONTACT_CATEGORY" + } + }, + "GENERATE_EVENTBRIDGE_EVENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GENERATE_EVENTBRIDGE_EVENT" + } + }, + "SEND_NOTIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEND_NOTIFICATION" + } + } + } }, - { - "target": "com.amazonaws.connect#ListApprovedOrigins" + "com.amazonaws.connect#AfterContactWorkTimeLimit": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } }, - { - "target": "com.amazonaws.connect#ListBots" + "com.amazonaws.connect#AgentContactReference": { + "type": "structure", + "members": { + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact in this instance of Amazon Connect.

" + } + }, + "Channel": { + "target": "com.amazonaws.connect#Channel", + "traits": { + "smithy.api#documentation": "

The channel of the contact.

" + } + }, + "InitiationMethod": { + "target": "com.amazonaws.connect#ContactInitiationMethod", + "traits": { + "smithy.api#documentation": "

How the contact was initiated.

" + } + }, + "AgentContactState": { + "target": "com.amazonaws.connect#ContactState", + "traits": { + "smithy.api#documentation": "

The state of the contact.

" + } + }, + "StateStartTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The epoch timestamp when the contact state started.

" + } + }, + "ConnectedToAgentTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the contact was connected to an agent.

" + } + }, + "Queue": { + "target": "com.amazonaws.connect#QueueReference" + } + }, + "traits": { + "smithy.api#documentation": "

Information about the contact associated to the\n user.

" + } }, - { - "target": "com.amazonaws.connect#ListContactFlowModules" + "com.amazonaws.connect#AgentContactReferenceList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#AgentContactReference" + } }, - { - "target": "com.amazonaws.connect#ListContactFlows" + "com.amazonaws.connect#AgentFirstName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } }, - { - "target": "com.amazonaws.connect#ListContactReferences" + "com.amazonaws.connect#AgentInfo": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#AgentResourceId", + "traits": { + "smithy.api#documentation": "

The identifier of the agent who accepted the contact.

" + } + }, + "ConnectedToAgentTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the contact was connected to the agent.

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

Information about the agent who accepted the contact.

" + } }, - { - "target": "com.amazonaws.connect#ListDefaultVocabularies" + "com.amazonaws.connect#AgentLastName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } }, - { - "target": "com.amazonaws.connect#ListHoursOfOperations" + "com.amazonaws.connect#AgentResourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } }, - { - "target": "com.amazonaws.connect#ListInstanceAttributes" + "com.amazonaws.connect#AgentStatus": { + "type": "structure", + "members": { + "AgentStatusARN": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agent status.

" + } + }, + "AgentStatusId": { + "target": "com.amazonaws.connect#AgentStatusId", + "traits": { + "smithy.api#documentation": "

The identifier of the agent status.

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

The name of the agent status.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#AgentStatusDescription", + "traits": { + "smithy.api#documentation": "

The description of the agent status.

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

The type of agent status.

" + } + }, + "DisplayOrder": { + "target": "com.amazonaws.connect#AgentStatusOrderNumber", + "traits": { + "smithy.api#documentation": "

The display order of the agent status.

" + } + }, + "State": { + "target": "com.amazonaws.connect#AgentStatusState", + "traits": { + "smithy.api#documentation": "

The state of the agent status.

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

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

Contains information about an agent status.

" + } }, - { - "target": "com.amazonaws.connect#ListInstances" + "com.amazonaws.connect#AgentStatusDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 250 + } + } }, - { - "target": "com.amazonaws.connect#ListInstanceStorageConfigs" + "com.amazonaws.connect#AgentStatusId": { + "type": "string" }, - { - "target": "com.amazonaws.connect#ListIntegrationAssociations" + "com.amazonaws.connect#AgentStatusName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + } + } }, - { - "target": "com.amazonaws.connect#ListLambdaFunctions" + "com.amazonaws.connect#AgentStatusOrderNumber": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } }, - { - "target": "com.amazonaws.connect#ListLexBots" + "com.amazonaws.connect#AgentStatusReference": { + "type": "structure", + "members": { + "StatusStartTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The start timestamp of the agent's status.

" + } + }, + "StatusArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agent's status.

" + } + }, + "StatusName": { + "target": "com.amazonaws.connect#AgentStatusName", + "traits": { + "smithy.api#documentation": "

The name of the agent status.

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

Information about the agent's status.

" + } }, - { - "target": "com.amazonaws.connect#ListPhoneNumbers" + "com.amazonaws.connect#AgentStatusState": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } }, - { - "target": "com.amazonaws.connect#ListPhoneNumbersV2" + "com.amazonaws.connect#AgentStatusSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#AgentStatusId", + "traits": { + "smithy.api#documentation": "

The identifier for an agent status.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the agent status.

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

The name of the agent status.

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

The type of the agent status.

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

Summary information for an agent status.

" + } }, - { - "target": "com.amazonaws.connect#ListPrompts" + "com.amazonaws.connect#AgentStatusSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#AgentStatusSummary" + } }, - { - "target": "com.amazonaws.connect#ListQueueQuickConnects" + "com.amazonaws.connect#AgentStatusType": { + "type": "enum", + "members": { + "ROUTABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROUTABLE" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + }, + "OFFLINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OFFLINE" + } + } + } }, - { - "target": "com.amazonaws.connect#ListQueues" + "com.amazonaws.connect#AgentStatusTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#AgentStatusType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } }, - { - "target": "com.amazonaws.connect#ListQuickConnects" + "com.amazonaws.connect#AgentUsername": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } }, - { - "target": "com.amazonaws.connect#ListRoutingProfileQueues" + "com.amazonaws.connect#AgentsMinOneMaxHundred": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#UserId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } }, - { - "target": "com.amazonaws.connect#ListRoutingProfiles" + "com.amazonaws.connect#AliasArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } }, - { - "target": "com.amazonaws.connect#ListRules" + "com.amazonaws.connect#AllowedAccessControlTags": { + "type": "map", + "key": { + "target": "com.amazonaws.connect#SecurityProfilePolicyKey" + }, + "value": { + "target": "com.amazonaws.connect#SecurityProfilePolicyValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } }, - { - "target": "com.amazonaws.connect#ListSecurityKeys" + "com.amazonaws.connect#AllowedMonitorCapabilities": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#MonitorCapability" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } }, - { - "target": "com.amazonaws.connect#ListSecurityProfilePermissions" - }, - { - "target": "com.amazonaws.connect#ListSecurityProfiles" - }, - { - "target": "com.amazonaws.connect#ListTagsForResource" - }, - { - "target": "com.amazonaws.connect#ListTaskTemplates" - }, - { - "target": "com.amazonaws.connect#ListTrafficDistributionGroups" - }, - { - "target": "com.amazonaws.connect#ListUseCases" - }, - { - "target": "com.amazonaws.connect#ListUserHierarchyGroups" - }, - { - "target": "com.amazonaws.connect#ListUsers" - }, - { - "target": "com.amazonaws.connect#MonitorContact" - }, - { - "target": "com.amazonaws.connect#PutUserStatus" - }, - { - "target": "com.amazonaws.connect#ReleasePhoneNumber" - }, - { - "target": "com.amazonaws.connect#ReplicateInstance" - }, - { - "target": "com.amazonaws.connect#ResumeContactRecording" - }, - { - "target": "com.amazonaws.connect#SearchAvailablePhoneNumbers" - }, - { - "target": "com.amazonaws.connect#SearchQueues" - }, - { - "target": "com.amazonaws.connect#SearchRoutingProfiles" - }, - { - "target": "com.amazonaws.connect#SearchSecurityProfiles" - }, - { - "target": "com.amazonaws.connect#SearchUsers" - }, - { - "target": "com.amazonaws.connect#SearchVocabularies" - }, - { - "target": "com.amazonaws.connect#StartChatContact" - }, - { - "target": "com.amazonaws.connect#StartContactRecording" - }, - { - "target": "com.amazonaws.connect#StartContactStreaming" - }, - { - "target": "com.amazonaws.connect#StartOutboundVoiceContact" - }, - { - "target": "com.amazonaws.connect#StartTaskContact" - }, - { - "target": "com.amazonaws.connect#StopContact" - }, - { - "target": "com.amazonaws.connect#StopContactRecording" - }, - { - "target": "com.amazonaws.connect#StopContactStreaming" - }, - { - "target": "com.amazonaws.connect#SuspendContactRecording" - }, - { - "target": "com.amazonaws.connect#TagResource" - }, - { - "target": "com.amazonaws.connect#TransferContact" - }, - { - "target": "com.amazonaws.connect#UntagResource" - }, - { - "target": "com.amazonaws.connect#UpdateAgentStatus" - }, - { - "target": "com.amazonaws.connect#UpdateContact" - }, - { - "target": "com.amazonaws.connect#UpdateContactAttributes" - }, - { - "target": "com.amazonaws.connect#UpdateContactFlowContent" - }, - { - "target": "com.amazonaws.connect#UpdateContactFlowMetadata" - }, - { - "target": "com.amazonaws.connect#UpdateContactFlowModuleContent" - }, - { - "target": "com.amazonaws.connect#UpdateContactFlowModuleMetadata" - }, - { - "target": "com.amazonaws.connect#UpdateContactFlowName" - }, - { - "target": "com.amazonaws.connect#UpdateContactSchedule" - }, - { - "target": "com.amazonaws.connect#UpdateHoursOfOperation" - }, - { - "target": "com.amazonaws.connect#UpdateInstanceAttribute" - }, - { - "target": "com.amazonaws.connect#UpdateInstanceStorageConfig" - }, - { - "target": "com.amazonaws.connect#UpdateParticipantRoleConfig" - }, - { - "target": "com.amazonaws.connect#UpdatePhoneNumber" - }, - { - "target": "com.amazonaws.connect#UpdateQueueHoursOfOperation" - }, - { - "target": "com.amazonaws.connect#UpdateQueueMaxContacts" - }, - { - "target": "com.amazonaws.connect#UpdateQueueName" - }, - { - "target": "com.amazonaws.connect#UpdateQueueOutboundCallerConfig" - }, - { - "target": "com.amazonaws.connect#UpdateQueueStatus" - }, - { - "target": "com.amazonaws.connect#UpdateQuickConnectConfig" - }, - { - "target": "com.amazonaws.connect#UpdateQuickConnectName" - }, - { - "target": "com.amazonaws.connect#UpdateRoutingProfileConcurrency" - }, - { - "target": "com.amazonaws.connect#UpdateRoutingProfileDefaultOutboundQueue" - }, - { - "target": "com.amazonaws.connect#UpdateRoutingProfileName" - }, - { - "target": "com.amazonaws.connect#UpdateRoutingProfileQueues" - }, - { - "target": "com.amazonaws.connect#UpdateRule" - }, - { - "target": "com.amazonaws.connect#UpdateSecurityProfile" - }, - { - "target": "com.amazonaws.connect#UpdateTaskTemplate" - }, - { - "target": "com.amazonaws.connect#UpdateTrafficDistribution" - }, - { - "target": "com.amazonaws.connect#UpdateUserHierarchy" - }, - { - "target": "com.amazonaws.connect#UpdateUserHierarchyGroupName" - }, - { - "target": "com.amazonaws.connect#UpdateUserHierarchyStructure" - }, - { - "target": "com.amazonaws.connect#UpdateUserIdentityInfo" - }, - { - "target": "com.amazonaws.connect#UpdateUserPhoneConfig" - }, - { - "target": "com.amazonaws.connect#UpdateUserRoutingProfile" - }, - { - "target": "com.amazonaws.connect#UpdateUserSecurityProfiles" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "Connect", - "arnNamespace": "connect", - "cloudFormationName": "Connect", - "cloudTrailEventSource": "connect.amazonaws.com", - "endpointPrefix": "connect" - }, - "aws.auth#sigv4": { - "name": "connect" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Amazon Connect is a cloud-based contact center solution that you use to set up and\n manage a customer contact center and provide reliable customer engagement at any scale.

\n

Amazon Connect provides metrics and real-time reporting that enable you to optimize\n contact routing. You can also resolve customer issues more efficiently by getting customers in\n touch with the appropriate agents.

\n

There are limits to the number of Amazon Connect resources that you can create. There\n are also limits to the number of requests that you can make per second. For more information, see\n Amazon Connect Service Quotas in the Amazon Connect Administrator\n Guide.

\n

You can connect programmatically to an Amazon Web Services service by using an endpoint. For\n a list of Amazon Connect endpoints, see Amazon Connect Endpoints.

", - "smithy.api#title": "Amazon Connect Service", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": true, - "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": [ + "com.amazonaws.connect#AmazonConnectService": { + "type": "service", + "version": "2017-08-08", + "operations": [ { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "type": "tree", - "rules": [ + "target": "com.amazonaws.connect#AssociateApprovedOrigin" + }, { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "type": "tree", - "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" - } - ] - } - ] + "target": "com.amazonaws.connect#AssociateBot" }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://connect-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" - } - ] + "target": "com.amazonaws.connect#AssociateDefaultVocabulary" }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://connect-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] + "target": "com.amazonaws.connect#AssociateInstanceStorageConfig" }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://connect.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] + "target": "com.amazonaws.connect#AssociateLambdaFunction" }, { - "conditions": [], - "endpoint": { - "url": "https://connect.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://connect-fips.ap-south-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "ap-south-1", - "UseDualStack": true - } - }, - { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://connect-fips.ap-south-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "ap-south-1", - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://connect.ap-south-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "ap-south-1", - "UseDualStack": true - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://connect.ap-south-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "ap-south-1", - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://connect-fips.ca-central-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "ca-central-1", - "UseDualStack": true - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://connect-fips.ca-central-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "ca-central-1", - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://connect.ca-central-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "ca-central-1", - "UseDualStack": true - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://connect.ca-central-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "ca-central-1", - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://connect-fips.eu-central-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "eu-central-1", - "UseDualStack": true - } - }, - { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://connect-fips.eu-central-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "eu-central-1", - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://connect.eu-central-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "eu-central-1", - "UseDualStack": true - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://connect.eu-central-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "eu-central-1", - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://connect-fips.us-west-2.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "us-west-2", - "UseDualStack": true - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://connect-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "us-west-2", - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://connect.us-west-2.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "us-west-2", - "UseDualStack": true - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://connect.us-west-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "us-west-2", - "UseDualStack": false - } - }, - { - "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://connect-fips.af-south-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "af-south-1", - "UseDualStack": true - } - }, - { - "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://connect-fips.af-south-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "af-south-1", - "UseDualStack": false - } - }, - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://connect.af-south-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "af-south-1", - "UseDualStack": true - } - }, - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://connect.af-south-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "af-south-1", - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://connect-fips.eu-west-2.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "eu-west-2", - "UseDualStack": true - } - }, - { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://connect-fips.eu-west-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "eu-west-2", - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://connect.eu-west-2.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "eu-west-2", - "UseDualStack": true - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://connect.eu-west-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "eu-west-2", - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://connect-fips.ap-northeast-2.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "ap-northeast-2", - "UseDualStack": true - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://connect-fips.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "ap-northeast-2", - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://connect.ap-northeast-2.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "ap-northeast-2", - "UseDualStack": true - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://connect.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "ap-northeast-2", - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://connect-fips.ap-northeast-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "ap-northeast-1", - "UseDualStack": true - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://connect-fips.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "ap-northeast-1", - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://connect.ap-northeast-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "ap-northeast-1", - "UseDualStack": true - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://connect.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "ap-northeast-1", - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://connect-fips.us-gov-west-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "us-gov-west-1", - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://connect-fips.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "us-gov-west-1", - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://connect.us-gov-west-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "us-gov-west-1", - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://connect.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "us-gov-west-1", - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://connect-fips.ap-southeast-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "ap-southeast-1", - "UseDualStack": true - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://connect-fips.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "ap-southeast-1", - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://connect.ap-southeast-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "ap-southeast-1", - "UseDualStack": true - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://connect.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "ap-southeast-1", - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://connect-fips.ap-southeast-2.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "ap-southeast-2", - "UseDualStack": true - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://connect-fips.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "ap-southeast-2", - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://connect.ap-southeast-2.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "ap-southeast-2", - "UseDualStack": true - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://connect.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "ap-southeast-2", - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://connect-fips.us-east-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "us-east-1", - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://connect-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "us-east-1", - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://connect.us-east-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "us-east-1", - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://connect.us-east-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "us-east-1", - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "us-east-1", - "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": { - "UseFIPS": true, - "Region": "us-east-1", - "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": { - "UseFIPS": false, - "Region": "us-east-1", - "UseDualStack": true, - "Endpoint": "https://example.com" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.connect#AnswerMachineDetectionConfig": { - "type": "structure", - "members": { - "EnableAnswerMachineDetection": { - "target": "com.amazonaws.connect#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The flag to indicate if answer machine detection analysis needs to be performed for a voice\n call. If set to true, TrafficType must be set as CAMPAIGN.\n

" - } - }, - "AwaitAnswerMachinePrompt": { - "target": "com.amazonaws.connect#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Wait for the answering machine prompt.

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

Configuration of the answering machine detection.

" - } - }, - "com.amazonaws.connect#ApproximateTotalCount": { - "type": "long" - }, - "com.amazonaws.connect#AssignContactCategoryActionDefinition": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

This action must be set if TriggerEventSource is one of the following values:\n OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable |\n OnPostChatAnalysisAvailable. Contact is categorized using the rule name.

\n

\n RuleName is used as ContactCategory.

" - } - }, - "com.amazonaws.connect#AssociateApprovedOrigin": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#AssociateApprovedOriginRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceConflictException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Associates an approved origin to an Amazon Connect instance.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/instance/{InstanceId}/approved-origin", - "code": 200 - } - } - }, - "com.amazonaws.connect#AssociateApprovedOriginRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Origin": { - "target": "com.amazonaws.connect#Origin", - "traits": { - "smithy.api#documentation": "

The domain to add to your allow list.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#AssociateBot": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#AssociateBotRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#LimitExceededException" - }, - { - "target": "com.amazonaws.connect#ResourceConflictException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2\n bot.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/instance/{InstanceId}/bot", - "code": 200 - } - } - }, - "com.amazonaws.connect#AssociateBotRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LexBot": { - "target": "com.amazonaws.connect#LexBot" - }, - "LexV2Bot": { - "target": "com.amazonaws.connect#LexV2Bot", - "traits": { - "smithy.api#documentation": "

The Amazon Lex V2 bot to associate with the instance.

" - } - } - } - }, - "com.amazonaws.connect#AssociateDefaultVocabulary": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#AssociateDefaultVocabularyRequest" - }, - "output": { - "target": "com.amazonaws.connect#AssociateDefaultVocabularyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call\n and real-time analysis sessions for the given language.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/default-vocabulary/{InstanceId}/{LanguageCode}", - "code": 200 - } - } - }, - "com.amazonaws.connect#AssociateDefaultVocabularyRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LanguageCode": { - "target": "com.amazonaws.connect#VocabularyLanguageCode", - "traits": { - "smithy.api#documentation": "

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see \nWhat is Amazon Transcribe?\n

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VocabularyId": { - "target": "com.amazonaws.connect#VocabularyId", - "traits": { - "smithy.api#documentation": "

The identifier of the custom vocabulary. If this is empty, the default is set to none.

" - } - } - } - }, - "com.amazonaws.connect#AssociateDefaultVocabularyResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.connect#AssociateInstanceStorageConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#AssociateInstanceStorageConfigRequest" - }, - "output": { - "target": "com.amazonaws.connect#AssociateInstanceStorageConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceConflictException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Associates a storage resource type for the first time. You can only associate one type of\n storage configuration in a single call. This means, for example, that you can't define an\n instance with multiple S3 buckets for storing chat transcripts.

\n

This API does not create a resource that doesn't exist. It only associates it to the\n instance. Ensure that the resource being specified in the storage configuration, like an S3\n bucket, exists when being used for association.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/instance/{InstanceId}/storage-config", - "code": 200 - } - } - }, - "com.amazonaws.connect#AssociateInstanceStorageConfigRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ResourceType": { - "target": "com.amazonaws.connect#InstanceStorageResourceType", - "traits": { - "smithy.api#documentation": "

A valid resource type.

", - "smithy.api#required": {} - } - }, - "StorageConfig": { - "target": "com.amazonaws.connect#InstanceStorageConfig", - "traits": { - "smithy.api#documentation": "

A valid storage type.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#AssociateInstanceStorageConfigResponse": { - "type": "structure", - "members": { - "AssociationId": { - "target": "com.amazonaws.connect#AssociationId", - "traits": { - "smithy.api#documentation": "

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

" - } - } - } - }, - "com.amazonaws.connect#AssociateLambdaFunction": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#AssociateLambdaFunctionRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceConflictException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Allows the specified Amazon Connect instance to access the specified Lambda\n function.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/instance/{InstanceId}/lambda-function", - "code": 200 - } - } - }, - "com.amazonaws.connect#AssociateLambdaFunctionRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "FunctionArn": { - "target": "com.amazonaws.connect#FunctionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is\n 140.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#AssociateLexBot": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#AssociateLexBotRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceConflictException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Allows the specified Amazon Connect instance to access the specified Amazon Lex bot.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/instance/{InstanceId}/lex-bot", - "code": 200 - } - } - }, - "com.amazonaws.connect#AssociateLexBotRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LexBot": { - "target": "com.amazonaws.connect#LexBot", - "traits": { - "smithy.api#documentation": "

The Amazon Lex bot to associate with the instance.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#AssociatePhoneNumberContactFlow": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#AssociatePhoneNumberContactFlowRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Associates a flow with a phone number claimed to your Amazon Connect instance.

\n \n

If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the\n Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number\n ARN or UUID value for the PhoneNumberId URI request parameter. However, if the\n number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate\n Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN.\n If a UUID is provided\n in\n this scenario, you will receive a\n ResourceNotFoundException.

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/phone-number/{PhoneNumberId}/contact-flow", - "code": 200 - } - } - }, - "com.amazonaws.connect#AssociatePhoneNumberContactFlowRequest": { - "type": "structure", - "members": { - "PhoneNumberId": { - "target": "com.amazonaws.connect#PhoneNumberId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the phone number.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#required": {} - } - }, - "ContactFlowId": { - "target": "com.amazonaws.connect#ContactFlowId", - "traits": { - "smithy.api#documentation": "

The identifier of the flow.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#AssociateQueueQuickConnects": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#AssociateQueueQuickConnectsRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#LimitExceededException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Associates a set of quick connects with a queue.

", - "smithy.api#http": { - "method": "POST", - "uri": "/queues/{InstanceId}/{QueueId}/associate-quick-connects", - "code": 200 - } - } - }, - "com.amazonaws.connect#AssociateQueueQuickConnectsRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "QueueId": { - "target": "com.amazonaws.connect#QueueId", - "traits": { - "smithy.api#documentation": "

The identifier for the queue.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "QuickConnectIds": { - "target": "com.amazonaws.connect#QuickConnectsList", - "traits": { - "smithy.api#documentation": "

The quick connects to associate with this queue.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#AssociateRoutingProfileQueues": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#AssociateRoutingProfileQueuesRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Associates a set of queues with a routing profile.

", - "smithy.api#http": { - "method": "POST", - "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/associate-queues", - "code": 200 - } - } - }, - "com.amazonaws.connect#AssociateRoutingProfileQueuesRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RoutingProfileId": { - "target": "com.amazonaws.connect#RoutingProfileId", - "traits": { - "smithy.api#documentation": "

The identifier of the routing profile.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "QueueConfigs": { - "target": "com.amazonaws.connect#RoutingProfileQueueConfigList", - "traits": { - "smithy.api#documentation": "

The queues to associate with this routing profile.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#AssociateSecurityKey": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#AssociateSecurityKeyRequest" - }, - "output": { - "target": "com.amazonaws.connect#AssociateSecurityKeyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceConflictException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Associates a security key to the instance.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/instance/{InstanceId}/security-key", - "code": 200 - } - } - }, - "com.amazonaws.connect#AssociateSecurityKeyRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Key": { - "target": "com.amazonaws.connect#PEM", - "traits": { - "smithy.api#documentation": "

A valid security key in PEM format.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#AssociateSecurityKeyResponse": { - "type": "structure", - "members": { - "AssociationId": { - "target": "com.amazonaws.connect#AssociationId", - "traits": { - "smithy.api#documentation": "

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

" - } - } - } - }, - "com.amazonaws.connect#AssociationId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.connect#AttachmentReference": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.connect#ReferenceKey", - "traits": { - "smithy.api#documentation": "

Identifier of the attachment reference.

" - } - }, - "Value": { - "target": "com.amazonaws.connect#ReferenceValue", - "traits": { - "smithy.api#documentation": "

The location path of the attachment reference.

" - } - }, - "Status": { - "target": "com.amazonaws.connect#ReferenceStatus", - "traits": { - "smithy.api#documentation": "

Status of the attachment reference type.

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

Information about a reference when the referenceType is\n ATTACHMENT. Otherwise, null.

" - } - }, - "com.amazonaws.connect#Attribute": { - "type": "structure", - "members": { - "AttributeType": { - "target": "com.amazonaws.connect#InstanceAttributeType", - "traits": { - "smithy.api#documentation": "

The type of attribute.

" - } - }, - "Value": { - "target": "com.amazonaws.connect#InstanceAttributeValue", - "traits": { - "smithy.api#documentation": "

The value of the attribute.

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

A toggle for an individual feature at the instance level.

" - } - }, - "com.amazonaws.connect#AttributeName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32767 - } - } - }, - "com.amazonaws.connect#AttributeValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 32767 - } - } - }, - "com.amazonaws.connect#Attributes": { - "type": "map", - "key": { - "target": "com.amazonaws.connect#AttributeName" - }, - "value": { - "target": "com.amazonaws.connect#AttributeValue" - } - }, - "com.amazonaws.connect#AttributesList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#Attribute" - } - }, - "com.amazonaws.connect#AutoAccept": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.connect#AvailableNumberSummary": { - "type": "structure", - "members": { - "PhoneNumber": { - "target": "com.amazonaws.connect#PhoneNumber", - "traits": { - "smithy.api#documentation": "

The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

" - } - }, - "PhoneNumberCountryCode": { - "target": "com.amazonaws.connect#PhoneNumberCountryCode", - "traits": { - "smithy.api#documentation": "

The ISO country code.

" - } - }, - "PhoneNumberType": { - "target": "com.amazonaws.connect#PhoneNumberType", - "traits": { - "smithy.api#documentation": "

The type of phone number.

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

Information about available phone numbers.

" - } - }, - "com.amazonaws.connect#AvailableNumbersList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#AvailableNumberSummary" - } - }, - "com.amazonaws.connect#AwsRegion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 8, - "max": 31 - }, - "smithy.api#pattern": "^[a-z]{2}(-[a-z]+){1,2}(-[0-9])?$" - } - }, - "com.amazonaws.connect#Boolean": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.connect#BotName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.connect#BucketName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.connect#CampaignId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.connect#Channel": { - "type": "enum", - "members": { - "VOICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VOICE" - } - }, - "CHAT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CHAT" - } - }, - "TASK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TASK" - } - } - } - }, - "com.amazonaws.connect#ChannelToCountMap": { - "type": "map", - "key": { - "target": "com.amazonaws.connect#Channel" - }, - "value": { - "target": "com.amazonaws.connect#IntegerCount" - } - }, - "com.amazonaws.connect#Channels": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#Channel" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 3 - } - } - }, - "com.amazonaws.connect#ChatContent": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16384 - } - } - }, - "com.amazonaws.connect#ChatContentType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.connect#ChatDurationInMinutes": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 60, - "max": 10080 - } - } - }, - "com.amazonaws.connect#ChatMessage": { - "type": "structure", - "members": { - "ContentType": { - "target": "com.amazonaws.connect#ChatContentType", - "traits": { - "smithy.api#documentation": "

The type of the content. Supported types are text/plain, text/markdown, and application/json.

", - "smithy.api#required": {} - } - }, - "Content": { - "target": "com.amazonaws.connect#ChatContent", - "traits": { - "smithy.api#documentation": "

The content of the chat message.

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

A chat message.

" - } - }, - "com.amazonaws.connect#ChatParticipantRoleConfig": { - "type": "structure", - "members": { - "ParticipantTimerConfigList": { - "target": "com.amazonaws.connect#ParticipantTimerConfigList", - "traits": { - "smithy.api#documentation": "

A list of participant timers. You can specify any unique combination of role and timer type.\n Duplicate entries error out the request with a 400.

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

Configuration information for the chat participant role.

" - } - }, - "com.amazonaws.connect#ChatStreamingConfiguration": { - "type": "structure", - "members": { - "StreamingEndpointArn": { - "target": "com.amazonaws.connect#ChatStreamingEndpointARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the standard Amazon SNS topic. The Amazon Resource Name (ARN) of the streaming endpoint that is used\n to publish real-time message streaming for chat conversations.

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

The streaming configuration, such as the Amazon SNS streaming endpoint.

" - } - }, - "com.amazonaws.connect#ChatStreamingEndpointARN": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 350 - } - } - }, - "com.amazonaws.connect#ClaimPhoneNumber": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ClaimPhoneNumberRequest" - }, - "output": { - "target": "com.amazonaws.connect#ClaimPhoneNumberResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#IdempotencyException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Claims an available phone number to your Amazon Connect instance or traffic distribution\n group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.

\n

For more information about how to use this operation, see Claim a phone number in your\n country and Claim phone\n numbers to traffic distribution groups in the Amazon Connect Administrator\n Guide.

\n \n

You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API\n to verify the status of a previous ClaimPhoneNumber\n operation.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/phone-number/claim", - "code": 200 - } - } - }, - "com.amazonaws.connect#ClaimPhoneNumberRequest": { - "type": "structure", - "members": { - "TargetArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

", - "smithy.api#required": {} - } - }, - "PhoneNumber": { - "target": "com.amazonaws.connect#PhoneNumber", - "traits": { - "smithy.api#documentation": "

The phone number you want to claim. Phone numbers are formatted [+] [country code]\n [subscriber number including area code].

", - "smithy.api#required": {} - } - }, - "PhoneNumberDescription": { - "target": "com.amazonaws.connect#PhoneNumberDescription", - "traits": { - "smithy.api#documentation": "

The description of the phone number.

" - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.connect#ClientToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

\n

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$\n

", - "smithy.api#idempotencyToken": {} - } - } - } - }, - "com.amazonaws.connect#ClaimPhoneNumberResponse": { - "type": "structure", - "members": { - "PhoneNumberId": { - "target": "com.amazonaws.connect#PhoneNumberId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the phone number.

" - } - }, - "PhoneNumberArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the phone number.

" - } - } - } - }, - "com.amazonaws.connect#ClaimedPhoneNumberSummary": { - "type": "structure", - "members": { - "PhoneNumberId": { - "target": "com.amazonaws.connect#PhoneNumberId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the phone number.

" - } - }, - "PhoneNumberArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the phone number.

" - } - }, - "PhoneNumber": { - "target": "com.amazonaws.connect#PhoneNumber", - "traits": { - "smithy.api#documentation": "

The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

" - } - }, - "PhoneNumberCountryCode": { - "target": "com.amazonaws.connect#PhoneNumberCountryCode", - "traits": { - "smithy.api#documentation": "

The ISO country code.

" - } - }, - "PhoneNumberType": { - "target": "com.amazonaws.connect#PhoneNumberType", - "traits": { - "smithy.api#documentation": "

The type of phone number.

" - } - }, - "PhoneNumberDescription": { - "target": "com.amazonaws.connect#PhoneNumberDescription", - "traits": { - "smithy.api#documentation": "

The description of the phone number.

" - } - }, - "TargetArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

" - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" - } - }, - "PhoneNumberStatus": { - "target": "com.amazonaws.connect#PhoneNumberStatus", - "traits": { - "smithy.api#documentation": "

The status of the phone number.

\n \n \n

You will not be billed for the phone number during the 1-day period if number claiming\n fails.

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

Information about a phone number that has been claimed to your Amazon Connect instance\n or traffic distribution group.

" - } - }, - "com.amazonaws.connect#ClientToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.connect#CommonNameLength127": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 127 - } - } - }, - "com.amazonaws.connect#Comparison": { - "type": "enum", - "members": { - "LT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LT" - } - } - } - }, - "com.amazonaws.connect#Concurrency": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.connect#Contact": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the contact.

" - } - }, - "Id": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier for the contact.

" - } - }, - "InitialContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

If this contact is related to other contacts, this is the ID of the initial contact.

" - } - }, - "PreviousContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

If this contact is not the first contact, this is the ID of the previous contact.

" - } - }, - "InitiationMethod": { - "target": "com.amazonaws.connect#ContactInitiationMethod", - "traits": { - "smithy.api#documentation": "

Indicates how the contact was initiated.

" - } - }, - "Name": { - "target": "com.amazonaws.connect#Name", - "traits": { - "smithy.api#documentation": "

The name of the contact.

" - } - }, - "Description": { - "target": "com.amazonaws.connect#Description", - "traits": { - "smithy.api#documentation": "

The description of the contact.

" - } - }, - "Channel": { - "target": "com.amazonaws.connect#Channel", - "traits": { - "smithy.api#documentation": "

How the contact reached your contact center.

" - } - }, - "QueueInfo": { - "target": "com.amazonaws.connect#QueueInfo", - "traits": { - "smithy.api#documentation": "

If this contact was queued, this contains information about the queue.

" - } - }, - "AgentInfo": { - "target": "com.amazonaws.connect#AgentInfo", - "traits": { - "smithy.api#documentation": "

Information about the agent who accepted the contact.

" - } - }, - "InitiationTimestamp": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time this contact was initiated, in UTC time. For INBOUND, this is\n when the contact arrived. For OUTBOUND, this is when the agent began dialing. For\n CALLBACK, this is when the callback contact was created. For TRANSFER\n and QUEUE_TRANSFER, this is when the transfer was initiated. For API,\n this is when the request arrived.

" - } - }, - "DisconnectTimestamp": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp when the customer endpoint disconnected from Amazon Connect.

" - } - }, - "LastUpdateTimestamp": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp when contact was last updated.

" - } - }, - "ScheduledTimestamp": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp, in Unix epoch time format, at which to start running the inbound flow.\n

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

Contains information about a contact.

" - } - }, - "com.amazonaws.connect#ContactFilter": { - "type": "structure", - "members": { - "ContactStates": { - "target": "com.amazonaws.connect#ContactStates", - "traits": { - "smithy.api#documentation": "

A list of up to 9 contact states.

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

Filters user data based on the contact information that is associated to the users. It\n contains a list of contact states.

" - } - }, - "com.amazonaws.connect#ContactFlow": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the flow.

" - } - }, - "Id": { - "target": "com.amazonaws.connect#ContactFlowId", - "traits": { - "smithy.api#documentation": "

The identifier of the flow.

" - } - }, - "Name": { - "target": "com.amazonaws.connect#ContactFlowName", - "traits": { - "smithy.api#documentation": "

The name of the flow.

" - } - }, - "Type": { - "target": "com.amazonaws.connect#ContactFlowType", - "traits": { - "smithy.api#documentation": "

The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator\n Guide.

" - } - }, - "State": { - "target": "com.amazonaws.connect#ContactFlowState", - "traits": { - "smithy.api#documentation": "

The type of flow.

" - } - }, - "Description": { - "target": "com.amazonaws.connect#ContactFlowDescription", - "traits": { - "smithy.api#documentation": "

The description of the flow.

" - } - }, - "Content": { - "target": "com.amazonaws.connect#ContactFlowContent", - "traits": { - "smithy.api#documentation": "

The content of the flow.

" - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

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

Contains information about a flow.

" - } - }, - "com.amazonaws.connect#ContactFlowContent": { - "type": "string" - }, - "com.amazonaws.connect#ContactFlowDescription": { - "type": "string" - }, - "com.amazonaws.connect#ContactFlowId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.connect#ContactFlowModule": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN).

" - } - }, - "Id": { - "target": "com.amazonaws.connect#ContactFlowModuleId", - "traits": { - "smithy.api#documentation": "

The identifier of the flow module.

" - } - }, - "Name": { - "target": "com.amazonaws.connect#ContactFlowModuleName", - "traits": { - "smithy.api#documentation": "

The name of the flow module.

" - } - }, - "Content": { - "target": "com.amazonaws.connect#ContactFlowModuleContent", - "traits": { - "smithy.api#documentation": "

The content of the flow module.

" - } - }, - "Description": { - "target": "com.amazonaws.connect#ContactFlowModuleDescription", - "traits": { - "smithy.api#documentation": "

The description of the flow module.

" - } - }, - "State": { - "target": "com.amazonaws.connect#ContactFlowModuleState", - "traits": { - "smithy.api#documentation": "

The type of flow module.

" - } - }, - "Status": { - "target": "com.amazonaws.connect#ContactFlowModuleStatus", - "traits": { - "smithy.api#documentation": "

The status of the flow module.

" - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

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

Contains information about a flow module.

" - } - }, - "com.amazonaws.connect#ContactFlowModuleContent": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256000 - } - } - }, - "com.amazonaws.connect#ContactFlowModuleDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.connect#ContactFlowModuleId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.connect#ContactFlowModuleName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 127 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.connect#ContactFlowModuleState": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "ARCHIVED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARCHIVED" - } - } - } - }, - "com.amazonaws.connect#ContactFlowModuleStatus": { - "type": "enum", - "members": { - "PUBLISHED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PUBLISHED" - } - }, - "SAVED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SAVED" - } - } - } - }, - "com.amazonaws.connect#ContactFlowModuleSummary": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#ContactFlowModuleId", - "traits": { - "smithy.api#documentation": "

The identifier of the flow module.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the flow module.

" - } - }, - "Name": { - "target": "com.amazonaws.connect#ContactFlowModuleName", - "traits": { - "smithy.api#documentation": "

The name of the flow module.

" - } - }, - "State": { - "target": "com.amazonaws.connect#ContactFlowModuleState", - "traits": { - "smithy.api#documentation": "

The type of flow module.

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

Contains summary information about a flow.

" - } - }, - "com.amazonaws.connect#ContactFlowModulesSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#ContactFlowModuleSummary" - } - }, - "com.amazonaws.connect#ContactFlowName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.connect#ContactFlowNotPublishedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.connect#Message" - } - }, - "traits": { - "smithy.api#documentation": "

The flow has not been published.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.connect#ContactFlowState": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "ARCHIVED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARCHIVED" - } - } - } - }, - "com.amazonaws.connect#ContactFlowSummary": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#ContactFlowId", - "traits": { - "smithy.api#documentation": "

The identifier of the flow.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the flow.

" - } - }, - "Name": { - "target": "com.amazonaws.connect#ContactFlowName", - "traits": { - "smithy.api#documentation": "

The name of the flow.

" - } - }, - "ContactFlowType": { - "target": "com.amazonaws.connect#ContactFlowType", - "traits": { - "smithy.api#documentation": "

The type of flow.

" - } - }, - "ContactFlowState": { - "target": "com.amazonaws.connect#ContactFlowState", - "traits": { - "smithy.api#documentation": "

The type of flow.

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

Contains summary information about a flow.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

" - } - }, - "com.amazonaws.connect#ContactFlowSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#ContactFlowSummary" - } - }, - "com.amazonaws.connect#ContactFlowType": { - "type": "enum", - "members": { - "CONTACT_FLOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTACT_FLOW" - } - }, - "CUSTOMER_QUEUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOMER_QUEUE" - } - }, - "CUSTOMER_HOLD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOMER_HOLD" - } - }, - "CUSTOMER_WHISPER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOMER_WHISPER" - } - }, - "AGENT_HOLD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AGENT_HOLD" - } - }, - "AGENT_WHISPER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AGENT_WHISPER" - } - }, - "OUTBOUND_WHISPER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OUTBOUND_WHISPER" - } - }, - "AGENT_TRANSFER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AGENT_TRANSFER" - } - }, - "QUEUE_TRANSFER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUEUE_TRANSFER" - } - } - } - }, - "com.amazonaws.connect#ContactFlowTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#ContactFlowType" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.connect#ContactId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.connect#ContactInitiationMethod": { - "type": "enum", - "members": { - "INBOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INBOUND" - } - }, - "OUTBOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OUTBOUND" - } - }, - "TRANSFER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TRANSFER" - } - }, - "QUEUE_TRANSFER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUEUE_TRANSFER" - } - }, - "CALLBACK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CALLBACK" - } - }, - "API": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "API" - } - } - } - }, - "com.amazonaws.connect#ContactNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.connect#Message", - "traits": { - "smithy.api#documentation": "

The message.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ContactNotFoundException", - "httpResponseCode": 410 - }, - "smithy.api#documentation": "

The contact with the specified ID is not active or does not exist. Applies to Voice calls\n only, not to Chat, Task, or Voice Callback.

", - "smithy.api#error": "client", - "smithy.api#httpError": 410 - } - }, - "com.amazonaws.connect#ContactReferences": { - "type": "map", - "key": { - "target": "com.amazonaws.connect#ReferenceKey" - }, - "value": { - "target": "com.amazonaws.connect#Reference" - } - }, - "com.amazonaws.connect#ContactState": { - "type": "enum", - "members": { - "INCOMING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INCOMING" - } - }, - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "CONNECTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONNECTING" - } - }, - "CONNECTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONNECTED" - } - }, - "CONNECTED_ONHOLD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONNECTED_ONHOLD" - } - }, - "MISSED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MISSED" - } - }, - "ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ERROR" - } - }, - "ENDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENDED" - } - }, - "REJECTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REJECTED" - } - } - } - }, - "com.amazonaws.connect#ContactStates": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#ContactState" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 9 - } - } - }, - "com.amazonaws.connect#Content": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.connect#ControlPlaneTagFilter": { - "type": "structure", - "members": { - "OrConditions": { - "target": "com.amazonaws.connect#TagOrConditionList", - "traits": { - "smithy.api#documentation": "

A list of conditions which would be applied together with an OR condition.\n

" - } - }, - "AndConditions": { - "target": "com.amazonaws.connect#TagAndConditionList", - "traits": { - "smithy.api#documentation": "

A list of conditions which would be applied together with an AND\n condition.

" - } - }, - "TagCondition": { - "target": "com.amazonaws.connect#TagCondition", - "traits": { - "smithy.api#documentation": "

A leaf node condition which can be used to specify a tag condition.

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

An object that can be used to specify Tag conditions inside the SearchFilter.\n This accepts an OR of AND (List of List) input where:

\n " - } - }, - "com.amazonaws.connect#CreateAgentStatus": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#CreateAgentStatusRequest" - }, - "output": { - "target": "com.amazonaws.connect#CreateAgentStatusResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#DuplicateResourceException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#LimitExceededException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Creates an agent status for the specified Amazon Connect instance.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/agent-status/{InstanceId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#CreateAgentStatusRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.connect#AgentStatusName", - "traits": { - "smithy.api#documentation": "

The name of the status.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.connect#AgentStatusDescription", - "traits": { - "smithy.api#documentation": "

The description of the status.

" - } - }, - "State": { - "target": "com.amazonaws.connect#AgentStatusState", - "traits": { - "smithy.api#documentation": "

The state of the status.

", - "smithy.api#required": {} - } - }, - "DisplayOrder": { - "target": "com.amazonaws.connect#AgentStatusOrderNumber", - "traits": { - "smithy.api#documentation": "

The display order of the status.

" - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" - } - } - } - }, - "com.amazonaws.connect#CreateAgentStatusResponse": { - "type": "structure", - "members": { - "AgentStatusARN": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agent status.

" - } - }, - "AgentStatusId": { - "target": "com.amazonaws.connect#AgentStatusId", - "traits": { - "smithy.api#documentation": "

The identifier of the agent status.

" - } - } - } - }, - "com.amazonaws.connect#CreateContactFlow": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#CreateContactFlowRequest" - }, - "output": { - "target": "com.amazonaws.connect#CreateContactFlowResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#DuplicateResourceException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidContactFlowException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#LimitExceededException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a flow for the specified Amazon Connect instance.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/contact-flows/{InstanceId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#CreateContactFlowModule": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#CreateContactFlowModuleRequest" - }, - "output": { - "target": "com.amazonaws.connect#CreateContactFlowModuleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#DuplicateResourceException" - }, - { - "target": "com.amazonaws.connect#IdempotencyException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidContactFlowModuleException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#LimitExceededException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a flow module for the specified Amazon Connect instance.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/contact-flow-modules/{InstanceId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#CreateContactFlowModuleRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.connect#ContactFlowModuleName", - "traits": { - "smithy.api#documentation": "

The name of the flow module.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.connect#ContactFlowModuleDescription", - "traits": { - "smithy.api#documentation": "

The description of the flow module.

" - } - }, - "Content": { - "target": "com.amazonaws.connect#ContactFlowModuleContent", - "traits": { - "smithy.api#documentation": "

The content of the flow module.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.connect#ClientToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", - "smithy.api#idempotencyToken": {} - } - } - } - }, - "com.amazonaws.connect#CreateContactFlowModuleResponse": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#ContactFlowModuleId", - "traits": { - "smithy.api#documentation": "

The identifier of the flow module.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the flow module.

" - } - } - } - }, - "com.amazonaws.connect#CreateContactFlowRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.connect#ContactFlowName", - "traits": { - "smithy.api#documentation": "

The name of the flow.

", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.connect#ContactFlowType", - "traits": { - "smithy.api#documentation": "

The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator\n Guide.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.connect#ContactFlowDescription", - "traits": { - "smithy.api#documentation": "

The description of the flow.

" - } - }, - "Content": { - "target": "com.amazonaws.connect#ContactFlowContent", - "traits": { - "smithy.api#documentation": "

The content of the flow.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" - } - } - } - }, - "com.amazonaws.connect#CreateContactFlowResponse": { - "type": "structure", - "members": { - "ContactFlowId": { - "target": "com.amazonaws.connect#ContactFlowId", - "traits": { - "smithy.api#documentation": "

The identifier of the flow.

" - } - }, - "ContactFlowArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the flow.

" - } - } - } - }, - "com.amazonaws.connect#CreateHoursOfOperation": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#CreateHoursOfOperationRequest" - }, - "output": { - "target": "com.amazonaws.connect#CreateHoursOfOperationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#DuplicateResourceException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#LimitExceededException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Creates hours of operation.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/hours-of-operations/{InstanceId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#CreateHoursOfOperationRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.connect#CommonNameLength127", - "traits": { - "smithy.api#documentation": "

The name of the hours of operation.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.connect#HoursOfOperationDescription", - "traits": { - "smithy.api#documentation": "

The description of the hours of operation.

" - } - }, - "TimeZone": { - "target": "com.amazonaws.connect#TimeZone", - "traits": { - "smithy.api#documentation": "

The time zone of the hours of operation.

", - "smithy.api#required": {} - } - }, - "Config": { - "target": "com.amazonaws.connect#HoursOfOperationConfigList", - "traits": { - "smithy.api#documentation": "

Configuration information for the hours of operation: day, start time, and end time.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" - } - } - } - }, - "com.amazonaws.connect#CreateHoursOfOperationResponse": { - "type": "structure", - "members": { - "HoursOfOperationId": { - "target": "com.amazonaws.connect#HoursOfOperationId", - "traits": { - "smithy.api#documentation": "

The identifier for the hours of operation.

" - } - }, - "HoursOfOperationArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the hours of operation.

" - } - } - } - }, - "com.amazonaws.connect#CreateInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#CreateInstanceRequest" - }, - "output": { - "target": "com.amazonaws.connect#CreateInstanceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Initiates an Amazon Connect instance with all the supported channels enabled. It does\n not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It\n also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.

\n

Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. \nIf you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. \nYou must wait 30 days before you can restart creating and deleting instances in your account.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/instance", - "code": 200 - } - } - }, - "com.amazonaws.connect#CreateInstanceRequest": { - "type": "structure", - "members": { - "ClientToken": { - "target": "com.amazonaws.connect#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token.

" - } - }, - "IdentityManagementType": { - "target": "com.amazonaws.connect#DirectoryType", - "traits": { - "smithy.api#documentation": "

The type of identity management for your Amazon Connect users.

", - "smithy.api#required": {} - } - }, - "InstanceAlias": { - "target": "com.amazonaws.connect#DirectoryAlias", - "traits": { - "smithy.api#documentation": "

The name for your instance.

" - } - }, - "DirectoryId": { - "target": "com.amazonaws.connect#DirectoryId", - "traits": { - "smithy.api#documentation": "

The identifier for the directory.

" - } - }, - "InboundCallsEnabled": { - "target": "com.amazonaws.connect#InboundCallsEnabled", - "traits": { - "smithy.api#documentation": "

Your contact center handles incoming contacts.

", - "smithy.api#required": {} - } - }, - "OutboundCallsEnabled": { - "target": "com.amazonaws.connect#OutboundCallsEnabled", - "traits": { - "smithy.api#documentation": "

Your contact center allows outbound calls.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#CreateInstanceResponse": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier for the instance.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance.

" - } - } - } - }, - "com.amazonaws.connect#CreateIntegrationAssociation": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#CreateIntegrationAssociationRequest" - }, - "output": { - "target": "com.amazonaws.connect#CreateIntegrationAssociationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#DuplicateResourceException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an Amazon Web Services resource association with an Amazon Connect\n instance.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/instance/{InstanceId}/integration-associations", - "code": 200 - } - } - }, - "com.amazonaws.connect#CreateIntegrationAssociationRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "IntegrationType": { - "target": "com.amazonaws.connect#IntegrationType", - "traits": { - "smithy.api#documentation": "

The type of information to be ingested.

", - "smithy.api#required": {} - } - }, - "IntegrationArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the integration.

\n \n

When integrating with Amazon Pinpoint, the Amazon Connect and Amazon Pinpoint\n instances must be in the same account.

\n ", - "smithy.api#required": {} - } - }, - "SourceApplicationUrl": { - "target": "com.amazonaws.connect#URI", - "traits": { - "smithy.api#documentation": "

The URL for the external application. This field is only required for the EVENT integration type.

" - } - }, - "SourceApplicationName": { - "target": "com.amazonaws.connect#SourceApplicationName", - "traits": { - "smithy.api#documentation": "

The name of the external application. This field is only required for the EVENT integration type.

" - } - }, - "SourceType": { - "target": "com.amazonaws.connect#SourceType", - "traits": { - "smithy.api#documentation": "

The type of the data source. This field is only required for the EVENT integration type.

" - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" - } - } - } - }, - "com.amazonaws.connect#CreateIntegrationAssociationResponse": { - "type": "structure", - "members": { - "IntegrationAssociationId": { - "target": "com.amazonaws.connect#IntegrationAssociationId", - "traits": { - "smithy.api#documentation": "

The identifier for the integration association.

" - } - }, - "IntegrationAssociationArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the association.

" - } - } - } - }, - "com.amazonaws.connect#CreateQueue": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#CreateQueueRequest" - }, - "output": { - "target": "com.amazonaws.connect#CreateQueueResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#DuplicateResourceException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#LimitExceededException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Creates a new queue for the specified Amazon Connect instance.

\n \n

If the number being used in the input is claimed to a traffic distribution group, and you are calling this API\n using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use\n either a full phone number ARN or UUID value for the OutboundCallerIdNumberId value\n of the OutboundCallerConfig request body parameter. However, if the number is claimed to a\n traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region\n associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided\n in\n this scenario, you will receive a\n ResourceNotFoundException.

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/queues/{InstanceId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#CreateQueueRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.connect#CommonNameLength127", - "traits": { - "smithy.api#documentation": "

The name of the queue.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.connect#QueueDescription", - "traits": { - "smithy.api#documentation": "

The description of the queue.

" - } - }, - "OutboundCallerConfig": { - "target": "com.amazonaws.connect#OutboundCallerConfig", - "traits": { - "smithy.api#documentation": "

The outbound caller ID name, number, and outbound whisper flow.

" - } - }, - "HoursOfOperationId": { - "target": "com.amazonaws.connect#HoursOfOperationId", - "traits": { - "smithy.api#documentation": "

The identifier for the hours of operation.

", - "smithy.api#required": {} - } - }, - "MaxContacts": { - "target": "com.amazonaws.connect#QueueMaxContacts", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of contacts that can be in the queue before it is considered full.

" - } - }, - "QuickConnectIds": { - "target": "com.amazonaws.connect#QuickConnectsList", - "traits": { - "smithy.api#documentation": "

The quick connects available to agents who are working the queue.

" - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" - } - } - } - }, - "com.amazonaws.connect#CreateQueueResponse": { - "type": "structure", - "members": { - "QueueArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the queue.

" - } - }, - "QueueId": { - "target": "com.amazonaws.connect#QueueId", - "traits": { - "smithy.api#documentation": "

The identifier for the queue.

" - } - } - } - }, - "com.amazonaws.connect#CreateQuickConnect": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#CreateQuickConnectRequest" - }, - "output": { - "target": "com.amazonaws.connect#CreateQuickConnectResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#DuplicateResourceException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#LimitExceededException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a quick connect for the specified Amazon Connect instance.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/quick-connects/{InstanceId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#CreateQuickConnectRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.connect#QuickConnectName", - "traits": { - "smithy.api#documentation": "

The name of the quick connect.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.connect#QuickConnectDescription", - "traits": { - "smithy.api#documentation": "

The description of the quick connect.

" - } - }, - "QuickConnectConfig": { - "target": "com.amazonaws.connect#QuickConnectConfig", - "traits": { - "smithy.api#documentation": "

Configuration settings for the quick connect.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" - } - } - } - }, - "com.amazonaws.connect#CreateQuickConnectResponse": { - "type": "structure", - "members": { - "QuickConnectARN": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the quick connect.

" - } - }, - "QuickConnectId": { - "target": "com.amazonaws.connect#QuickConnectId", - "traits": { - "smithy.api#documentation": "

The identifier for the quick connect.

" - } - } - } - }, - "com.amazonaws.connect#CreateRoutingProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#CreateRoutingProfileRequest" - }, - "output": { - "target": "com.amazonaws.connect#CreateRoutingProfileResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#DuplicateResourceException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#LimitExceededException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new routing profile.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/routing-profiles/{InstanceId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#CreateRoutingProfileRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.connect#RoutingProfileName", - "traits": { - "smithy.api#documentation": "

The name of the routing profile. Must not be more than 127 characters.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.connect#RoutingProfileDescription", - "traits": { - "smithy.api#documentation": "

Description of the routing profile. Must not be more than 250 characters.

", - "smithy.api#required": {} - } - }, - "DefaultOutboundQueueId": { - "target": "com.amazonaws.connect#QueueId", - "traits": { - "smithy.api#documentation": "

The default outbound queue for the routing profile.

", - "smithy.api#required": {} - } - }, - "QueueConfigs": { - "target": "com.amazonaws.connect#RoutingProfileQueueConfigList", - "traits": { - "smithy.api#documentation": "

The inbound queues associated with the routing profile. If no queue is added, the agent can\n make only outbound calls.

" - } - }, - "MediaConcurrencies": { - "target": "com.amazonaws.connect#MediaConcurrencies", - "traits": { - "smithy.api#documentation": "

The channels that agents can handle in the Contact Control Panel (CCP) for this routing\n profile.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" - } - } - } - }, - "com.amazonaws.connect#CreateRoutingProfileResponse": { - "type": "structure", - "members": { - "RoutingProfileArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the routing profile.

" - } - }, - "RoutingProfileId": { - "target": "com.amazonaws.connect#RoutingProfileId", - "traits": { - "smithy.api#documentation": "

The identifier of the routing profile.

" - } - } - } - }, - "com.amazonaws.connect#CreateRule": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#CreateRuleRequest" - }, - "output": { - "target": "com.amazonaws.connect#CreateRuleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceConflictException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a rule for the specified Amazon Connect instance.

\n

Use the Rules Function language to code conditions for the rule.\n

", - "smithy.api#http": { - "method": "POST", - "uri": "/rules/{InstanceId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#CreateRuleRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.connect#RuleName", - "traits": { - "smithy.api#documentation": "

A unique name for the rule.

", - "smithy.api#required": {} - } - }, - "TriggerEventSource": { - "target": "com.amazonaws.connect#RuleTriggerEventSource", - "traits": { - "smithy.api#documentation": "

The event source to trigger the rule.

", - "smithy.api#required": {} - } - }, - "Function": { - "target": "com.amazonaws.connect#RuleFunction", - "traits": { - "smithy.api#documentation": "

The conditions of the rule.

", - "smithy.api#required": {} - } - }, - "Actions": { - "target": "com.amazonaws.connect#RuleActions", - "traits": { - "smithy.api#documentation": "

A list of actions to be run when the rule is triggered.

", - "smithy.api#required": {} - } - }, - "PublishStatus": { - "target": "com.amazonaws.connect#RulePublishStatus", - "traits": { - "smithy.api#documentation": "

The publish status of the rule.

", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.connect#ClientToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", - "smithy.api#idempotencyToken": {} - } - } - } - }, - "com.amazonaws.connect#CreateRuleResponse": { - "type": "structure", - "members": { - "RuleArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule.

", - "smithy.api#required": {} - } - }, - "RuleId": { - "target": "com.amazonaws.connect#RuleId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the rule.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#CreateSecurityProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#CreateSecurityProfileRequest" - }, - "output": { - "target": "com.amazonaws.connect#CreateSecurityProfileResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#DuplicateResourceException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#LimitExceededException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Creates a security profile.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/security-profiles/{InstanceId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#CreateSecurityProfileName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 127 - }, - "smithy.api#pattern": "^[ a-zA-Z0-9_@-]+$" - } - }, - "com.amazonaws.connect#CreateSecurityProfileRequest": { - "type": "structure", - "members": { - "SecurityProfileName": { - "target": "com.amazonaws.connect#CreateSecurityProfileName", - "traits": { - "smithy.api#documentation": "

The name of the security profile.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.connect#SecurityProfileDescription", - "traits": { - "smithy.api#documentation": "

The description of the security profile.

" - } - }, - "Permissions": { - "target": "com.amazonaws.connect#PermissionsList", - "traits": { - "smithy.api#documentation": "

Permissions assigned to the security profile. For a list of valid permissions, see List of security\n profile permissions.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" - } - }, - "AllowedAccessControlTags": { - "target": "com.amazonaws.connect#AllowedAccessControlTags", - "traits": { - "smithy.api#documentation": "

The list of tags that a security profile uses to restrict access to resources in Amazon Connect.

" - } - }, - "TagRestrictedResources": { - "target": "com.amazonaws.connect#TagRestrictedResourceList", - "traits": { - "smithy.api#documentation": "

The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following are acceptable ResourceNames: User | SecurityProfile | Queue | \n RoutingProfile\n

" - } - } - } - }, - "com.amazonaws.connect#CreateSecurityProfileResponse": { - "type": "structure", - "members": { - "SecurityProfileId": { - "target": "com.amazonaws.connect#SecurityProfileId", - "traits": { - "smithy.api#documentation": "

The identifier for the security profle.

" - } - }, - "SecurityProfileArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the security profile.

" - } - } - } - }, - "com.amazonaws.connect#CreateTaskTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#CreateTaskTemplateRequest" - }, - "output": { - "target": "com.amazonaws.connect#CreateTaskTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#PropertyValidationException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new task template in the specified Amazon Connect instance.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/instance/{InstanceId}/task/template", - "code": 200 - } - } - }, - "com.amazonaws.connect#CreateTaskTemplateRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.connect#TaskTemplateName", - "traits": { - "smithy.api#documentation": "

The name of the task template.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.connect#TaskTemplateDescription", - "traits": { - "smithy.api#documentation": "

The description of the task template.

" - } - }, - "ContactFlowId": { - "target": "com.amazonaws.connect#ContactFlowId", - "traits": { - "smithy.api#documentation": "

The identifier of the flow that runs by default when a task is created by referencing this template.

" - } - }, - "Constraints": { - "target": "com.amazonaws.connect#TaskTemplateConstraints", - "traits": { - "smithy.api#documentation": "

Constraints that are applicable to the fields listed.

" - } - }, - "Defaults": { - "target": "com.amazonaws.connect#TaskTemplateDefaults", - "traits": { - "smithy.api#documentation": "

The default values for fields when a task is created by referencing this template.

" - } - }, - "Status": { - "target": "com.amazonaws.connect#TaskTemplateStatus", - "traits": { - "smithy.api#documentation": "

Marks a template as ACTIVE or INACTIVE for a task to refer to it. \nTasks can only be created from ACTIVE templates.\nIf a template is marked as INACTIVE, then a task that refers to this template cannot be created.

" - } - }, - "Fields": { - "target": "com.amazonaws.connect#TaskTemplateFields", - "traits": { - "smithy.api#documentation": "

Fields that are part of the template.

", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.connect#ClientToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", - "smithy.api#idempotencyToken": {} - } - } - } - }, - "com.amazonaws.connect#CreateTaskTemplateResponse": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#TaskTemplateId", - "traits": { - "smithy.api#documentation": "

The identifier of the task template resource.

", - "smithy.api#required": {} - } - }, - "Arn": { - "target": "com.amazonaws.connect#TaskTemplateArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the task template resource.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#CreateTrafficDistributionGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#CreateTrafficDistributionGroupRequest" - }, - "output": { - "target": "com.amazonaws.connect#CreateTrafficDistributionGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceConflictException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ResourceNotReadyException" - }, - { - "target": "com.amazonaws.connect#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a traffic distribution group given an Amazon Connect instance that has been replicated.

\n

For more information about creating traffic distribution groups, see Set up traffic distribution groups in\n the Amazon Connect Administrator Guide.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/traffic-distribution-group", - "code": 200 - } - } - }, - "com.amazonaws.connect#CreateTrafficDistributionGroupRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.connect#Name128", - "traits": { - "smithy.api#documentation": "

The name for the traffic distribution group.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.connect#Description250", - "traits": { - "smithy.api#documentation": "

A description for the traffic distribution group.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceIdOrArn", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance that has been replicated. You can find the\n instanceId in the ARN of the instance.

", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.connect#ClientToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", - "smithy.api#idempotencyToken": {} - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" - } - } - } - }, - "com.amazonaws.connect#CreateTrafficDistributionGroupResponse": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#TrafficDistributionGroupId", - "traits": { - "smithy.api#documentation": "

The identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#TrafficDistributionGroupArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the traffic distribution group.

" - } - } - } - }, - "com.amazonaws.connect#CreateUseCase": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#CreateUseCaseRequest" - }, - "output": { - "target": "com.amazonaws.connect#CreateUseCaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#DuplicateResourceException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a use case for an integration association.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases", - "code": 200 - } - } - }, - "com.amazonaws.connect#CreateUseCaseRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "IntegrationAssociationId": { - "target": "com.amazonaws.connect#IntegrationAssociationId", - "traits": { - "smithy.api#documentation": "

The identifier for the integration association.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "UseCaseType": { - "target": "com.amazonaws.connect#UseCaseType", - "traits": { - "smithy.api#documentation": "

The type of use case to associate to the integration association. Each integration\n association can have only one of each use case type.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" - } - } - } - }, - "com.amazonaws.connect#CreateUseCaseResponse": { - "type": "structure", - "members": { - "UseCaseId": { - "target": "com.amazonaws.connect#UseCaseId", - "traits": { - "smithy.api#documentation": "

The identifier of the use case.

" - } - }, - "UseCaseArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the use case.

" - } - } - } - }, - "com.amazonaws.connect#CreateUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#CreateUserRequest" - }, - "output": { - "target": "com.amazonaws.connect#CreateUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#DuplicateResourceException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#LimitExceededException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a user account for the specified Amazon Connect instance.

\n

For information about how to create user accounts using the Amazon Connect console, see\n Add\n Users in the Amazon Connect Administrator Guide.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/users/{InstanceId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#CreateUserHierarchyGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#CreateUserHierarchyGroupRequest" - }, - "output": { - "target": "com.amazonaws.connect#CreateUserHierarchyGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#DuplicateResourceException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#LimitExceededException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new user hierarchy group.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/user-hierarchy-groups/{InstanceId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#CreateUserHierarchyGroupRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.connect#HierarchyGroupName", - "traits": { - "smithy.api#documentation": "

The name of the user hierarchy group. Must not be more than 100 characters.

", - "smithy.api#required": {} - } - }, - "ParentGroupId": { - "target": "com.amazonaws.connect#HierarchyGroupId", - "traits": { - "smithy.api#documentation": "

The identifier for the parent hierarchy group. The user hierarchy is created at level one if\n the parent group ID is null.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" - } - } - } - }, - "com.amazonaws.connect#CreateUserHierarchyGroupResponse": { - "type": "structure", - "members": { - "HierarchyGroupId": { - "target": "com.amazonaws.connect#HierarchyGroupId", - "traits": { - "smithy.api#documentation": "

The identifier of the hierarchy group.

" - } - }, - "HierarchyGroupArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hierarchy group.

" - } - } - } - }, - "com.amazonaws.connect#CreateUserRequest": { - "type": "structure", - "members": { - "Username": { - "target": "com.amazonaws.connect#AgentUsername", - "traits": { - "smithy.api#documentation": "

The user name for the account. For instances not using SAML for identity management, the\n user name can include up to 20 characters. If you are using SAML for identity management, the\n user name can include up to 64 characters from [a-zA-Z0-9_-.\\@]+.

", - "smithy.api#required": {} - } - }, - "Password": { - "target": "com.amazonaws.connect#Password", - "traits": { - "smithy.api#documentation": "

The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.

" - } - }, - "IdentityInfo": { - "target": "com.amazonaws.connect#UserIdentityInfo", - "traits": { - "smithy.api#documentation": "

The information about the identity of the user.

" - } - }, - "PhoneConfig": { - "target": "com.amazonaws.connect#UserPhoneConfig", - "traits": { - "smithy.api#documentation": "

The phone settings for the user.

", - "smithy.api#required": {} - } - }, - "DirectoryUserId": { - "target": "com.amazonaws.connect#DirectoryUserId", - "traits": { - "smithy.api#documentation": "

The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users.\n If you include the identifier, we assume that Amazon Connect cannot access the directory.\n Otherwise, the identity information is used to authenticate users from your directory.

\n

This parameter is required if you are using an existing directory for identity management in\n Amazon Connect when Amazon Connect cannot access your directory to authenticate users.\n If you are using SAML for identity management and include this parameter, an error is\n returned.

" - } - }, - "SecurityProfileIds": { - "target": "com.amazonaws.connect#SecurityProfileIds", - "traits": { - "smithy.api#documentation": "

The identifier of the security profile for the user.

", - "smithy.api#required": {} - } - }, - "RoutingProfileId": { - "target": "com.amazonaws.connect#RoutingProfileId", - "traits": { - "smithy.api#documentation": "

The identifier of the routing profile for the user.

", - "smithy.api#required": {} - } - }, - "HierarchyGroupId": { - "target": "com.amazonaws.connect#HierarchyGroupId", - "traits": { - "smithy.api#documentation": "

The identifier of the hierarchy group for the user.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" - } - } - } - }, - "com.amazonaws.connect#CreateUserResponse": { - "type": "structure", - "members": { - "UserId": { - "target": "com.amazonaws.connect#UserId", - "traits": { - "smithy.api#documentation": "

The identifier of the user account.

" - } - }, - "UserArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user account.

" - } - } - } - }, - "com.amazonaws.connect#CreateVocabulary": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#CreateVocabularyRequest" - }, - "output": { - "target": "com.amazonaws.connect#CreateVocabularyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceConflictException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a custom vocabulary associated with your Amazon Connect instance. You can set a\n custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default\n vocabulary in post-call and real-time contact analysis sessions for that language.

", - "smithy.api#http": { - "method": "POST", - "uri": "/vocabulary/{InstanceId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#CreateVocabularyRequest": { - "type": "structure", - "members": { - "ClientToken": { - "target": "com.amazonaws.connect#ClientToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs. If a create request is received more than once with same client token,\n subsequent requests return the previous response without creating a vocabulary again.

", - "smithy.api#idempotencyToken": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VocabularyName": { - "target": "com.amazonaws.connect#VocabularyName", - "traits": { - "smithy.api#documentation": "

A unique name of the custom vocabulary.

", - "smithy.api#required": {} - } - }, - "LanguageCode": { - "target": "com.amazonaws.connect#VocabularyLanguageCode", - "traits": { - "smithy.api#documentation": "

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see \nWhat is Amazon Transcribe?\n

", - "smithy.api#required": {} - } - }, - "Content": { - "target": "com.amazonaws.connect#VocabularyContent", - "traits": { - "smithy.api#documentation": "

The content of the custom vocabulary in plain-text format with a table of values. Each row\n in the table represents a word or a phrase, described with Phrase, IPA,\n SoundsLike, and DisplayAs fields. Separate the fields with TAB\n characters. The size limit is 50KB. For more information, see Create a custom\n vocabulary using a table.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" - } - } - } - }, - "com.amazonaws.connect#CreateVocabularyResponse": { - "type": "structure", - "members": { - "VocabularyArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom vocabulary.

", - "smithy.api#required": {} - } - }, - "VocabularyId": { - "target": "com.amazonaws.connect#VocabularyId", - "traits": { - "smithy.api#documentation": "

The identifier of the custom vocabulary.

", - "smithy.api#required": {} - } - }, - "State": { - "target": "com.amazonaws.connect#VocabularyState", - "traits": { - "smithy.api#documentation": "

The current state of the custom vocabulary.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#Credentials": { - "type": "structure", - "members": { - "AccessToken": { - "target": "com.amazonaws.connect#SecurityToken", - "traits": { - "smithy.api#documentation": "

An access token generated for a federated user to access Amazon Connect.

" - } - }, - "AccessTokenExpiration": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

A token generated with an expiration time for the session a user is logged in to Amazon Connect.

" - } - }, - "RefreshToken": { - "target": "com.amazonaws.connect#SecurityToken", - "traits": { - "smithy.api#documentation": "

Renews a token generated for a user to access the Amazon Connect instance.

" - } - }, - "RefreshTokenExpiration": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

Renews the expiration timer for a generated token.

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

Contains credentials to use for federation.

" - } - }, - "com.amazonaws.connect#CurrentMetric": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.connect#CurrentMetricName", - "traits": { - "smithy.api#documentation": "

The name of the metric.

" - } - }, - "Unit": { - "target": "com.amazonaws.connect#Unit", - "traits": { - "smithy.api#documentation": "

The unit for the metric.

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

Contains information about a real-time metric. For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator\n Guide.

" - } - }, - "com.amazonaws.connect#CurrentMetricData": { - "type": "structure", - "members": { - "Metric": { - "target": "com.amazonaws.connect#CurrentMetric", - "traits": { - "smithy.api#documentation": "

Information about the metric.

" - } - }, - "Value": { - "target": "com.amazonaws.connect#Value", - "traits": { - "smithy.api#documentation": "

The value of the metric.

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

Contains the data for a real-time metric.

" - } - }, - "com.amazonaws.connect#CurrentMetricDataCollections": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#CurrentMetricData" - } - }, - "com.amazonaws.connect#CurrentMetricName": { - "type": "enum", - "members": { - "AGENTS_ONLINE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AGENTS_ONLINE" - } - }, - "AGENTS_AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AGENTS_AVAILABLE" - } - }, - "AGENTS_ON_CALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AGENTS_ON_CALL" - } - }, - "AGENTS_NON_PRODUCTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AGENTS_NON_PRODUCTIVE" - } - }, - "AGENTS_AFTER_CONTACT_WORK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AGENTS_AFTER_CONTACT_WORK" - } - }, - "AGENTS_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AGENTS_ERROR" - } - }, - "AGENTS_STAFFED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AGENTS_STAFFED" - } - }, - "CONTACTS_IN_QUEUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTACTS_IN_QUEUE" - } - }, - "OLDEST_CONTACT_AGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OLDEST_CONTACT_AGE" - } - }, - "CONTACTS_SCHEDULED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTACTS_SCHEDULED" - } - }, - "AGENTS_ON_CONTACT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AGENTS_ON_CONTACT" - } - }, - "SLOTS_ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SLOTS_ACTIVE" - } - }, - "SLOTS_AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SLOTS_AVAILABLE" - } - } - }, - "traits": { - "smithy.api#documentation": "

The current metric names.

" - } - }, - "com.amazonaws.connect#CurrentMetricResult": { - "type": "structure", - "members": { - "Dimensions": { - "target": "com.amazonaws.connect#Dimensions", - "traits": { - "smithy.api#documentation": "

The dimensions for the metrics.

" - } - }, - "Collections": { - "target": "com.amazonaws.connect#CurrentMetricDataCollections", - "traits": { - "smithy.api#documentation": "

The set of metrics.

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

Contains information about a set of real-time metrics.

" - } - }, - "com.amazonaws.connect#CurrentMetricResults": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#CurrentMetricResult" - } - }, - "com.amazonaws.connect#CurrentMetricSortCriteria": { - "type": "structure", - "members": { - "SortByMetric": { - "target": "com.amazonaws.connect#CurrentMetricName" - }, - "SortOrder": { - "target": "com.amazonaws.connect#SortOrder", - "traits": { - "smithy.api#documentation": "

The way to sort.

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

The way to sort the resulting response based on metrics. By default resources are sorted\n based on AGENTS_ONLINE, DESCENDING. The metric collection is sorted\n based on the input metrics.

" - } - }, - "com.amazonaws.connect#CurrentMetricSortCriteriaMaxOne": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#CurrentMetricSortCriteria" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.connect#CurrentMetrics": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#CurrentMetric" - } - }, - "com.amazonaws.connect#DateReference": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.connect#ReferenceKey", - "traits": { - "smithy.api#documentation": "

Identifier of the date reference.

" - } - }, - "Value": { - "target": "com.amazonaws.connect#ReferenceValue", - "traits": { - "smithy.api#documentation": "

A valid date.

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

Information about a reference when the referenceType is DATE.\n Otherwise, null.

" - } - }, - "com.amazonaws.connect#DefaultVocabulary": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#required": {} - } - }, - "LanguageCode": { - "target": "com.amazonaws.connect#VocabularyLanguageCode", - "traits": { - "smithy.api#documentation": "

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see \nWhat is Amazon Transcribe?\n

", - "smithy.api#required": {} - } - }, - "VocabularyId": { - "target": "com.amazonaws.connect#VocabularyId", - "traits": { - "smithy.api#documentation": "

The identifier of the custom vocabulary.

", - "smithy.api#required": {} - } - }, - "VocabularyName": { - "target": "com.amazonaws.connect#VocabularyName", - "traits": { - "smithy.api#documentation": "

A unique name of the custom vocabulary.

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

Contains information about a default vocabulary.

" - } - }, - "com.amazonaws.connect#DefaultVocabularyList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#DefaultVocabulary" - } - }, - "com.amazonaws.connect#Delay": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 9999 - } - } - }, - "com.amazonaws.connect#DeleteContactFlow": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DeleteContactFlowRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a flow for the specified Amazon Connect instance.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/contact-flows/{InstanceId}/{ContactFlowId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DeleteContactFlowModule": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DeleteContactFlowModuleRequest" - }, - "output": { - "target": "com.amazonaws.connect#DeleteContactFlowModuleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified flow module.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DeleteContactFlowModuleRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContactFlowModuleId": { - "target": "com.amazonaws.connect#ContactFlowModuleId", - "traits": { - "smithy.api#documentation": "

The identifier of the flow module.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DeleteContactFlowModuleResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.connect#DeleteContactFlowRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContactFlowId": { - "target": "com.amazonaws.connect#ContactFlowId", - "traits": { - "smithy.api#documentation": "

The identifier of the flow.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DeleteHoursOfOperation": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DeleteHoursOfOperationRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Deletes an hours of operation.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DeleteHoursOfOperationRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "HoursOfOperationId": { - "target": "com.amazonaws.connect#HoursOfOperationId", - "traits": { - "smithy.api#documentation": "

The identifier for the hours of operation.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DeleteInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DeleteInstanceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Deletes the Amazon Connect instance.

\n

Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. \nIf you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. \nYou must wait 30 days before you can restart creating and deleting instances in your account.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/instance/{InstanceId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DeleteInstanceRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DeleteIntegrationAssociation": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DeleteIntegrationAssociationRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an Amazon Web Services resource association from an Amazon Connect instance. The\n association must not have any use cases associated with it.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DeleteIntegrationAssociationRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "IntegrationAssociationId": { - "target": "com.amazonaws.connect#IntegrationAssociationId", - "traits": { - "smithy.api#documentation": "

The identifier for the integration association.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DeleteQuickConnect": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DeleteQuickConnectRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a quick connect.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/quick-connects/{InstanceId}/{QuickConnectId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DeleteQuickConnectRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "QuickConnectId": { - "target": "com.amazonaws.connect#QuickConnectId", - "traits": { - "smithy.api#documentation": "

The identifier for the quick connect.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DeleteRule": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DeleteRuleRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a rule for the specified Amazon Connect instance.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/rules/{InstanceId}/{RuleId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DeleteRuleRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RuleId": { - "target": "com.amazonaws.connect#RuleId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the rule.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DeleteSecurityProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DeleteSecurityProfileRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceInUseException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Deletes a security profile.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/security-profiles/{InstanceId}/{SecurityProfileId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DeleteSecurityProfileRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SecurityProfileId": { - "target": "com.amazonaws.connect#SecurityProfileId", - "traits": { - "smithy.api#documentation": "

The identifier for the security profle.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DeleteTaskTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DeleteTaskTemplateRequest" - }, - "output": { - "target": "com.amazonaws.connect#DeleteTaskTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the task template.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/instance/{InstanceId}/task/template/{TaskTemplateId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DeleteTaskTemplateRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TaskTemplateId": { - "target": "com.amazonaws.connect#TaskTemplateId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the task template.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DeleteTaskTemplateResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.connect#DeleteTrafficDistributionGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DeleteTrafficDistributionGroupRequest" - }, - "output": { - "target": "com.amazonaws.connect#DeleteTrafficDistributionGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceInUseException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is\n created.

\n

For more information about deleting traffic distribution groups, see Delete traffic distribution groups in\n the Amazon Connect Administrator Guide.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/traffic-distribution-group/{TrafficDistributionGroupId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DeleteTrafficDistributionGroupRequest": { - "type": "structure", - "members": { - "TrafficDistributionGroupId": { - "target": "com.amazonaws.connect#TrafficDistributionGroupIdOrArn", - "traits": { - "smithy.api#documentation": "

The identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DeleteTrafficDistributionGroupResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.connect#DeleteUseCase": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DeleteUseCaseRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a use case from an integration association.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases/{UseCaseId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DeleteUseCaseRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "IntegrationAssociationId": { - "target": "com.amazonaws.connect#IntegrationAssociationId", - "traits": { - "smithy.api#documentation": "

The identifier for the integration association.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "UseCaseId": { - "target": "com.amazonaws.connect#UseCaseId", - "traits": { - "smithy.api#documentation": "

The identifier for the use case.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DeleteUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DeleteUserRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a user account from the specified Amazon Connect instance.

\n

For information about what happens to a user's data when their account is deleted, see\n Delete Users from\n Your Amazon Connect Instance in the Amazon Connect Administrator\n Guide.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/users/{InstanceId}/{UserId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DeleteUserHierarchyGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DeleteUserHierarchyGroupRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceInUseException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an existing user hierarchy group. It must not be associated with any agents or have\n any active child groups.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DeleteUserHierarchyGroupRequest": { - "type": "structure", - "members": { - "HierarchyGroupId": { - "target": "com.amazonaws.connect#HierarchyGroupId", - "traits": { - "smithy.api#documentation": "

The identifier of the hierarchy group.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DeleteUserRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "UserId": { - "target": "com.amazonaws.connect#UserId", - "traits": { - "smithy.api#documentation": "

The identifier of the user.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DeleteVocabulary": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DeleteVocabularyRequest" - }, - "output": { - "target": "com.amazonaws.connect#DeleteVocabularyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceInUseException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the vocabulary that has the given identifier.

", - "smithy.api#http": { - "method": "POST", - "uri": "/vocabulary-remove/{InstanceId}/{VocabularyId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DeleteVocabularyRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VocabularyId": { - "target": "com.amazonaws.connect#VocabularyId", - "traits": { - "smithy.api#documentation": "

The identifier of the custom vocabulary.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DeleteVocabularyResponse": { - "type": "structure", - "members": { - "VocabularyArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom vocabulary.

", - "smithy.api#required": {} - } - }, - "VocabularyId": { - "target": "com.amazonaws.connect#VocabularyId", - "traits": { - "smithy.api#documentation": "

The identifier of the custom vocabulary.

", - "smithy.api#required": {} - } - }, - "State": { - "target": "com.amazonaws.connect#VocabularyState", - "traits": { - "smithy.api#documentation": "

The current state of the custom vocabulary.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DescribeAgentStatus": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DescribeAgentStatusRequest" - }, - "output": { - "target": "com.amazonaws.connect#DescribeAgentStatusResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Describes an agent status.

", - "smithy.api#http": { - "method": "GET", - "uri": "/agent-status/{InstanceId}/{AgentStatusId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DescribeAgentStatusRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AgentStatusId": { - "target": "com.amazonaws.connect#AgentStatusId", - "traits": { - "smithy.api#documentation": "

The identifier for the agent status.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DescribeAgentStatusResponse": { - "type": "structure", - "members": { - "AgentStatus": { - "target": "com.amazonaws.connect#AgentStatus", - "traits": { - "smithy.api#documentation": "

The agent status.

" - } - } - } - }, - "com.amazonaws.connect#DescribeContact": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DescribeContactRequest" - }, - "output": { - "target": "com.amazonaws.connect#DescribeContactResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Describes the specified contact.

\n \n

Contact information remains available in Amazon Connect for 24 months, and then it is\n deleted.

\n

Only data from November 12, 2021, and later is returned by this\n API.

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/contacts/{InstanceId}/{ContactId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DescribeContactFlow": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DescribeContactFlowRequest" - }, - "output": { - "target": "com.amazonaws.connect#DescribeContactFlowResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#ContactFlowNotPublishedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the specified flow.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

", - "smithy.api#http": { - "method": "GET", - "uri": "/contact-flows/{InstanceId}/{ContactFlowId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DescribeContactFlowModule": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DescribeContactFlowModuleRequest" - }, - "output": { - "target": "com.amazonaws.connect#DescribeContactFlowModuleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the specified flow module.

", - "smithy.api#http": { - "method": "GET", - "uri": "/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DescribeContactFlowModuleRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContactFlowModuleId": { - "target": "com.amazonaws.connect#ContactFlowModuleId", - "traits": { - "smithy.api#documentation": "

The identifier of the flow module.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DescribeContactFlowModuleResponse": { - "type": "structure", - "members": { - "ContactFlowModule": { - "target": "com.amazonaws.connect#ContactFlowModule", - "traits": { - "smithy.api#documentation": "

Information about the flow module.

" - } - } - } - }, - "com.amazonaws.connect#DescribeContactFlowRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContactFlowId": { - "target": "com.amazonaws.connect#ContactFlowId", - "traits": { - "smithy.api#documentation": "

The identifier of the flow.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DescribeContactFlowResponse": { - "type": "structure", - "members": { - "ContactFlow": { - "target": "com.amazonaws.connect#ContactFlow", - "traits": { - "smithy.api#documentation": "

Information about the flow.

" - } - } - } - }, - "com.amazonaws.connect#DescribeContactRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the contact.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DescribeContactResponse": { - "type": "structure", - "members": { - "Contact": { - "target": "com.amazonaws.connect#Contact", - "traits": { - "smithy.api#documentation": "

Information about the contact.

" - } - } - } - }, - "com.amazonaws.connect#DescribeHoursOfOperation": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DescribeHoursOfOperationRequest" - }, - "output": { - "target": "com.amazonaws.connect#DescribeHoursOfOperationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Describes the hours of operation.

", - "smithy.api#http": { - "method": "GET", - "uri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DescribeHoursOfOperationRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "HoursOfOperationId": { - "target": "com.amazonaws.connect#HoursOfOperationId", - "traits": { - "smithy.api#documentation": "

The identifier for the hours of operation.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DescribeHoursOfOperationResponse": { - "type": "structure", - "members": { - "HoursOfOperation": { - "target": "com.amazonaws.connect#HoursOfOperation", - "traits": { - "smithy.api#documentation": "

The hours of operation.

" - } - } - } - }, - "com.amazonaws.connect#DescribeInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DescribeInstanceRequest" - }, - "output": { - "target": "com.amazonaws.connect#DescribeInstanceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Returns the current state of the specified instance identifier. It tracks the instance while\n it is being created and returns an error status, if applicable.

\n

If an instance is not created successfully, the instance status reason field returns details\n relevant to the reason. The instance in a failed state is returned only for 24 hours after the\n CreateInstance API was invoked.

", - "smithy.api#http": { - "method": "GET", - "uri": "/instance/{InstanceId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DescribeInstanceAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DescribeInstanceAttributeRequest" - }, - "output": { - "target": "com.amazonaws.connect#DescribeInstanceAttributeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Describes the specified instance attribute.

", - "smithy.api#http": { - "method": "GET", - "uri": "/instance/{InstanceId}/attribute/{AttributeType}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DescribeInstanceAttributeRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AttributeType": { - "target": "com.amazonaws.connect#InstanceAttributeType", - "traits": { - "smithy.api#documentation": "

The type of attribute.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DescribeInstanceAttributeResponse": { - "type": "structure", - "members": { - "Attribute": { - "target": "com.amazonaws.connect#Attribute", - "traits": { - "smithy.api#documentation": "

The\n type\n of attribute.

" - } - } - } - }, - "com.amazonaws.connect#DescribeInstanceRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DescribeInstanceResponse": { - "type": "structure", - "members": { - "Instance": { - "target": "com.amazonaws.connect#Instance", - "traits": { - "smithy.api#documentation": "

The name of the instance.

" - } - } - } - }, - "com.amazonaws.connect#DescribeInstanceStorageConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DescribeInstanceStorageConfigRequest" - }, - "output": { - "target": "com.amazonaws.connect#DescribeInstanceStorageConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Retrieves the current storage configurations for the specified resource type, association\n ID, and instance ID.

", - "smithy.api#http": { - "method": "GET", - "uri": "/instance/{InstanceId}/storage-config/{AssociationId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DescribeInstanceStorageConfigRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssociationId": { - "target": "com.amazonaws.connect#AssociationId", - "traits": { - "smithy.api#documentation": "

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ResourceType": { - "target": "com.amazonaws.connect#InstanceStorageResourceType", - "traits": { - "smithy.api#documentation": "

A valid resource type.

", - "smithy.api#httpQuery": "resourceType", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DescribeInstanceStorageConfigResponse": { - "type": "structure", - "members": { - "StorageConfig": { - "target": "com.amazonaws.connect#InstanceStorageConfig", - "traits": { - "smithy.api#documentation": "

A valid storage type.

" - } - } - } - }, - "com.amazonaws.connect#DescribePhoneNumber": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DescribePhoneNumberRequest" - }, - "output": { - "target": "com.amazonaws.connect#DescribePhoneNumberResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets details and status of a phone number thatā€™s claimed to your Amazon Connect instance\n or traffic distribution group.

\n \n

If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region\n where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the\n PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group\n and you are calling this API in the alternate Amazon Web Services Region associated with the\n traffic distribution group, you must provide a full phone number ARN. If a UUID is provided\n in\n this scenario, you will receive a\n ResourceNotFoundException.

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/phone-number/{PhoneNumberId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DescribePhoneNumberRequest": { - "type": "structure", - "members": { - "PhoneNumberId": { - "target": "com.amazonaws.connect#PhoneNumberId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the phone number.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DescribePhoneNumberResponse": { - "type": "structure", - "members": { - "ClaimedPhoneNumberSummary": { - "target": "com.amazonaws.connect#ClaimedPhoneNumberSummary", - "traits": { - "smithy.api#documentation": "

Information about a phone number that's been claimed to your Amazon Connect instance or\n traffic distribution group.

" - } - } - } - }, - "com.amazonaws.connect#DescribeQueue": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DescribeQueueRequest" - }, - "output": { - "target": "com.amazonaws.connect#DescribeQueueResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Describes the specified queue.

", - "smithy.api#http": { - "method": "GET", - "uri": "/queues/{InstanceId}/{QueueId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DescribeQueueRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "QueueId": { - "target": "com.amazonaws.connect#QueueId", - "traits": { - "smithy.api#documentation": "

The identifier for the queue.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DescribeQueueResponse": { - "type": "structure", - "members": { - "Queue": { - "target": "com.amazonaws.connect#Queue", - "traits": { - "smithy.api#documentation": "

The name of the queue.

" - } - } - } - }, - "com.amazonaws.connect#DescribeQuickConnect": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DescribeQuickConnectRequest" - }, - "output": { - "target": "com.amazonaws.connect#DescribeQuickConnectResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the quick connect.

", - "smithy.api#http": { - "method": "GET", - "uri": "/quick-connects/{InstanceId}/{QuickConnectId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DescribeQuickConnectRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "QuickConnectId": { - "target": "com.amazonaws.connect#QuickConnectId", - "traits": { - "smithy.api#documentation": "

The identifier for the quick connect.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DescribeQuickConnectResponse": { - "type": "structure", - "members": { - "QuickConnect": { - "target": "com.amazonaws.connect#QuickConnect", - "traits": { - "smithy.api#documentation": "

Information about the quick connect.

" - } - } - } - }, - "com.amazonaws.connect#DescribeRoutingProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DescribeRoutingProfileRequest" - }, - "output": { - "target": "com.amazonaws.connect#DescribeRoutingProfileResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the specified routing profile.

", - "smithy.api#http": { - "method": "GET", - "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DescribeRoutingProfileRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RoutingProfileId": { - "target": "com.amazonaws.connect#RoutingProfileId", - "traits": { - "smithy.api#documentation": "

The identifier of the routing profile.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DescribeRoutingProfileResponse": { - "type": "structure", - "members": { - "RoutingProfile": { - "target": "com.amazonaws.connect#RoutingProfile", - "traits": { - "smithy.api#documentation": "

The routing profile.

" - } - } - } - }, - "com.amazonaws.connect#DescribeRule": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DescribeRuleRequest" - }, - "output": { - "target": "com.amazonaws.connect#DescribeRuleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes a rule for the specified Amazon Connect instance.

", - "smithy.api#http": { - "method": "GET", - "uri": "/rules/{InstanceId}/{RuleId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DescribeRuleRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RuleId": { - "target": "com.amazonaws.connect#RuleId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the rule.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DescribeRuleResponse": { - "type": "structure", - "members": { - "Rule": { - "target": "com.amazonaws.connect#Rule", - "traits": { - "smithy.api#documentation": "

Information about the rule.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DescribeSecurityProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DescribeSecurityProfileRequest" - }, - "output": { - "target": "com.amazonaws.connect#DescribeSecurityProfileResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Gets basic information about the security profle.

", - "smithy.api#http": { - "method": "GET", - "uri": "/security-profiles/{InstanceId}/{SecurityProfileId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DescribeSecurityProfileRequest": { - "type": "structure", - "members": { - "SecurityProfileId": { - "target": "com.amazonaws.connect#SecurityProfileId", - "traits": { - "smithy.api#documentation": "

The identifier for the security profle.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DescribeSecurityProfileResponse": { - "type": "structure", - "members": { - "SecurityProfile": { - "target": "com.amazonaws.connect#SecurityProfile", - "traits": { - "smithy.api#documentation": "

The security profile.

" - } - } - } - }, - "com.amazonaws.connect#DescribeTrafficDistributionGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DescribeTrafficDistributionGroupRequest" - }, - "output": { - "target": "com.amazonaws.connect#DescribeTrafficDistributionGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets details and status of a traffic distribution group.

", - "smithy.api#http": { - "method": "GET", - "uri": "/traffic-distribution-group/{TrafficDistributionGroupId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DescribeTrafficDistributionGroupRequest": { - "type": "structure", - "members": { - "TrafficDistributionGroupId": { - "target": "com.amazonaws.connect#TrafficDistributionGroupIdOrArn", - "traits": { - "smithy.api#documentation": "

The identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DescribeTrafficDistributionGroupResponse": { - "type": "structure", - "members": { - "TrafficDistributionGroup": { - "target": "com.amazonaws.connect#TrafficDistributionGroup", - "traits": { - "smithy.api#documentation": "

Information about the traffic distribution group.

" - } - } - } - }, - "com.amazonaws.connect#DescribeUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DescribeUserRequest" - }, - "output": { - "target": "com.amazonaws.connect#DescribeUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the specified user account. You can find the instance ID in the console (itā€™s the\n final part of the ARN). The console does not display the user IDs. Instead, list the users and\n note the IDs provided in the output.

", - "smithy.api#http": { - "method": "GET", - "uri": "/users/{InstanceId}/{UserId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DescribeUserHierarchyGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DescribeUserHierarchyGroupRequest" - }, - "output": { - "target": "com.amazonaws.connect#DescribeUserHierarchyGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the specified hierarchy group.

", - "smithy.api#http": { - "method": "GET", - "uri": "/user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DescribeUserHierarchyGroupRequest": { - "type": "structure", - "members": { - "HierarchyGroupId": { - "target": "com.amazonaws.connect#HierarchyGroupId", - "traits": { - "smithy.api#documentation": "

The identifier of the hierarchy group.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DescribeUserHierarchyGroupResponse": { - "type": "structure", - "members": { - "HierarchyGroup": { - "target": "com.amazonaws.connect#HierarchyGroup", - "traits": { - "smithy.api#documentation": "

Information about the hierarchy group.

" - } - } - } - }, - "com.amazonaws.connect#DescribeUserHierarchyStructure": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DescribeUserHierarchyStructureRequest" - }, - "output": { - "target": "com.amazonaws.connect#DescribeUserHierarchyStructureResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the hierarchy structure of the specified Amazon Connect instance.

", - "smithy.api#http": { - "method": "GET", - "uri": "/user-hierarchy-structure/{InstanceId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DescribeUserHierarchyStructureRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DescribeUserHierarchyStructureResponse": { - "type": "structure", - "members": { - "HierarchyStructure": { - "target": "com.amazonaws.connect#HierarchyStructure", - "traits": { - "smithy.api#documentation": "

Information about the hierarchy structure.

" - } - } - } - }, - "com.amazonaws.connect#DescribeUserRequest": { - "type": "structure", - "members": { - "UserId": { - "target": "com.amazonaws.connect#UserId", - "traits": { - "smithy.api#documentation": "

The identifier of the user account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DescribeUserResponse": { - "type": "structure", - "members": { - "User": { - "target": "com.amazonaws.connect#User", - "traits": { - "smithy.api#documentation": "

Information about the user account and configuration settings.

" - } - } - } - }, - "com.amazonaws.connect#DescribeVocabulary": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DescribeVocabularyRequest" - }, - "output": { - "target": "com.amazonaws.connect#DescribeVocabularyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the specified vocabulary.

", - "smithy.api#http": { - "method": "GET", - "uri": "/vocabulary/{InstanceId}/{VocabularyId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DescribeVocabularyRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VocabularyId": { - "target": "com.amazonaws.connect#VocabularyId", - "traits": { - "smithy.api#documentation": "

The identifier of the custom vocabulary.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DescribeVocabularyResponse": { - "type": "structure", - "members": { - "Vocabulary": { - "target": "com.amazonaws.connect#Vocabulary", - "traits": { - "smithy.api#documentation": "

A list of specific words that you want Contact Lens for Amazon Connect to recognize in your audio input. They are\n generally domain-specific words and phrases, words that Contact Lens is not recognizing, or proper\n nouns.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#Description": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 4096 - } - } - }, - "com.amazonaws.connect#Description250": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 250 - }, - "smithy.api#pattern": "^(^[\\S].*[\\S]$)|(^[\\S]$)$" - } - }, - "com.amazonaws.connect#DestinationNotAllowedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.connect#Message", - "traits": { - "smithy.api#documentation": "

The message about the outbound calls.

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

Outbound calls to the destination number are not allowed.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.connect#Dimensions": { - "type": "structure", - "members": { - "Queue": { - "target": "com.amazonaws.connect#QueueReference", - "traits": { - "smithy.api#documentation": "

Information about the queue for which metrics are returned.

" - } - }, - "Channel": { - "target": "com.amazonaws.connect#Channel", - "traits": { - "smithy.api#documentation": "

The channel used for grouping and filters.

" - } - }, - "RoutingProfile": { - "target": "com.amazonaws.connect#RoutingProfileReference" - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the dimensions for a set of metrics.

" - } - }, - "com.amazonaws.connect#DirectoryAlias": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 62 - }, - "smithy.api#pattern": "^(?!d-)([\\da-zA-Z]+)([-]*[\\da-zA-Z])*$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.connect#DirectoryId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 12, - "max": 12 - }, - "smithy.api#pattern": "^d-[0-9a-f]{10}$" - } - }, - "com.amazonaws.connect#DirectoryType": { - "type": "enum", - "members": { - "SAML": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SAML" - } - }, - "CONNECT_MANAGED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONNECT_MANAGED" - } - }, - "EXISTING_DIRECTORY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXISTING_DIRECTORY" - } - } - } - }, - "com.amazonaws.connect#DirectoryUserId": { - "type": "string" - }, - "com.amazonaws.connect#DisassociateApprovedOrigin": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DisassociateApprovedOriginRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Revokes access to integrated applications from Amazon Connect.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/instance/{InstanceId}/approved-origin", - "code": 200 - } - } - }, - "com.amazonaws.connect#DisassociateApprovedOriginRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Origin": { - "target": "com.amazonaws.connect#Origin", - "traits": { - "smithy.api#documentation": "

The domain URL of the integrated application.

", - "smithy.api#httpQuery": "origin", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DisassociateBot": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DisassociateBotRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2\n bot.

", - "smithy.api#http": { - "method": "POST", - "uri": "/instance/{InstanceId}/bot", - "code": 200 - } - } - }, - "com.amazonaws.connect#DisassociateBotRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LexBot": { - "target": "com.amazonaws.connect#LexBot" - }, - "LexV2Bot": { - "target": "com.amazonaws.connect#LexV2Bot", - "traits": { - "smithy.api#documentation": "

The Amazon Lex V2 bot to disassociate from the instance.

" - } - } - } - }, - "com.amazonaws.connect#DisassociateInstanceStorageConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DisassociateInstanceStorageConfigRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Removes the storage type configurations for the specified resource type and association\n ID.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/instance/{InstanceId}/storage-config/{AssociationId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DisassociateInstanceStorageConfigRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssociationId": { - "target": "com.amazonaws.connect#AssociationId", - "traits": { - "smithy.api#documentation": "

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ResourceType": { - "target": "com.amazonaws.connect#InstanceStorageResourceType", - "traits": { - "smithy.api#documentation": "

A valid resource type.

", - "smithy.api#httpQuery": "resourceType", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DisassociateLambdaFunction": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DisassociateLambdaFunctionRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Remove the Lambda function from the dropdown options available in the relevant flow\n blocks.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/instance/{InstanceId}/lambda-function", - "code": 200 - } - } - }, - "com.amazonaws.connect#DisassociateLambdaFunctionRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance..

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "FunctionArn": { - "target": "com.amazonaws.connect#FunctionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lambda function being disassociated.

", - "smithy.api#httpQuery": "functionArn", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DisassociateLexBot": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DisassociateLexBotRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Revokes authorization from the specified instance to access the specified Amazon Lex bot.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/instance/{InstanceId}/lex-bot", - "code": 200 - } - } - }, - "com.amazonaws.connect#DisassociateLexBotRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BotName": { - "target": "com.amazonaws.connect#BotName", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Lex bot. Maximum character limit of 50.

", - "smithy.api#httpQuery": "botName", - "smithy.api#required": {} - } - }, - "LexRegion": { - "target": "com.amazonaws.connect#LexRegion", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region in which the Amazon Lex bot has been created.

", - "smithy.api#httpQuery": "lexRegion", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DisassociatePhoneNumberContactFlow": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DisassociatePhoneNumberContactFlowRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes the flow association from a phone number claimed to your Amazon Connect\n instance.

\n \n

If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the\n Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number\n ARN or UUID value for the PhoneNumberId URI request parameter. However, if the\n number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate\n Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN.\n If a UUID is provided in this scenario, you will receive a\n ResourceNotFoundException.

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/phone-number/{PhoneNumberId}/contact-flow", - "code": 200 - } - } - }, - "com.amazonaws.connect#DisassociatePhoneNumberContactFlowRequest": { - "type": "structure", - "members": { - "PhoneNumberId": { - "target": "com.amazonaws.connect#PhoneNumberId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the phone number.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpQuery": "instanceId", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DisassociateQueueQuickConnects": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DisassociateQueueQuickConnectsRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Disassociates a set of quick connects from a queue.

", - "smithy.api#http": { - "method": "POST", - "uri": "/queues/{InstanceId}/{QueueId}/disassociate-quick-connects", - "code": 200 - } - } - }, - "com.amazonaws.connect#DisassociateQueueQuickConnectsRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "QueueId": { - "target": "com.amazonaws.connect#QueueId", - "traits": { - "smithy.api#documentation": "

The identifier for the queue.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "QuickConnectIds": { - "target": "com.amazonaws.connect#QuickConnectsList", - "traits": { - "smithy.api#documentation": "

The quick connects to disassociate from the queue.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DisassociateRoutingProfileQueues": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DisassociateRoutingProfileQueuesRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Disassociates a set of queues from a routing profile.

", - "smithy.api#http": { - "method": "POST", - "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/disassociate-queues", - "code": 200 - } - } - }, - "com.amazonaws.connect#DisassociateRoutingProfileQueuesRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RoutingProfileId": { - "target": "com.amazonaws.connect#RoutingProfileId", - "traits": { - "smithy.api#documentation": "

The identifier of the routing profile.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "QueueReferences": { - "target": "com.amazonaws.connect#RoutingProfileQueueReferenceList", - "traits": { - "smithy.api#documentation": "

The queues to disassociate from this routing profile.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DisassociateSecurityKey": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DisassociateSecurityKeyRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Deletes the specified security key.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/instance/{InstanceId}/security-key/{AssociationId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#DisassociateSecurityKeyRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssociationId": { - "target": "com.amazonaws.connect#AssociationId", - "traits": { - "smithy.api#documentation": "

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DismissUserContact": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#DismissUserContactRequest" - }, - "output": { - "target": "com.amazonaws.connect#DismissUserContactResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Dismisses contacts from an agentā€™s CCP and returns the agent to an available state, which\n allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a\n MISSED, ERROR, ENDED, or REJECTED state in\n the Agent\n Event Stream.

", - "smithy.api#http": { - "method": "POST", - "uri": "/users/{InstanceId}/{UserId}/contact", - "code": 200 - } - } - }, - "com.amazonaws.connect#DismissUserContactRequest": { - "type": "structure", - "members": { - "UserId": { - "target": "com.amazonaws.connect#UserId", - "traits": { - "smithy.api#documentation": "

The identifier of the user account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the\n instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the contact.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#DismissUserContactResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.connect#DisplayName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.connect#Distribution": { - "type": "structure", - "members": { - "Region": { - "target": "com.amazonaws.connect#AwsRegion", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region where the traffic is distributed.

", - "smithy.api#required": {} - } - }, - "Percentage": { - "target": "com.amazonaws.connect#Percentage", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The percentage of the traffic that is distributed, in increments of 10.

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

Information about a traffic distribution.

" - } - }, - "com.amazonaws.connect#DistributionList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#Distribution" - } - }, - "com.amazonaws.connect#DuplicateResourceException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.connect#Message" - } - }, - "traits": { - "smithy.api#documentation": "

A resource with the specified name already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.connect#Email": { - "type": "string" - }, - "com.amazonaws.connect#EmailReference": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.connect#ReferenceKey", - "traits": { - "smithy.api#documentation": "

Identifier of the email reference.

" - } - }, - "Value": { - "target": "com.amazonaws.connect#ReferenceValue", - "traits": { - "smithy.api#documentation": "

A valid email address.

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

Information about a reference when the referenceType is EMAIL.\n Otherwise, null.

" - } - }, - "com.amazonaws.connect#EncryptionConfig": { - "type": "structure", - "members": { - "EncryptionType": { - "target": "com.amazonaws.connect#EncryptionType", - "traits": { - "smithy.api#documentation": "

The type of encryption.

", - "smithy.api#required": {} - } - }, - "KeyId": { - "target": "com.amazonaws.connect#KeyId", - "traits": { - "smithy.api#documentation": "

The full ARN of the encryption key.

\n \n

Be sure to provide the full ARN of the encryption key, not just the ID.

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

The encryption configuration.

" - } - }, - "com.amazonaws.connect#EncryptionType": { - "type": "enum", - "members": { - "KMS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KMS" - } - } - } - }, - "com.amazonaws.connect#EventBridgeActionDefinition": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.connect#EventBridgeActionName", - "traits": { - "smithy.api#documentation": "

The name.

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

The EventBridge action definition.

" - } - }, - "com.amazonaws.connect#EventBridgeActionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.connect#EventSourceName": { - "type": "enum", - "members": { - "OnPostCallAnalysisAvailable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OnPostCallAnalysisAvailable" - } - }, - "OnRealTimeCallAnalysisAvailable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OnRealTimeCallAnalysisAvailable" - } - }, - "OnPostChatAnalysisAvailable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OnPostChatAnalysisAvailable" - } - }, - "OnZendeskTicketCreate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OnZendeskTicketCreate" - } - }, - "OnZendeskTicketStatusUpdate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OnZendeskTicketStatusUpdate" - } - }, - "OnSalesforceCaseCreate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OnSalesforceCaseCreate" - } - } - } - }, - "com.amazonaws.connect#Filters": { - "type": "structure", - "members": { - "Queues": { - "target": "com.amazonaws.connect#Queues", - "traits": { - "smithy.api#documentation": "

The queues to use to filter the metrics. You should specify at least one queue, and can\n specify up to 100 queues per request. The GetCurrentMetricsData API in particular\n requires a queue when you include a Filter in your request.

" - } - }, - "Channels": { - "target": "com.amazonaws.connect#Channels", - "traits": { - "smithy.api#documentation": "

The channel to use to filter the metrics.

" - } - }, - "RoutingProfiles": { - "target": "com.amazonaws.connect#RoutingProfiles", - "traits": { - "smithy.api#documentation": "

A list of up to 100 routing profile IDs or ARNs.

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

Contains the filter to apply when retrieving metrics.

" - } - }, - "com.amazonaws.connect#FunctionArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 140 - } - } - }, - "com.amazonaws.connect#FunctionArnsList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#FunctionArn" - } - }, - "com.amazonaws.connect#GetContactAttributes": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#GetContactAttributesRequest" - }, - "output": { - "target": "com.amazonaws.connect#GetContactAttributesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves the contact attributes for the specified contact.

", - "smithy.api#http": { - "method": "GET", - "uri": "/contact/attributes/{InstanceId}/{InitialContactId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#GetContactAttributesRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "InitialContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the initial contact.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#GetContactAttributesResponse": { - "type": "structure", - "members": { - "Attributes": { - "target": "com.amazonaws.connect#Attributes", - "traits": { - "smithy.api#documentation": "

Information about the attributes.

" - } - } - } - }, - "com.amazonaws.connect#GetCurrentMetricData": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#GetCurrentMetricDataRequest" - }, - "output": { - "target": "com.amazonaws.connect#GetCurrentMetricDataResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the real-time metric data from the specified Amazon Connect instance.

\n

For a description of each metric, see Real-time Metrics\n Definitions in the Amazon Connect Administrator Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/metrics/current/{InstanceId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#GetCurrentMetricDataRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.connect#Filters", - "traits": { - "smithy.api#documentation": "

The filters to apply to returned metrics. You can filter up to the following limits:

\n \n

Metric data is retrieved only for the resources associated with the queues or routing\n profiles, and by any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource IDs and resource ARNs in the same request.

\n

Currently tagging is only supported on the resources that are passed in the filter.

", - "smithy.api#required": {} - } - }, - "Groupings": { - "target": "com.amazonaws.connect#Groupings", - "traits": { - "smithy.api#documentation": "

The grouping applied to the metrics returned. For example, when grouped by\n QUEUE, the metrics returned apply to each queue rather than aggregated for all\n queues.

\n " - } - }, - "CurrentMetrics": { - "target": "com.amazonaws.connect#CurrentMetrics", - "traits": { - "smithy.api#documentation": "

The metrics to retrieve. Specify the name and unit for each metric. The following metrics\n are available. For a description of all the metrics, see Real-time Metrics\n Definitions in the Amazon Connect Administrator Guide.

\n
\n
AGENTS_AFTER_CONTACT_WORK
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: ACW\n

\n
\n
AGENTS_AVAILABLE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Available\n

\n
\n
AGENTS_ERROR
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Error\n

\n
\n
AGENTS_NON_PRODUCTIVE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: NPT (Non-Productive Time)\n

\n
\n
AGENTS_ON_CALL
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: On\n contact\n

\n
\n
AGENTS_ON_CONTACT
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: On\n contact\n

\n
\n
AGENTS_ONLINE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Online\n

\n
\n
AGENTS_STAFFED
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Staffed\n

\n
\n
CONTACTS_IN_QUEUE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: In\n queue\n

\n
\n
CONTACTS_SCHEDULED
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Scheduled\n

\n
\n
OLDEST_CONTACT_AGE
\n
\n

Unit: SECONDS

\n

When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.

\n

When you do not use groupings, Unit says SECONDS but the Value is returned in\n MILLISECONDS. For example, if you get a response like this:

\n

\n { \"Metric\": { \"Name\": \"OLDEST_CONTACT_AGE\", \"Unit\": \"SECONDS\" }, \"Value\": 24113.0\n }

\n

The actual OLDEST_CONTACT_AGE is 24 seconds.

\n

Name in real-time metrics report: Oldest\n

\n
\n
SLOTS_ACTIVE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Active\n

\n
\n
SLOTS_AVAILABLE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Availability\n

\n
\n
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

\n

The token expires after 5 minutes from the time it is created. Subsequent requests that use\n the token must use the same request parameters as the request that generated the token.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult100", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page.

" - } - }, - "SortCriteria": { - "target": "com.amazonaws.connect#CurrentMetricSortCriteriaMaxOne", - "traits": { - "smithy.api#documentation": "

The way to sort the resulting response based on metrics. You can enter one sort criteria. By\n default resources are sorted based on AGENTS_ONLINE, DESCENDING. The\n metric collection is sorted based on the input metrics.

\n

Note the following:

\n " - } - } - } - }, - "com.amazonaws.connect#GetCurrentMetricDataResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

\n

The token expires after 5 minutes from the time it is created. Subsequent requests that use\n the token must use the same request parameters as the request that generated the token.

" - } - }, - "MetricResults": { - "target": "com.amazonaws.connect#CurrentMetricResults", - "traits": { - "smithy.api#documentation": "

Information about the real-time metrics.

" - } - }, - "DataSnapshotTime": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the metrics were retrieved and cached for pagination.

" - } - }, - "ApproximateTotalCount": { - "target": "com.amazonaws.connect#ApproximateTotalCount", - "traits": { - "smithy.api#documentation": "

The total count of the result, regardless of the current page size.

" - } - } - } - }, - "com.amazonaws.connect#GetCurrentUserData": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#GetCurrentUserDataRequest" - }, - "output": { - "target": "com.amazonaws.connect#GetCurrentUserDataResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the real-time active user data from the specified Amazon Connect instance.

", - "smithy.api#http": { - "method": "POST", - "uri": "/metrics/userdata/{InstanceId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#GetCurrentUserDataRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.connect#UserDataFilters", - "traits": { - "smithy.api#documentation": "

The filters to apply to returned user data. You can filter up to the following limits:

\n \n

The user data is retrieved for only the specified\n values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles,\n agents, and user hierarchy groups.

\n

Currently tagging is only supported on the resources that are passed in the filter.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult100", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page.

" - } - } - } - }, - "com.amazonaws.connect#GetCurrentUserDataResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - }, - "UserDataList": { - "target": "com.amazonaws.connect#UserDataList", - "traits": { - "smithy.api#documentation": "

A list of the user data that is returned.

" - } - }, - "ApproximateTotalCount": { - "target": "com.amazonaws.connect#ApproximateTotalCount", - "traits": { - "smithy.api#documentation": "

The total count of the result, regardless of the current page size.

" - } - } - } - }, - "com.amazonaws.connect#GetFederationToken": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#GetFederationTokenRequest" - }, - "output": { - "target": "com.amazonaws.connect#GetFederationTokenResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#DuplicateResourceException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#UserNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves a token for federation.

\n \n

This API doesn't support root users. If you try to invoke GetFederationToken with root\n credentials, an error message similar to the following one appears:

\n

\n Provided identity: Principal: .... User: .... cannot be used for federation with\n Amazon Connect\n

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/user/federate/{InstanceId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#GetFederationTokenRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#GetFederationTokenResponse": { - "type": "structure", - "members": { - "Credentials": { - "target": "com.amazonaws.connect#Credentials", - "traits": { - "smithy.api#documentation": "

The credentials to use for federation.

" - } - }, - "SignInUrl": { - "target": "com.amazonaws.connect#Url", - "traits": { - "smithy.api#documentation": "

The URL to sign into the user's instance.

" - } - }, - "UserArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user.

" - } - }, - "UserId": { - "target": "com.amazonaws.connect#AgentResourceId", - "traits": { - "smithy.api#documentation": "

The identifier for the user.

" - } - } - } - }, - "com.amazonaws.connect#GetMetricData": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#GetMetricDataRequest" - }, - "output": { - "target": "com.amazonaws.connect#GetMetricDataResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets historical metric data from the specified Amazon Connect instance.

\n

For a description of each historical metric, see Historical Metrics\n Definitions in the Amazon Connect Administrator Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/metrics/historical/{InstanceId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#GetMetricDataRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "StartTime": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the\n retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes,\n such as 10:05, 10:10, 10:15.

\n

The start time cannot be earlier than 24 hours before the time of the request. Historical\n metrics are available only for 24 hours.

", - "smithy.api#required": {} - } - }, - "EndTime": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the\n retrieval of historical metrics data. The time must be specified using an interval of 5 minutes,\n such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.

\n

The time range between the start and end time must be less than 24 hours.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.connect#Filters", - "traits": { - "smithy.api#documentation": "

The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is\n retrieved only for the resources associated with the queues or channels included in the filter.\n You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.

\n \n

To filter by Queues, enter the queue\n ID/ARN, not the name of the queue.

\n ", - "smithy.api#required": {} - } - }, - "Groupings": { - "target": "com.amazonaws.connect#Groupings", - "traits": { - "smithy.api#documentation": "

The grouping applied to the metrics returned. For example, when results are grouped by\n queue, the metrics returned are grouped by queue. The values returned apply to the metrics for\n each queue rather than aggregated for all queues.

\n

If no grouping is specified, a summary of metrics for all queues is returned.

" - } - }, - "HistoricalMetrics": { - "target": "com.amazonaws.connect#HistoricalMetrics", - "traits": { - "smithy.api#documentation": "

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The\n following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator\n Guide.

\n \n

This API does not support a contacts\n incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).

\n \n
\n
ABANDON_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
AFTER_CONTACT_WORK_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
API_CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CALLBACK_CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_ABANDONED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_AGENT_HUNG_UP_FIRST
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_CONSULTED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED_INCOMING
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED_OUTBOUND
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HOLD_ABANDONS
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_MISSED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_QUEUED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_IN
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_IN_FROM_QUEUE
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_OUT
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
HANDLE_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
HOLD_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
INTERACTION_AND_HOLD_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
INTERACTION_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
OCCUPANCY
\n
\n

Unit: PERCENT

\n

Statistic: AVG

\n
\n
QUEUE_ANSWER_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
QUEUED_TIME
\n
\n

Unit: SECONDS

\n

Statistic: MAX

\n
\n
SERVICE_LEVEL
\n
\n

You can include up to 20 SERVICE_LEVEL metrics in a request.

\n

Unit: PERCENT

\n

Statistic: AVG

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult100", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page.

" - } - } - } - }, - "com.amazonaws.connect#GetMetricDataResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

\n

The token expires after 5 minutes from the time it is created. Subsequent requests that use\n the token must use the same request parameters as the request that generated the token.

" - } - }, - "MetricResults": { - "target": "com.amazonaws.connect#HistoricalMetricResults", - "traits": { - "smithy.api#documentation": "

Information about the historical metrics.

\n

If no grouping is specified, a summary of metric data is returned.

" - } - } - } - }, - "com.amazonaws.connect#GetTaskTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#GetTaskTemplateRequest" - }, - "output": { - "target": "com.amazonaws.connect#GetTaskTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets details about a specific task template in the specified Amazon Connect\n instance.

", - "smithy.api#http": { - "method": "GET", - "uri": "/instance/{InstanceId}/task/template/{TaskTemplateId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#GetTaskTemplateRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TaskTemplateId": { - "target": "com.amazonaws.connect#TaskTemplateId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the task template.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SnapshotVersion": { - "target": "com.amazonaws.connect#SnapshotVersion", - "traits": { - "smithy.api#documentation": "

The system generated version of a task template that is associated with a task, when the\n task is created.

", - "smithy.api#httpQuery": "snapshotVersion" - } - } - } - }, - "com.amazonaws.connect#GetTaskTemplateResponse": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

" - } - }, - "Id": { - "target": "com.amazonaws.connect#TaskTemplateId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the task template.

", - "smithy.api#required": {} - } - }, - "Arn": { - "target": "com.amazonaws.connect#TaskTemplateArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN).

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.connect#TaskTemplateName", - "traits": { - "smithy.api#documentation": "

The name of the task template.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.connect#TaskTemplateDescription", - "traits": { - "smithy.api#documentation": "

The description of the task template.

" - } - }, - "ContactFlowId": { - "target": "com.amazonaws.connect#ContactFlowId", - "traits": { - "smithy.api#documentation": "

The identifier of the flow that runs by default when a task is created by referencing this template.

" - } - }, - "Constraints": { - "target": "com.amazonaws.connect#TaskTemplateConstraints", - "traits": { - "smithy.api#documentation": "

Constraints that are applicable to the fields listed.

" - } - }, - "Defaults": { - "target": "com.amazonaws.connect#TaskTemplateDefaults", - "traits": { - "smithy.api#documentation": "

The default values for fields when a task is created by referencing this template.

" - } - }, - "Fields": { - "target": "com.amazonaws.connect#TaskTemplateFields", - "traits": { - "smithy.api#documentation": "

Fields that are part of the template.

" - } - }, - "Status": { - "target": "com.amazonaws.connect#TaskTemplateStatus", - "traits": { - "smithy.api#documentation": "

Marks a template as ACTIVE or INACTIVE for a task to refer to it. \nTasks can only be created from ACTIVE templates.\nIf a template is marked as INACTIVE, then a task that refers to this template cannot be created.

" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp when the task template was last modified.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp when the task template was created.

" - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" - } - } - } - }, - "com.amazonaws.connect#GetTrafficDistribution": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#GetTrafficDistributionRequest" - }, - "output": { - "target": "com.amazonaws.connect#GetTrafficDistributionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves the current traffic distribution for a given traffic distribution group.

", - "smithy.api#http": { - "method": "GET", - "uri": "/traffic-distribution/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.connect#GetTrafficDistributionRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#TrafficDistributionGroupIdOrArn", - "traits": { - "smithy.api#documentation": "

The identifier of the traffic distribution group.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#GetTrafficDistributionResponse": { - "type": "structure", - "members": { - "TelephonyConfig": { - "target": "com.amazonaws.connect#TelephonyConfig", - "traits": { - "smithy.api#documentation": "

The distribution of traffic between the instance and its replicas.

" - } - }, - "Id": { - "target": "com.amazonaws.connect#TrafficDistributionGroupId", - "traits": { - "smithy.api#documentation": "

The identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#TrafficDistributionGroupArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the traffic distribution group.

" - } - } - } - }, - "com.amazonaws.connect#Grouping": { - "type": "enum", - "members": { - "QUEUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUEUE" - } - }, - "CHANNEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CHANNEL" - } - }, - "ROUTING_PROFILE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROUTING_PROFILE" - } - } - } - }, - "com.amazonaws.connect#Groupings": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#Grouping" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2 - } - } - }, - "com.amazonaws.connect#HierarchyGroup": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#HierarchyGroupId", - "traits": { - "smithy.api#documentation": "

The identifier of the hierarchy group.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hierarchy group.

" - } - }, - "Name": { - "target": "com.amazonaws.connect#HierarchyGroupName", - "traits": { - "smithy.api#documentation": "

The name of the hierarchy group.

" - } - }, - "LevelId": { - "target": "com.amazonaws.connect#HierarchyLevelId", - "traits": { - "smithy.api#documentation": "

The identifier of the level in the hierarchy group.

" - } - }, - "HierarchyPath": { - "target": "com.amazonaws.connect#HierarchyPath", - "traits": { - "smithy.api#documentation": "

Information about the levels in the hierarchy group.

" - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

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

Contains information about a hierarchy group.

" - } - }, - "com.amazonaws.connect#HierarchyGroupCondition": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.connect#String", - "traits": { - "smithy.api#documentation": "

The value in the hierarchy group condition.

" - } - }, - "HierarchyGroupMatchType": { - "target": "com.amazonaws.connect#HierarchyGroupMatchType", - "traits": { - "smithy.api#documentation": "

The type of hierarchy group match.

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

A leaf node condition which can be used to specify a hierarchy group condition.

" - } - }, - "com.amazonaws.connect#HierarchyGroupId": { - "type": "string" - }, - "com.amazonaws.connect#HierarchyGroupMatchType": { - "type": "enum", - "members": { - "EXACT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXACT" - } - }, - "WITH_CHILD_GROUPS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WITH_CHILD_GROUPS" - } - } - } - }, - "com.amazonaws.connect#HierarchyGroupName": { - "type": "string" - }, - "com.amazonaws.connect#HierarchyGroupSummary": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#HierarchyGroupId", - "traits": { - "smithy.api#documentation": "

The identifier of the hierarchy group.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hierarchy group.

" - } - }, - "Name": { - "target": "com.amazonaws.connect#HierarchyGroupName", - "traits": { - "smithy.api#documentation": "

The name of the hierarchy group.

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

Contains summary information about a hierarchy group.

" - } - }, - "com.amazonaws.connect#HierarchyGroupSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#HierarchyGroupSummary" - } - }, - "com.amazonaws.connect#HierarchyGroupSummaryReference": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#HierarchyGroupId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the hierarchy group.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the hierarchy group.

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

Information about the hierarchy group.

" - } - }, - "com.amazonaws.connect#HierarchyLevel": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#HierarchyLevelId", - "traits": { - "smithy.api#documentation": "

The identifier of the hierarchy level.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hierarchy level.

" - } - }, - "Name": { - "target": "com.amazonaws.connect#HierarchyLevelName", - "traits": { - "smithy.api#documentation": "

The name of the hierarchy level.

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

Contains information about a hierarchy level.

" - } - }, - "com.amazonaws.connect#HierarchyLevelId": { - "type": "string" - }, - "com.amazonaws.connect#HierarchyLevelName": { - "type": "string" - }, - "com.amazonaws.connect#HierarchyLevelUpdate": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.connect#HierarchyLevelName", - "traits": { - "smithy.api#documentation": "

The name of the user hierarchy level. Must not be more than 50 characters.

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

Contains information about the hierarchy level to update.

" - } - }, - "com.amazonaws.connect#HierarchyPath": { - "type": "structure", - "members": { - "LevelOne": { - "target": "com.amazonaws.connect#HierarchyGroupSummary", - "traits": { - "smithy.api#documentation": "

Information about level one.

" - } - }, - "LevelTwo": { - "target": "com.amazonaws.connect#HierarchyGroupSummary", - "traits": { - "smithy.api#documentation": "

Information about level two.

" - } - }, - "LevelThree": { - "target": "com.amazonaws.connect#HierarchyGroupSummary", - "traits": { - "smithy.api#documentation": "

Information about level three.

" - } - }, - "LevelFour": { - "target": "com.amazonaws.connect#HierarchyGroupSummary", - "traits": { - "smithy.api#documentation": "

Information about level four.

" - } - }, - "LevelFive": { - "target": "com.amazonaws.connect#HierarchyGroupSummary", - "traits": { - "smithy.api#documentation": "

Information about level five.

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

Contains information about the levels of a hierarchy group.

" - } - }, - "com.amazonaws.connect#HierarchyPathReference": { - "type": "structure", - "members": { - "LevelOne": { - "target": "com.amazonaws.connect#HierarchyGroupSummaryReference", - "traits": { - "smithy.api#documentation": "

Information about level one.

" - } - }, - "LevelTwo": { - "target": "com.amazonaws.connect#HierarchyGroupSummaryReference", - "traits": { - "smithy.api#documentation": "

Information about level two.

" - } - }, - "LevelThree": { - "target": "com.amazonaws.connect#HierarchyGroupSummaryReference", - "traits": { - "smithy.api#documentation": "

Information about level three.

" - } - }, - "LevelFour": { - "target": "com.amazonaws.connect#HierarchyGroupSummaryReference", - "traits": { - "smithy.api#documentation": "

Information about level four.

" - } - }, - "LevelFive": { - "target": "com.amazonaws.connect#HierarchyGroupSummaryReference", - "traits": { - "smithy.api#documentation": "

Information about level five.

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

Information about the levels in the hierarchy group.

" - } - }, - "com.amazonaws.connect#HierarchyStructure": { - "type": "structure", - "members": { - "LevelOne": { - "target": "com.amazonaws.connect#HierarchyLevel", - "traits": { - "smithy.api#documentation": "

Information about level one.

" - } - }, - "LevelTwo": { - "target": "com.amazonaws.connect#HierarchyLevel", - "traits": { - "smithy.api#documentation": "

Information about level two.

" - } - }, - "LevelThree": { - "target": "com.amazonaws.connect#HierarchyLevel", - "traits": { - "smithy.api#documentation": "

Information about level three.

" - } - }, - "LevelFour": { - "target": "com.amazonaws.connect#HierarchyLevel", - "traits": { - "smithy.api#documentation": "

Information about level four.

" - } - }, - "LevelFive": { - "target": "com.amazonaws.connect#HierarchyLevel", - "traits": { - "smithy.api#documentation": "

Information about level five.

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

Contains information about a hierarchy structure.

" - } - }, - "com.amazonaws.connect#HierarchyStructureUpdate": { - "type": "structure", - "members": { - "LevelOne": { - "target": "com.amazonaws.connect#HierarchyLevelUpdate", - "traits": { - "smithy.api#documentation": "

The\n update\n for level one.

" - } - }, - "LevelTwo": { - "target": "com.amazonaws.connect#HierarchyLevelUpdate", - "traits": { - "smithy.api#documentation": "

The update for level two.

" - } - }, - "LevelThree": { - "target": "com.amazonaws.connect#HierarchyLevelUpdate", - "traits": { - "smithy.api#documentation": "

The update for level three.

" - } - }, - "LevelFour": { - "target": "com.amazonaws.connect#HierarchyLevelUpdate", - "traits": { - "smithy.api#documentation": "

The update for level four.

" - } - }, - "LevelFive": { - "target": "com.amazonaws.connect#HierarchyLevelUpdate", - "traits": { - "smithy.api#documentation": "

The update for level five.

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

Contains information about the level hierarchy to update.

" - } - }, - "com.amazonaws.connect#HistoricalMetric": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.connect#HistoricalMetricName", - "traits": { - "smithy.api#documentation": "

The name of the metric.

" - } - }, - "Threshold": { - "target": "com.amazonaws.connect#Threshold", - "traits": { - "smithy.api#documentation": "

The threshold for the metric, used with service level metrics.

" - } - }, - "Statistic": { - "target": "com.amazonaws.connect#Statistic", - "traits": { - "smithy.api#documentation": "

The statistic for the metric.

" - } - }, - "Unit": { - "target": "com.amazonaws.connect#Unit", - "traits": { - "smithy.api#documentation": "

The unit for the metric.

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

Contains information about a historical metric. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator\n Guide.

" - } - }, - "com.amazonaws.connect#HistoricalMetricData": { - "type": "structure", - "members": { - "Metric": { - "target": "com.amazonaws.connect#HistoricalMetric", - "traits": { - "smithy.api#documentation": "

Information about the metric.

" - } - }, - "Value": { - "target": "com.amazonaws.connect#Value", - "traits": { - "smithy.api#documentation": "

The value of the metric.

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

Contains the data for a historical metric.

" - } - }, - "com.amazonaws.connect#HistoricalMetricDataCollections": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#HistoricalMetricData" - } - }, - "com.amazonaws.connect#HistoricalMetricName": { - "type": "enum", - "members": { - "CONTACTS_QUEUED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTACTS_QUEUED" - } - }, - "CONTACTS_HANDLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTACTS_HANDLED" - } - }, - "CONTACTS_ABANDONED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTACTS_ABANDONED" - } - }, - "CONTACTS_CONSULTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTACTS_CONSULTED" - } - }, - "CONTACTS_AGENT_HUNG_UP_FIRST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTACTS_AGENT_HUNG_UP_FIRST" - } - }, - "CONTACTS_HANDLED_INCOMING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTACTS_HANDLED_INCOMING" - } - }, - "CONTACTS_HANDLED_OUTBOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTACTS_HANDLED_OUTBOUND" - } - }, - "CONTACTS_HOLD_ABANDONS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTACTS_HOLD_ABANDONS" - } - }, - "CONTACTS_TRANSFERRED_IN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTACTS_TRANSFERRED_IN" - } - }, - "CONTACTS_TRANSFERRED_OUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTACTS_TRANSFERRED_OUT" - } - }, - "CONTACTS_TRANSFERRED_IN_FROM_QUEUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTACTS_TRANSFERRED_IN_FROM_QUEUE" - } - }, - "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE" - } - }, - "CONTACTS_MISSED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTACTS_MISSED" - } - }, - "CALLBACK_CONTACTS_HANDLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CALLBACK_CONTACTS_HANDLED" - } - }, - "API_CONTACTS_HANDLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "API_CONTACTS_HANDLED" - } - }, - "OCCUPANCY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OCCUPANCY" - } - }, - "HANDLE_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HANDLE_TIME" - } - }, - "AFTER_CONTACT_WORK_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AFTER_CONTACT_WORK_TIME" - } - }, - "QUEUED_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUEUED_TIME" - } - }, - "ABANDON_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ABANDON_TIME" - } - }, - "QUEUE_ANSWER_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUEUE_ANSWER_TIME" - } - }, - "HOLD_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HOLD_TIME" - } - }, - "INTERACTION_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERACTION_TIME" - } - }, - "INTERACTION_AND_HOLD_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERACTION_AND_HOLD_TIME" - } - }, - "SERVICE_LEVEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SERVICE_LEVEL" - } - } - }, - "traits": { - "smithy.api#documentation": "

The historical metric names.

" - } - }, - "com.amazonaws.connect#HistoricalMetricResult": { - "type": "structure", - "members": { - "Dimensions": { - "target": "com.amazonaws.connect#Dimensions", - "traits": { - "smithy.api#documentation": "

The dimension for the metrics.

" - } - }, - "Collections": { - "target": "com.amazonaws.connect#HistoricalMetricDataCollections", - "traits": { - "smithy.api#documentation": "

The set of metrics.

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

Contains information about the historical metrics retrieved.

" - } - }, - "com.amazonaws.connect#HistoricalMetricResults": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#HistoricalMetricResult" - } - }, - "com.amazonaws.connect#HistoricalMetrics": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#HistoricalMetric" - } - }, - "com.amazonaws.connect#Hours": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 87600 - } - } - }, - "com.amazonaws.connect#Hours24Format": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 23 - } - } - }, - "com.amazonaws.connect#HoursOfOperation": { - "type": "structure", - "members": { - "HoursOfOperationId": { - "target": "com.amazonaws.connect#HoursOfOperationId", - "traits": { - "smithy.api#documentation": "

The identifier for the hours of operation.

" - } - }, - "HoursOfOperationArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the hours of operation.

" - } - }, - "Name": { - "target": "com.amazonaws.connect#CommonNameLength127", - "traits": { - "smithy.api#documentation": "

The name for the hours of operation.

" - } - }, - "Description": { - "target": "com.amazonaws.connect#HoursOfOperationDescription", - "traits": { - "smithy.api#documentation": "

The description for the hours of operation.

" - } - }, - "TimeZone": { - "target": "com.amazonaws.connect#TimeZone", - "traits": { - "smithy.api#documentation": "

The time zone for the hours of operation.

" - } - }, - "Config": { - "target": "com.amazonaws.connect#HoursOfOperationConfigList", - "traits": { - "smithy.api#documentation": "

Configuration information for the hours of operation.

" - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

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

Information about of the hours of operation.

" - } - }, - "com.amazonaws.connect#HoursOfOperationConfig": { - "type": "structure", - "members": { - "Day": { - "target": "com.amazonaws.connect#HoursOfOperationDays", - "traits": { - "smithy.api#documentation": "

The day that the hours of operation applies to.

", - "smithy.api#required": {} - } - }, - "StartTime": { - "target": "com.amazonaws.connect#HoursOfOperationTimeSlice", - "traits": { - "smithy.api#documentation": "

The start time that your contact center opens.

", - "smithy.api#required": {} - } - }, - "EndTime": { - "target": "com.amazonaws.connect#HoursOfOperationTimeSlice", - "traits": { - "smithy.api#documentation": "

The end time that your contact center closes.

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

Contains information about the hours of operation.

" - } - }, - "com.amazonaws.connect#HoursOfOperationConfigList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#HoursOfOperationConfig" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.connect#HoursOfOperationDays": { - "type": "enum", - "members": { - "SUNDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUNDAY" - } - }, - "MONDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MONDAY" - } - }, - "TUESDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TUESDAY" - } - }, - "WEDNESDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WEDNESDAY" - } - }, - "THURSDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THURSDAY" - } - }, - "FRIDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FRIDAY" - } - }, - "SATURDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SATURDAY" - } - } - } - }, - "com.amazonaws.connect#HoursOfOperationDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 250 - } - } - }, - "com.amazonaws.connect#HoursOfOperationId": { - "type": "string" - }, - "com.amazonaws.connect#HoursOfOperationName": { - "type": "string" - }, - "com.amazonaws.connect#HoursOfOperationSummary": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#HoursOfOperationId", - "traits": { - "smithy.api#documentation": "

The identifier of the hours of operation.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hours of operation.

" - } - }, - "Name": { - "target": "com.amazonaws.connect#HoursOfOperationName", - "traits": { - "smithy.api#documentation": "

The name of the hours of operation.

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

Contains summary information about hours of operation for a contact center.

" - } - }, - "com.amazonaws.connect#HoursOfOperationSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#HoursOfOperationSummary" - } - }, - "com.amazonaws.connect#HoursOfOperationTimeSlice": { - "type": "structure", - "members": { - "Hours": { - "target": "com.amazonaws.connect#Hours24Format", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The hours.

", - "smithy.api#required": {} - } - }, - "Minutes": { - "target": "com.amazonaws.connect#MinutesLimit60", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The minutes.

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

The start time or end time for an hours of operation.

" - } - }, - "com.amazonaws.connect#IdempotencyException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.connect#Message" - } - }, - "traits": { - "smithy.api#documentation": "

An entity with the same name already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.connect#InboundCallsEnabled": { - "type": "boolean" - }, - "com.amazonaws.connect#Instance": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance.

" - } - }, - "IdentityManagementType": { - "target": "com.amazonaws.connect#DirectoryType", - "traits": { - "smithy.api#documentation": "

The identity management type.

" - } - }, - "InstanceAlias": { - "target": "com.amazonaws.connect#DirectoryAlias", - "traits": { - "smithy.api#documentation": "

The alias of instance.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

When the instance was created.

" - } - }, - "ServiceRole": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The service role of the instance.

" - } - }, - "InstanceStatus": { - "target": "com.amazonaws.connect#InstanceStatus", - "traits": { - "smithy.api#documentation": "

The state of the instance.

" - } - }, - "StatusReason": { - "target": "com.amazonaws.connect#InstanceStatusReason", - "traits": { - "smithy.api#documentation": "

Relevant\n details why the instance was not successfully created.

" - } - }, - "InboundCallsEnabled": { - "target": "com.amazonaws.connect#InboundCallsEnabled", - "traits": { - "smithy.api#documentation": "

Whether inbound calls are enabled.

" - } - }, - "OutboundCallsEnabled": { - "target": "com.amazonaws.connect#OutboundCallsEnabled", - "traits": { - "smithy.api#documentation": "

Whether outbound calls are enabled.

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

The Amazon Connect instance.

" - } - }, - "com.amazonaws.connect#InstanceArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9-]{1}:[0-9]{1,20}:instance/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" - } - }, - "com.amazonaws.connect#InstanceAttributeType": { - "type": "enum", - "members": { - "INBOUND_CALLS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INBOUND_CALLS" - } - }, - "OUTBOUND_CALLS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OUTBOUND_CALLS" - } - }, - "CONTACTFLOW_LOGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTACTFLOW_LOGS" - } - }, - "CONTACT_LENS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTACT_LENS" - } - }, - "AUTO_RESOLVE_BEST_VOICES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO_RESOLVE_BEST_VOICES" - } - }, - "USE_CUSTOM_TTS_VOICES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "USE_CUSTOM_TTS_VOICES" - } - }, - "EARLY_MEDIA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EARLY_MEDIA" - } - }, - "MULTI_PARTY_CONFERENCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MULTI_PARTY_CONFERENCE" - } - }, - "HIGH_VOLUME_OUTBOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HIGH_VOLUME_OUTBOUND" - } - }, - "ENHANCED_CONTACT_MONITORING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENHANCED_CONTACT_MONITORING" - } - } - } - }, - "com.amazonaws.connect#InstanceAttributeValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.connect#InstanceId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.connect#InstanceIdOrArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 250 - }, - "smithy.api#pattern": "^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" - } - }, - "com.amazonaws.connect#InstanceStatus": { - "type": "enum", - "members": { - "CREATION_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATION_IN_PROGRESS" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "CREATION_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATION_FAILED" - } - } - } - }, - "com.amazonaws.connect#InstanceStatusReason": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.connect#String", - "traits": { - "smithy.api#documentation": "

The message.

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

Relevant\n details why the instance was not successfully created.

" - } - }, - "com.amazonaws.connect#InstanceStorageConfig": { - "type": "structure", - "members": { - "AssociationId": { - "target": "com.amazonaws.connect#AssociationId", - "traits": { - "smithy.api#documentation": "

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

" - } - }, - "StorageType": { - "target": "com.amazonaws.connect#StorageType", - "traits": { - "smithy.api#documentation": "

A valid storage type.

", - "smithy.api#required": {} - } - }, - "S3Config": { - "target": "com.amazonaws.connect#S3Config", - "traits": { - "smithy.api#documentation": "

The S3 bucket\n configuration.

" - } - }, - "KinesisVideoStreamConfig": { - "target": "com.amazonaws.connect#KinesisVideoStreamConfig", - "traits": { - "smithy.api#documentation": "

The configuration of the Kinesis video stream.

" - } - }, - "KinesisStreamConfig": { - "target": "com.amazonaws.connect#KinesisStreamConfig", - "traits": { - "smithy.api#documentation": "

The configuration of the Kinesis data stream.

" - } - }, - "KinesisFirehoseConfig": { - "target": "com.amazonaws.connect#KinesisFirehoseConfig", - "traits": { - "smithy.api#documentation": "

The configuration of the Kinesis Firehose delivery stream.

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

The storage configuration for the instance.

" - } - }, - "com.amazonaws.connect#InstanceStorageConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#InstanceStorageConfig" - } - }, - "com.amazonaws.connect#InstanceStorageResourceType": { - "type": "enum", - "members": { - "CHAT_TRANSCRIPTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CHAT_TRANSCRIPTS" - } - }, - "CALL_RECORDINGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CALL_RECORDINGS" - } - }, - "SCHEDULED_REPORTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SCHEDULED_REPORTS" - } - }, - "MEDIA_STREAMS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEDIA_STREAMS" - } - }, - "CONTACT_TRACE_RECORDS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTACT_TRACE_RECORDS" - } - }, - "AGENT_EVENTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AGENT_EVENTS" - } - }, - "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS" - } - } - } - }, - "com.amazonaws.connect#InstanceSummary": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the instance.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance.

" - } - }, - "IdentityManagementType": { - "target": "com.amazonaws.connect#DirectoryType", - "traits": { - "smithy.api#documentation": "

The identity management type of the instance.

" - } - }, - "InstanceAlias": { - "target": "com.amazonaws.connect#DirectoryAlias", - "traits": { - "smithy.api#documentation": "

The alias of the instance.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

When the instance was created.

" - } - }, - "ServiceRole": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The service role of the instance.

" - } - }, - "InstanceStatus": { - "target": "com.amazonaws.connect#InstanceStatus", - "traits": { - "smithy.api#documentation": "

The state of the instance.

" - } - }, - "InboundCallsEnabled": { - "target": "com.amazonaws.connect#InboundCallsEnabled", - "traits": { - "smithy.api#documentation": "

Whether inbound calls are enabled.

" - } - }, - "OutboundCallsEnabled": { - "target": "com.amazonaws.connect#OutboundCallsEnabled", - "traits": { - "smithy.api#documentation": "

Whether outbound calls are enabled.

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

Information about the instance.

" - } - }, - "com.amazonaws.connect#InstanceSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#InstanceSummary" - } - }, - "com.amazonaws.connect#IntegerCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.connect#IntegrationAssociationId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.connect#IntegrationAssociationSummary": { - "type": "structure", - "members": { - "IntegrationAssociationId": { - "target": "com.amazonaws.connect#IntegrationAssociationId", - "traits": { - "smithy.api#documentation": "

The identifier for the AppIntegration association.

" - } - }, - "IntegrationAssociationArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the AppIntegration association.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

" - } - }, - "IntegrationType": { - "target": "com.amazonaws.connect#IntegrationType", - "traits": { - "smithy.api#documentation": "

The integration type.

" - } - }, - "IntegrationArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the AppIntegration.

" - } - }, - "SourceApplicationUrl": { - "target": "com.amazonaws.connect#URI", - "traits": { - "smithy.api#documentation": "

The URL for the external application.

" - } - }, - "SourceApplicationName": { - "target": "com.amazonaws.connect#SourceApplicationName", - "traits": { - "smithy.api#documentation": "

The user-provided, friendly name for the external application.

" - } - }, - "SourceType": { - "target": "com.amazonaws.connect#SourceType", - "traits": { - "smithy.api#documentation": "

The name of the source.

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

Contains summary information about the associated AppIntegrations.

" - } - }, - "com.amazonaws.connect#IntegrationAssociationSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#IntegrationAssociationSummary" - } - }, - "com.amazonaws.connect#IntegrationType": { - "type": "enum", - "members": { - "EVENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EVENT" - } - }, - "VOICE_ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VOICE_ID" - } - }, - "PINPOINT_APP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PINPOINT_APP" - } - }, - "WISDOM_ASSISTANT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WISDOM_ASSISTANT" - } - }, - "WISDOM_KNOWLEDGE_BASE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WISDOM_KNOWLEDGE_BASE" - } - }, - "CASES_DOMAIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CASES_DOMAIN" - } - } - } - }, - "com.amazonaws.connect#InternalServiceException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.connect#Message", - "traits": { - "smithy.api#documentation": "

The message.

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

Request processing failed because of an error or failure with the service.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.connect#InvalidContactFlowException": { - "type": "structure", - "members": { - "problems": { - "target": "com.amazonaws.connect#Problems", - "traits": { - "smithy.api#documentation": "

The problems with the flow. Please fix before trying again.

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

The flow is not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.connect#InvalidContactFlowModuleException": { - "type": "structure", - "members": { - "Problems": { - "target": "com.amazonaws.connect#Problems" - } - }, - "traits": { - "smithy.api#documentation": "

The problems with the module. Please fix before trying again.

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

The message about the parameters.

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

One or more of the specified parameters are not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.connect#InvalidRequestException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.connect#Message", - "traits": { - "smithy.api#documentation": "

The message about the request.

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

The request is not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.connect#InvisibleFieldInfo": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#TaskTemplateFieldIdentifier", - "traits": { - "smithy.api#documentation": "

Identifier of the invisible field.

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

A field that is invisible to an agent.

" - } - }, - "com.amazonaws.connect#InvisibleTaskTemplateFields": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#InvisibleFieldInfo" - } - }, - "com.amazonaws.connect#KeyId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.connect#KinesisFirehoseConfig": { - "type": "structure", - "members": { - "FirehoseArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the delivery stream.

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

Configuration information of a Kinesis Data Firehose delivery stream.

" - } - }, - "com.amazonaws.connect#KinesisStreamConfig": { - "type": "structure", - "members": { - "StreamArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data stream.

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

Configuration information of a Kinesis data stream.

" - } - }, - "com.amazonaws.connect#KinesisVideoStreamConfig": { - "type": "structure", - "members": { - "Prefix": { - "target": "com.amazonaws.connect#Prefix", - "traits": { - "smithy.api#documentation": "

The prefix of the video stream.

", - "smithy.api#required": {} - } - }, - "RetentionPeriodHours": { - "target": "com.amazonaws.connect#Hours", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of hours data is retained in the stream. Kinesis Video Streams retains the data\n in a data store that is associated with the stream.

\n

The default value is 0, indicating that the stream does not persist data.

", - "smithy.api#required": {} - } - }, - "EncryptionConfig": { - "target": "com.amazonaws.connect#EncryptionConfig", - "traits": { - "smithy.api#documentation": "

The encryption configuration.

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

Configuration information of a Kinesis video stream.

" - } - }, - "com.amazonaws.connect#LargeNextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100000 - } - } - }, - "com.amazonaws.connect#LexBot": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.connect#BotName", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Lex bot.

" - } - }, - "LexRegion": { - "target": "com.amazonaws.connect#LexRegion", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region where the Amazon Lex bot was created.

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

Configuration information of an Amazon Lex bot.

" - } - }, - "com.amazonaws.connect#LexBotConfig": { - "type": "structure", - "members": { - "LexBot": { - "target": "com.amazonaws.connect#LexBot" - }, - "LexV2Bot": { - "target": "com.amazonaws.connect#LexV2Bot", - "traits": { - "smithy.api#documentation": "

Configuration information of an Amazon Lex V2 bot.

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

Configuration information of an Amazon Lex or Amazon Lex V2 bot.

" - } - }, - "com.amazonaws.connect#LexBotConfigList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#LexBotConfig" - } - }, - "com.amazonaws.connect#LexBotsList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#LexBot" - } - }, - "com.amazonaws.connect#LexRegion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 60 - } - } - }, - "com.amazonaws.connect#LexV2Bot": { - "type": "structure", - "members": { - "AliasArn": { - "target": "com.amazonaws.connect#AliasArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.

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

Configuration information of an Amazon Lex V2 bot.

" - } - }, - "com.amazonaws.connect#LexVersion": { - "type": "enum", - "members": { - "V1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "V1" - } - }, - "V2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "V2" - } - } - } - }, - "com.amazonaws.connect#LimitExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.connect#Message", - "traits": { - "smithy.api#documentation": "

The message about the limit.

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "LimitExceededException", - "httpResponseCode": 429 - }, - "smithy.api#documentation": "

The allowed limit for the resource has been exceeded.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.connect#ListAgentStatusRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult1000", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "AgentStatusTypes": { - "target": "com.amazonaws.connect#AgentStatusTypes", - "traits": { - "smithy.api#documentation": "

Available agent status types.

", - "smithy.api#httpQuery": "AgentStatusTypes" - } - } - } - }, - "com.amazonaws.connect#ListAgentStatusResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - }, - "AgentStatusSummaryList": { - "target": "com.amazonaws.connect#AgentStatusSummaryList", - "traits": { - "smithy.api#documentation": "

A summary of agent statuses.

" - } - } - } - }, - "com.amazonaws.connect#ListAgentStatuses": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListAgentStatusRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListAgentStatusResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Lists agent statuses.

", - "smithy.api#http": { - "method": "GET", - "uri": "/agent-status/{InstanceId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "AgentStatusSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListApprovedOrigins": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListApprovedOriginsRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListApprovedOriginsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Returns a paginated list of all approved origins associated with the instance.

", - "smithy.api#http": { - "method": "GET", - "uri": "/instance/{InstanceId}/approved-origins", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Origins", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListApprovedOriginsRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult25", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page.

", - "smithy.api#httpQuery": "maxResults" - } - } - } - }, - "com.amazonaws.connect#ListApprovedOriginsResponse": { - "type": "structure", - "members": { - "Origins": { - "target": "com.amazonaws.connect#OriginsList", - "traits": { - "smithy.api#documentation": "

The approved origins.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#ListBots": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListBotsRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListBotsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently\n associated with the instance. Use this API to returns both Amazon Lex V1 and V2\n bots.

", - "smithy.api#http": { - "method": "GET", - "uri": "/instance/{InstanceId}/bots", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "LexBots", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListBotsRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult25", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "LexVersion": { - "target": "com.amazonaws.connect#LexVersion", - "traits": { - "smithy.api#documentation": "

The version of Amazon Lex or Amazon Lex V2.

", - "smithy.api#httpQuery": "lexVersion", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#ListBotsResponse": { - "type": "structure", - "members": { - "LexBots": { - "target": "com.amazonaws.connect#LexBotConfigList", - "traits": { - "smithy.api#documentation": "

The names and Amazon Web Services Regions of the Amazon Lex or Amazon Lex V2 bots associated with the\n specified instance.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#ListContactFlowModules": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListContactFlowModulesRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListContactFlowModulesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides information about the flow modules for the specified Amazon Connect\n instance.

", - "smithy.api#http": { - "method": "GET", - "uri": "/contact-flow-modules-summary/{InstanceId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ContactFlowModulesSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListContactFlowModulesRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult1000", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "ContactFlowModuleState": { - "target": "com.amazonaws.connect#ContactFlowModuleState", - "traits": { - "smithy.api#documentation": "

The state of the flow module.

", - "smithy.api#httpQuery": "state" - } - } - } - }, - "com.amazonaws.connect#ListContactFlowModulesResponse": { - "type": "structure", - "members": { - "ContactFlowModulesSummaryList": { - "target": "com.amazonaws.connect#ContactFlowModulesSummaryList", - "traits": { - "smithy.api#documentation": "

Information about the flow module.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#ListContactFlows": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListContactFlowsRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListContactFlowsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides information about the flows for the specified Amazon Connect instance.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

\n

For more information about flows, see Flows in the\n Amazon Connect Administrator Guide.

", - "smithy.api#http": { - "method": "GET", - "uri": "/contact-flows-summary/{InstanceId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ContactFlowSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListContactFlowsRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContactFlowTypes": { - "target": "com.amazonaws.connect#ContactFlowTypes", - "traits": { - "smithy.api#documentation": "

The type of flow.

", - "smithy.api#httpQuery": "contactFlowTypes" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult1000", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return per page. The default MaxResult size is 100.

", - "smithy.api#httpQuery": "maxResults" - } - } - } - }, - "com.amazonaws.connect#ListContactFlowsResponse": { - "type": "structure", - "members": { - "ContactFlowSummaryList": { - "target": "com.amazonaws.connect#ContactFlowSummaryList", - "traits": { - "smithy.api#documentation": "

Information about the flows.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#ListContactReferences": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListContactReferencesRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListContactReferencesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

For the specified referenceTypes, returns a list of references associated with\n the contact.

", - "smithy.api#http": { - "method": "GET", - "uri": "/contact/references/{InstanceId}/{ContactId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ReferenceSummaryList" - } - } - }, - "com.amazonaws.connect#ListContactReferencesRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the initial contact.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ReferenceTypes": { - "target": "com.amazonaws.connect#ReferenceTypes", - "traits": { - "smithy.api#documentation": "

The type of reference.

", - "smithy.api#httpQuery": "referenceTypes", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

\n \n

This is not expected to be set, because the value returned in the previous response is\n always null.

\n ", - "smithy.api#httpQuery": "nextToken" - } - } - } - }, - "com.amazonaws.connect#ListContactReferencesResponse": { - "type": "structure", - "members": { - "ReferenceSummaryList": { - "target": "com.amazonaws.connect#ReferenceSummaryList", - "traits": { - "smithy.api#documentation": "

Information about the flows.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

\n \n

This is always returned as null in the response.

\n " - } - } - } - }, - "com.amazonaws.connect#ListDefaultVocabularies": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListDefaultVocabulariesRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListDefaultVocabulariesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the default vocabularies for the specified Amazon Connect instance.

", - "smithy.api#http": { - "method": "POST", - "uri": "/default-vocabulary-summary/{InstanceId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "DefaultVocabularyList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListDefaultVocabulariesRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LanguageCode": { - "target": "com.amazonaws.connect#VocabularyLanguageCode", - "traits": { - "smithy.api#documentation": "

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see \nWhat is Amazon Transcribe?\n

" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult100", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return per page.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#VocabularyNextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#ListDefaultVocabulariesResponse": { - "type": "structure", - "members": { - "DefaultVocabularyList": { - "target": "com.amazonaws.connect#DefaultVocabularyList", - "traits": { - "smithy.api#documentation": "

A list of default vocabularies.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#VocabularyNextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#ListHoursOfOperations": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListHoursOfOperationsRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListHoursOfOperationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides information about the hours of operation for the specified Amazon Connect\n instance.

\n

For more information about hours of operation, see Set the Hours of Operation for a\n Queue in the Amazon Connect Administrator Guide.

", - "smithy.api#http": { - "method": "GET", - "uri": "/hours-of-operations-summary/{InstanceId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "HoursOfOperationSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListHoursOfOperationsRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult1000", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return per page. The default MaxResult size is 100.

", - "smithy.api#httpQuery": "maxResults" - } - } - } - }, - "com.amazonaws.connect#ListHoursOfOperationsResponse": { - "type": "structure", - "members": { - "HoursOfOperationSummaryList": { - "target": "com.amazonaws.connect#HoursOfOperationSummaryList", - "traits": { - "smithy.api#documentation": "

Information about the hours of operation.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#ListInstanceAttributes": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListInstanceAttributesRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListInstanceAttributesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Returns a paginated list of all attribute types for the given instance.

", - "smithy.api#http": { - "method": "GET", - "uri": "/instance/{InstanceId}/attributes", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Attributes", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListInstanceAttributesRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult7", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page.

", - "smithy.api#httpQuery": "maxResults" - } - } - } - }, - "com.amazonaws.connect#ListInstanceAttributesResponse": { - "type": "structure", - "members": { - "Attributes": { - "target": "com.amazonaws.connect#AttributesList", - "traits": { - "smithy.api#documentation": "

The attribute types.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#ListInstanceStorageConfigs": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListInstanceStorageConfigsRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListInstanceStorageConfigsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Returns a paginated list of storage configs for the identified instance and resource\n type.

", - "smithy.api#http": { - "method": "GET", - "uri": "/instance/{InstanceId}/storage-configs", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "StorageConfigs", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListInstanceStorageConfigsRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ResourceType": { - "target": "com.amazonaws.connect#InstanceStorageResourceType", - "traits": { - "smithy.api#documentation": "

A valid resource type.

", - "smithy.api#httpQuery": "resourceType", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult10", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page.

", - "smithy.api#httpQuery": "maxResults" - } - } - } - }, - "com.amazonaws.connect#ListInstanceStorageConfigsResponse": { - "type": "structure", - "members": { - "StorageConfigs": { - "target": "com.amazonaws.connect#InstanceStorageConfigs", - "traits": { - "smithy.api#documentation": "

A valid storage type.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#ListInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListInstancesRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListInstancesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Return a list of instances which are in active state, creation-in-progress state, and failed\n state. Instances that aren't successfully created (they are in a failed state) are returned only\n for 24 hours after the CreateInstance API was invoked.

", - "smithy.api#http": { - "method": "GET", - "uri": "/instance", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "InstanceSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListInstancesRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult10", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page.

", - "smithy.api#httpQuery": "maxResults" - } - } - } - }, - "com.amazonaws.connect#ListInstancesResponse": { - "type": "structure", - "members": { - "InstanceSummaryList": { - "target": "com.amazonaws.connect#InstanceSummaryList", - "traits": { - "smithy.api#documentation": "

Information about the instances.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#ListIntegrationAssociations": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListIntegrationAssociationsRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListIntegrationAssociationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides summary information about the Amazon Web Services resource associations for the\n specified Amazon Connect instance.

", - "smithy.api#http": { - "method": "GET", - "uri": "/instance/{InstanceId}/integration-associations", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "IntegrationAssociationSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListIntegrationAssociationsRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "IntegrationType": { - "target": "com.amazonaws.connect#IntegrationType", - "traits": { - "smithy.api#documentation": "

The integration type.

", - "smithy.api#httpQuery": "integrationType" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult100", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page.

", - "smithy.api#httpQuery": "maxResults" - } - } - } - }, - "com.amazonaws.connect#ListIntegrationAssociationsResponse": { - "type": "structure", - "members": { - "IntegrationAssociationSummaryList": { - "target": "com.amazonaws.connect#IntegrationAssociationSummaryList", - "traits": { - "smithy.api#documentation": "

The associations.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#ListLambdaFunctions": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListLambdaFunctionsRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListLambdaFunctionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Returns a paginated list of all Lambda functions that display in the dropdown options in the\n relevant flow blocks.

", - "smithy.api#http": { - "method": "GET", - "uri": "/instance/{InstanceId}/lambda-functions", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "LambdaFunctions", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListLambdaFunctionsRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult25", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page.

", - "smithy.api#httpQuery": "maxResults" - } - } - } - }, - "com.amazonaws.connect#ListLambdaFunctionsResponse": { - "type": "structure", - "members": { - "LambdaFunctions": { - "target": "com.amazonaws.connect#FunctionArnsList", - "traits": { - "smithy.api#documentation": "

The Lambdafunction ARNs associated with the specified instance.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#ListLexBots": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListLexBotsRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListLexBotsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To\n return both Amazon Lex V1 and V2 bots, use the ListBots API.\n

", - "smithy.api#http": { - "method": "GET", - "uri": "/instance/{InstanceId}/lex-bots", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "LexBots", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListLexBotsRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult25", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page. If no value is specified, the default is 10.\n

", - "smithy.api#httpQuery": "maxResults" - } - } - } - }, - "com.amazonaws.connect#ListLexBotsResponse": { - "type": "structure", - "members": { - "LexBots": { - "target": "com.amazonaws.connect#LexBotsList", - "traits": { - "smithy.api#documentation": "

The names and Amazon Web Services Regions of the Amazon Lex bots associated with the specified\n instance.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#ListPhoneNumbers": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListPhoneNumbersRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListPhoneNumbersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides information about the phone numbers for the specified Amazon Connect instance.

\n

For more information about phone numbers, see Set Up Phone Numbers for Your\n Contact Center in the Amazon Connect Administrator\n Guide.

\n \n

The phone number Arn value that is returned from each of the items in the\n PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with\n a ResourceNotFoundException. Instead, use the ListPhoneNumbersV2 API.\n It returns the new phone number ARN that can be used to tag phone number resources.

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/phone-numbers-summary/{InstanceId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "PhoneNumberSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListPhoneNumbersRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "PhoneNumberTypes": { - "target": "com.amazonaws.connect#PhoneNumberTypes", - "traits": { - "smithy.api#documentation": "

The type of phone number.

", - "smithy.api#httpQuery": "phoneNumberTypes" - } - }, - "PhoneNumberCountryCodes": { - "target": "com.amazonaws.connect#PhoneNumberCountryCodes", - "traits": { - "smithy.api#documentation": "

The ISO country code.

", - "smithy.api#httpQuery": "phoneNumberCountryCodes" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult1000", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return per page. The default MaxResult size is 100.

", - "smithy.api#httpQuery": "maxResults" - } - } - } - }, - "com.amazonaws.connect#ListPhoneNumbersResponse": { - "type": "structure", - "members": { - "PhoneNumberSummaryList": { - "target": "com.amazonaws.connect#PhoneNumberSummaryList", - "traits": { - "smithy.api#documentation": "

Information about the phone numbers.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#ListPhoneNumbersSummary": { - "type": "structure", - "members": { - "PhoneNumberId": { - "target": "com.amazonaws.connect#PhoneNumberId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the phone number.

" - } - }, - "PhoneNumberArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the phone number.

" - } - }, - "PhoneNumber": { - "target": "com.amazonaws.connect#PhoneNumber", - "traits": { - "smithy.api#documentation": "

The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

" - } - }, - "PhoneNumberCountryCode": { - "target": "com.amazonaws.connect#PhoneNumberCountryCode", - "traits": { - "smithy.api#documentation": "

The ISO country code.

" - } - }, - "PhoneNumberType": { - "target": "com.amazonaws.connect#PhoneNumberType", - "traits": { - "smithy.api#documentation": "

The type of phone number.

" - } - }, - "TargetArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

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

Information about phone numbers that have been claimed to your Amazon Connect instance\n or traffic distribution group.

" - } - }, - "com.amazonaws.connect#ListPhoneNumbersSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#ListPhoneNumbersSummary" - } - }, - "com.amazonaws.connect#ListPhoneNumbersV2": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListPhoneNumbersV2Request" - }, - "output": { - "target": "com.amazonaws.connect#ListPhoneNumbersV2Response" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided\n TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions\n associated with traffic distribution group.

\n

For more information about phone numbers, see Set Up Phone Numbers for Your\n Contact Center in the Amazon Connect Administrator\n Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/phone-number/list", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ListPhoneNumbersSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListPhoneNumbersV2Request": { - "type": "structure", - "members": { - "TargetArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to. If TargetArn input is not provided, this API lists numbers claimed\n to all the Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult1000", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#LargeNextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" - } - }, - "PhoneNumberCountryCodes": { - "target": "com.amazonaws.connect#PhoneNumberCountryCodes", - "traits": { - "smithy.api#documentation": "

The ISO country code.

" - } - }, - "PhoneNumberTypes": { - "target": "com.amazonaws.connect#PhoneNumberTypes", - "traits": { - "smithy.api#documentation": "

The type of phone number.

" - } - }, - "PhoneNumberPrefix": { - "target": "com.amazonaws.connect#PhoneNumberPrefix", - "traits": { - "smithy.api#documentation": "

The prefix of the phone number. If provided, it must contain + as part of the country code.

" - } - } - } - }, - "com.amazonaws.connect#ListPhoneNumbersV2Response": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.connect#LargeNextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - }, - "ListPhoneNumbersSummaryList": { - "target": "com.amazonaws.connect#ListPhoneNumbersSummaryList", - "traits": { - "smithy.api#documentation": "

Information about phone numbers that have been claimed to your Amazon Connect instances\n or traffic distribution groups.

" - } - } - } - }, - "com.amazonaws.connect#ListPrompts": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListPromptsRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListPromptsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides information about the prompts for the specified Amazon Connect instance.

", - "smithy.api#http": { - "method": "GET", - "uri": "/prompts-summary/{InstanceId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "PromptSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListPromptsRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult1000", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page. The default MaxResult size is 100.

", - "smithy.api#httpQuery": "maxResults" - } - } - } - }, - "com.amazonaws.connect#ListPromptsResponse": { - "type": "structure", - "members": { - "PromptSummaryList": { - "target": "com.amazonaws.connect#PromptSummaryList", - "traits": { - "smithy.api#documentation": "

Information about the prompts.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#ListQueueQuickConnects": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListQueueQuickConnectsRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListQueueQuickConnectsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Lists the quick connects associated with a queue.

", - "smithy.api#http": { - "method": "GET", - "uri": "/queues/{InstanceId}/{QueueId}/quick-connects", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "QuickConnectSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListQueueQuickConnectsRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "QueueId": { - "target": "com.amazonaws.connect#QueueId", - "traits": { - "smithy.api#documentation": "

The identifier for the queue.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult100", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page. The default MaxResult size is 100.

", - "smithy.api#httpQuery": "maxResults" - } - } - } - }, - "com.amazonaws.connect#ListQueueQuickConnectsResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - }, - "QuickConnectSummaryList": { - "target": "com.amazonaws.connect#QuickConnectSummaryList", - "traits": { - "smithy.api#documentation": "

Information about the quick connects.

" - } - } - } - }, - "com.amazonaws.connect#ListQueues": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListQueuesRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListQueuesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides information about the queues for the specified Amazon Connect instance.

\n

If you do not specify a QueueTypes\n parameter, both standard and agent queues are returned. This might cause an unexpected truncation\n of results if you have more than 1000 agents and you limit the number of results of the API call\n in code.

\n

For more information about queues, see Queues: Standard and\n Agent in the Amazon Connect Administrator Guide.

", - "smithy.api#http": { - "method": "GET", - "uri": "/queues-summary/{InstanceId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "QueueSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListQueuesRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "QueueTypes": { - "target": "com.amazonaws.connect#QueueTypes", - "traits": { - "smithy.api#documentation": "

The type of queue.

", - "smithy.api#httpQuery": "queueTypes" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult1000", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return per page. The default MaxResult size is 100.

", - "smithy.api#httpQuery": "maxResults" - } - } - } - }, - "com.amazonaws.connect#ListQueuesResponse": { - "type": "structure", - "members": { - "QueueSummaryList": { - "target": "com.amazonaws.connect#QueueSummaryList", - "traits": { - "smithy.api#documentation": "

Information about the queues.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#ListQuickConnects": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListQuickConnectsRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListQuickConnectsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides information about the quick connects for the specified Amazon Connect instance.\n

", - "smithy.api#http": { - "method": "GET", - "uri": "/quick-connects/{InstanceId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "QuickConnectSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListQuickConnectsRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult1000", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page. The default MaxResult size is 100.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "QuickConnectTypes": { - "target": "com.amazonaws.connect#QuickConnectTypes", - "traits": { - "smithy.api#documentation": "

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are\n prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

", - "smithy.api#httpQuery": "QuickConnectTypes" - } - } - } - }, - "com.amazonaws.connect#ListQuickConnectsResponse": { - "type": "structure", - "members": { - "QuickConnectSummaryList": { - "target": "com.amazonaws.connect#QuickConnectSummaryList", - "traits": { - "smithy.api#documentation": "

Information about the quick connects.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#ListRoutingProfileQueues": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListRoutingProfileQueuesRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListRoutingProfileQueuesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the queues associated with a routing profile.

", - "smithy.api#http": { - "method": "GET", - "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/queues", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "RoutingProfileQueueConfigSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListRoutingProfileQueuesRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RoutingProfileId": { - "target": "com.amazonaws.connect#RoutingProfileId", - "traits": { - "smithy.api#documentation": "

The identifier of the routing profile.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult100", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page. The default MaxResult size is 100.

", - "smithy.api#httpQuery": "maxResults" - } - } - } - }, - "com.amazonaws.connect#ListRoutingProfileQueuesResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - }, - "RoutingProfileQueueConfigSummaryList": { - "target": "com.amazonaws.connect#RoutingProfileQueueConfigSummaryList", - "traits": { - "smithy.api#documentation": "

Information about the routing profiles.

" - } - } - } - }, - "com.amazonaws.connect#ListRoutingProfiles": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListRoutingProfilesRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListRoutingProfilesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides summary information about the routing profiles for the specified Amazon Connect\n instance.

\n

For more information about routing profiles, see Routing Profiles and Create a Routing\n Profile in the Amazon Connect Administrator Guide.

", - "smithy.api#http": { - "method": "GET", - "uri": "/routing-profiles-summary/{InstanceId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "RoutingProfileSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListRoutingProfilesRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult1000", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page. The default MaxResult size is 100.

", - "smithy.api#httpQuery": "maxResults" - } - } - } - }, - "com.amazonaws.connect#ListRoutingProfilesResponse": { - "type": "structure", - "members": { - "RoutingProfileSummaryList": { - "target": "com.amazonaws.connect#RoutingProfileSummaryList", - "traits": { - "smithy.api#documentation": "

Information about the routing profiles.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#ListRules": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListRulesRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListRulesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

List all rules for the specified Amazon Connect instance.

", - "smithy.api#http": { - "method": "GET", - "uri": "/rules/{InstanceId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "RuleSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListRulesRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "PublishStatus": { - "target": "com.amazonaws.connect#RulePublishStatus", - "traits": { - "smithy.api#documentation": "

The publish status of the rule.

", - "smithy.api#httpQuery": "publishStatus" - } - }, - "EventSourceName": { - "target": "com.amazonaws.connect#EventSourceName", - "traits": { - "smithy.api#documentation": "

The name of the event source.

", - "smithy.api#httpQuery": "eventSourceName" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult200", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - } - } - }, - "com.amazonaws.connect#ListRulesResponse": { - "type": "structure", - "members": { - "RuleSummaryList": { - "target": "com.amazonaws.connect#RuleSummaryList", - "traits": { - "smithy.api#documentation": "

Summary information about a rule.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#ListSecurityKeys": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListSecurityKeysRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListSecurityKeysResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Returns a paginated list of all security keys associated with the instance.

", - "smithy.api#http": { - "method": "GET", - "uri": "/instance/{InstanceId}/security-keys", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "SecurityKeys", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListSecurityKeysRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult2", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page.

", - "smithy.api#httpQuery": "maxResults" - } - } - } - }, - "com.amazonaws.connect#ListSecurityKeysResponse": { - "type": "structure", - "members": { - "SecurityKeys": { - "target": "com.amazonaws.connect#SecurityKeysList", - "traits": { - "smithy.api#documentation": "

The security keys.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#ListSecurityProfilePermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListSecurityProfilePermissionsRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListSecurityProfilePermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Lists the permissions granted to a security profile.

", - "smithy.api#http": { - "method": "GET", - "uri": "/security-profiles-permissions/{InstanceId}/{SecurityProfileId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Permissions", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListSecurityProfilePermissionsRequest": { - "type": "structure", - "members": { - "SecurityProfileId": { - "target": "com.amazonaws.connect#SecurityProfileId", - "traits": { - "smithy.api#documentation": "

The identifier for the security profle.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult1000", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page.

", - "smithy.api#httpQuery": "maxResults" - } - } - } - }, - "com.amazonaws.connect#ListSecurityProfilePermissionsResponse": { - "type": "structure", - "members": { - "Permissions": { - "target": "com.amazonaws.connect#PermissionsList", - "traits": { - "smithy.api#documentation": "

The permissions granted to the security profile. For a complete list of valid permissions,\n see List\n of security profile permissions.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#ListSecurityProfiles": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListSecurityProfilesRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListSecurityProfilesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides summary information about the security profiles for the specified Amazon Connect instance.

\n

For more information about security profiles, see Security Profiles in the\n Amazon Connect Administrator Guide.

", - "smithy.api#http": { - "method": "GET", - "uri": "/security-profiles-summary/{InstanceId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "SecurityProfileSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListSecurityProfilesRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult1000", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page. The default MaxResult size is 100.

", - "smithy.api#httpQuery": "maxResults" - } - } - } - }, - "com.amazonaws.connect#ListSecurityProfilesResponse": { - "type": "structure", - "members": { - "SecurityProfileSummaryList": { - "target": "com.amazonaws.connect#SecurityProfileSummaryList", - "traits": { - "smithy.api#documentation": "

Information about the security profiles.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the tags for the specified resource.

\n

For sample policies that use tags, see Amazon Connect\n Identity-Based Policy Examples in the Amazon Connect Administrator\n Guide.

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

The Amazon Resource Name (ARN) of the resource.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

Information about the tags.

" - } - } - } - }, - "com.amazonaws.connect#ListTaskTemplates": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListTaskTemplatesRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListTaskTemplatesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists task templates for the specified Amazon Connect instance.

", - "smithy.api#http": { - "method": "GET", - "uri": "/instance/{InstanceId}/task/template", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TaskTemplates", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListTaskTemplatesRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

\n \n

It is not expected that you set this because the value returned in the previous response is\n always null.

\n ", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult100", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page.

\n \n

It is not expected that you set this.

\n ", - "smithy.api#httpQuery": "maxResults" - } - }, - "Status": { - "target": "com.amazonaws.connect#TaskTemplateStatus", - "traits": { - "smithy.api#documentation": "

Marks a template as ACTIVE or INACTIVE for a task to refer to it. \nTasks can only be created from ACTIVE templates.\nIf a template is marked as INACTIVE, then a task that refers to this template cannot be created.

", - "smithy.api#httpQuery": "status" - } - }, - "Name": { - "target": "com.amazonaws.connect#TaskTemplateName", - "traits": { - "smithy.api#documentation": "

The name of the task template.

", - "smithy.api#httpQuery": "name" - } - } - } - }, - "com.amazonaws.connect#ListTaskTemplatesResponse": { - "type": "structure", - "members": { - "TaskTemplates": { - "target": "com.amazonaws.connect#TaskTemplateList", - "traits": { - "smithy.api#documentation": "

Provides details about a list of task templates belonging to an instance.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

\n \n

This is always returned as a null in the response.

\n " - } - } - } - }, - "com.amazonaws.connect#ListTrafficDistributionGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListTrafficDistributionGroupsRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListTrafficDistributionGroupsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists traffic distribution groups.

", - "smithy.api#http": { - "method": "GET", - "uri": "/traffic-distribution-groups", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TrafficDistributionGroupSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListTrafficDistributionGroupsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult10", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return per page.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceIdOrArn", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpQuery": "instanceId" - } - } - } - }, - "com.amazonaws.connect#ListTrafficDistributionGroupsResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - }, - "TrafficDistributionGroupSummaryList": { - "target": "com.amazonaws.connect#TrafficDistributionGroupSummaryList", - "traits": { - "smithy.api#documentation": "

A list of traffic distribution groups.

" - } - } - } - }, - "com.amazonaws.connect#ListUseCases": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListUseCasesRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListUseCasesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the use cases for the integration association.

", - "smithy.api#http": { - "method": "GET", - "uri": "/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "UseCaseSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListUseCasesRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "IntegrationAssociationId": { - "target": "com.amazonaws.connect#IntegrationAssociationId", - "traits": { - "smithy.api#documentation": "

The identifier for the integration association.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult100", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page.

", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides summary information about the use cases for the specified integration\n association.

" - } - }, - "com.amazonaws.connect#ListUseCasesResponse": { - "type": "structure", - "members": { - "UseCaseSummaryList": { - "target": "com.amazonaws.connect#UseCaseSummaryList", - "traits": { - "smithy.api#documentation": "

The use cases.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#ListUserHierarchyGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListUserHierarchyGroupsRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListUserHierarchyGroupsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides summary information about the hierarchy groups for the specified Amazon Connect\n instance.

\n

For more information about agent hierarchies, see Set Up Agent Hierarchies in the\n Amazon Connect Administrator Guide.

", - "smithy.api#http": { - "method": "GET", - "uri": "/user-hierarchy-groups-summary/{InstanceId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "UserHierarchyGroupSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListUserHierarchyGroupsRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult1000", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page. The default MaxResult size is 100.

", - "smithy.api#httpQuery": "maxResults" - } - } - } - }, - "com.amazonaws.connect#ListUserHierarchyGroupsResponse": { - "type": "structure", - "members": { - "UserHierarchyGroupSummaryList": { - "target": "com.amazonaws.connect#HierarchyGroupSummaryList", - "traits": { - "smithy.api#documentation": "

Information about the hierarchy groups.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#ListUsers": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ListUsersRequest" - }, - "output": { - "target": "com.amazonaws.connect#ListUsersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides summary information about the users for the specified Amazon Connect\n instance.

", - "smithy.api#http": { - "method": "GET", - "uri": "/users-summary/{InstanceId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "UserSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#ListUsersRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult1000", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page. The default MaxResult size is 100.

", - "smithy.api#httpQuery": "maxResults" - } - } - } - }, - "com.amazonaws.connect#ListUsersResponse": { - "type": "structure", - "members": { - "UserSummaryList": { - "target": "com.amazonaws.connect#UserSummaryList", - "traits": { - "smithy.api#documentation": "

Information about the users.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#Long": { - "type": "long" - }, - "com.amazonaws.connect#MaxResult10": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.connect#MaxResult100": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.connect#MaxResult1000": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.connect#MaxResult2": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 2 - } - } - }, - "com.amazonaws.connect#MaxResult200": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.connect#MaxResult25": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.connect#MaxResult7": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 7 - } - } - }, - "com.amazonaws.connect#MediaConcurrencies": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#MediaConcurrency" - } - }, - "com.amazonaws.connect#MediaConcurrency": { - "type": "structure", - "members": { - "Channel": { - "target": "com.amazonaws.connect#Channel", - "traits": { - "smithy.api#documentation": "

The channels that agents can handle in the Contact Control Panel (CCP).

", - "smithy.api#required": {} - } - }, - "Concurrency": { - "target": "com.amazonaws.connect#Concurrency", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of contacts an agent can have on a channel simultaneously.

\n

Valid Range for VOICE: Minimum value of 1. Maximum value of 1.

\n

Valid Range for CHAT: Minimum value of 1. Maximum value of 10.

\n

Valid Range for TASK: Minimum value of 1. Maximum value of 10.

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

Contains information about which channels are supported, and how many contacts an agent can\n have on a channel simultaneously.

" - } - }, - "com.amazonaws.connect#Message": { - "type": "string" - }, - "com.amazonaws.connect#MinutesLimit60": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 59 - } - } - }, - "com.amazonaws.connect#MonitorCapability": { - "type": "enum", - "members": { - "SILENT_MONITOR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SILENT_MONITOR" - } - }, - "BARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BARGE" - } - } - } - }, - "com.amazonaws.connect#MonitorContact": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#MonitorContactRequest" - }, - "output": { - "target": "com.amazonaws.connect#MonitorContactResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#IdempotencyException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user\n specified by userId will be set to silent monitoring mode on the\n contact.

", - "smithy.api#http": { - "method": "POST", - "uri": "/contact/monitor", - "code": 200 - } - } - }, - "com.amazonaws.connect#MonitorContactRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the\n instance.

", - "smithy.api#required": {} - } - }, - "ContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the contact.

", - "smithy.api#required": {} - } - }, - "UserId": { - "target": "com.amazonaws.connect#AgentResourceId", - "traits": { - "smithy.api#documentation": "

The identifier of the user account.

", - "smithy.api#required": {} - } - }, - "AllowedMonitorCapabilities": { - "target": "com.amazonaws.connect#AllowedMonitorCapabilities", - "traits": { - "smithy.api#documentation": "

Specify which monitoring actions the user is allowed to take. For example, whether the user\n is allowed to escalate from silent monitoring to barge.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.connect#ClientToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", - "smithy.api#idempotencyToken": {} - } - } - } - }, - "com.amazonaws.connect#MonitorContactResponse": { - "type": "structure", - "members": { - "ContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the contact.

" - } - }, - "ContactArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The ARN of the contact.

" - } - } - } - }, - "com.amazonaws.connect#Name": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - } - } - }, - "com.amazonaws.connect#Name128": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^(^[\\S].*[\\S]$)|(^[\\S]$)$" - } - }, - "com.amazonaws.connect#NextToken": { - "type": "string" - }, - "com.amazonaws.connect#NextToken2500": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2500 - } - } - }, - "com.amazonaws.connect#NotificationContentType": { - "type": "enum", - "members": { - "PLAIN_TEXT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PLAIN_TEXT" - } - } - } - }, - "com.amazonaws.connect#NotificationDeliveryType": { - "type": "enum", - "members": { - "EMAIL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EMAIL" - } - } - } - }, - "com.amazonaws.connect#NotificationRecipientType": { - "type": "structure", - "members": { - "UserTags": { - "target": "com.amazonaws.connect#UserTagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }. Amazon Connect users with the specified tags will be notified.

" - } - }, - "UserIds": { - "target": "com.amazonaws.connect#UserIdList", - "traits": { - "smithy.api#documentation": "

A list of user IDs.

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

The type of notification recipient.

" - } - }, - "com.amazonaws.connect#NumberReference": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.connect#ReferenceKey", - "traits": { - "smithy.api#documentation": "

Identifier of the number reference.

" - } - }, - "Value": { - "target": "com.amazonaws.connect#ReferenceValue", - "traits": { - "smithy.api#documentation": "

A valid number.

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

Information about a reference when the referenceType is NUMBER.\n Otherwise, null.

" - } - }, - "com.amazonaws.connect#Origin": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 267 - } - } - }, - "com.amazonaws.connect#OriginsList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#Origin" - } - }, - "com.amazonaws.connect#OutboundCallerConfig": { - "type": "structure", - "members": { - "OutboundCallerIdName": { - "target": "com.amazonaws.connect#OutboundCallerIdName", - "traits": { - "smithy.api#documentation": "

The caller ID name.

" - } - }, - "OutboundCallerIdNumberId": { - "target": "com.amazonaws.connect#PhoneNumberId", - "traits": { - "smithy.api#documentation": "

The caller ID number.

" - } - }, - "OutboundFlowId": { - "target": "com.amazonaws.connect#ContactFlowId", - "traits": { - "smithy.api#documentation": "

The outbound whisper flow to be used during an outbound call.

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

The outbound caller ID name, number, and outbound whisper flow.

" - } - }, - "com.amazonaws.connect#OutboundCallerIdName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.connect#OutboundCallsEnabled": { - "type": "boolean" - }, - "com.amazonaws.connect#OutboundContactNotPermittedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.connect#Message", - "traits": { - "smithy.api#documentation": "

The message about the contact.

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

The contact is not permitted.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.connect#PEM": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.connect#ParticipantDetails": { - "type": "structure", - "members": { - "DisplayName": { - "target": "com.amazonaws.connect#DisplayName", - "traits": { - "smithy.api#documentation": "

Display name of the participant.

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

The customer's details.

" - } - }, - "com.amazonaws.connect#ParticipantId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.connect#ParticipantTimerAction": { - "type": "enum", - "members": { - "Unset": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Unset" - } - } - } - }, - "com.amazonaws.connect#ParticipantTimerConfigList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#ParticipantTimerConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 6 - } - } - }, - "com.amazonaws.connect#ParticipantTimerConfiguration": { - "type": "structure", - "members": { - "ParticipantRole": { - "target": "com.amazonaws.connect#TimerEligibleParticipantRoles", - "traits": { - "smithy.api#documentation": "

The role of the participant in the chat conversation.

", - "smithy.api#required": {} - } - }, - "TimerType": { - "target": "com.amazonaws.connect#ParticipantTimerType", - "traits": { - "smithy.api#documentation": "

The type of timer. IDLE indicates the timer applies for considering a human chat participant as idle. \n DISCONNECT_NONCUSTOMER indicates the timer applies to automatically disconnecting a chat participant due to\n idleness.

", - "smithy.api#required": {} - } - }, - "TimerValue": { - "target": "com.amazonaws.connect#ParticipantTimerValue", - "traits": { - "smithy.api#documentation": "

The value of the timer. Either the timer action (Unset to delete the timer), or the duration\n of the timer in minutes. Only one value can be set.

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

Configuration information for the timer. After the timer configuration is set, it persists\n for the duration of the chat. It persists across new contacts in the chain, for example, transfer\n contacts.

\n

For more information about how chat timeouts work, see \n Set up chat timeouts for human participants.

" - } - }, - "com.amazonaws.connect#ParticipantTimerDurationInMinutes": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 2, - "max": 480 - } - } - }, - "com.amazonaws.connect#ParticipantTimerType": { - "type": "enum", - "members": { - "IDLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IDLE" - } - }, - "DISCONNECT_NONCUSTOMER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISCONNECT_NONCUSTOMER" - } - } - } - }, - "com.amazonaws.connect#ParticipantTimerValue": { - "type": "union", - "members": { - "ParticipantTimerAction": { - "target": "com.amazonaws.connect#ParticipantTimerAction", - "traits": { - "smithy.api#documentation": "

The timer action. Currently only one value is allowed: Unset. It deletes a timer.

" - } - }, - "ParticipantTimerDurationInMinutes": { - "target": "com.amazonaws.connect#ParticipantTimerDurationInMinutes", - "traits": { - "smithy.api#documentation": "

The duration of a timer, in minutes.

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

The value of the timer. Either the timer action (Unset to delete the timer), or\n the duration of the timer in minutes. Only one value can be set.

\n

For more information about how chat timeouts work, see \n Set up chat timeouts for human participants.

" - } - }, - "com.amazonaws.connect#ParticipantToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.connect#Password": { - "type": "string", - "traits": { - "smithy.api#pattern": "^/^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)[a-zA-Z\\d\\S]{8,64}$/$" - } - }, - "com.amazonaws.connect#Percentage": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.connect#PermissionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#SecurityProfilePermission" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.connect#PhoneNumber": { - "type": "string", - "traits": { - "smithy.api#pattern": "^\\\\+[1-9]\\\\d{1,14}$" - } - }, - "com.amazonaws.connect#PhoneNumberCountryCode": { - "type": "enum", - "members": { - "AF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AF" - } - }, - "AL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AL" - } - }, - "DZ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DZ" - } - }, - "AS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AS" - } - }, - "AD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AD" - } - }, - "AO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AO" - } - }, - "AI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AI" - } - }, - "AQ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AQ" - } - }, - "AG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AG" - } - }, - "AR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AR" - } - }, - "AM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AM" - } - }, - "AW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AW" - } - }, - "AU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AU" - } - }, - "AT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AT" - } - }, - "AZ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AZ" - } - }, - "BS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BS" - } - }, - "BH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BH" - } - }, - "BD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BD" - } - }, - "BB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BB" - } - }, - "BY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BY" - } - }, - "BE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BE" - } - }, - "BZ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BZ" - } - }, - "BJ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BJ" - } - }, - "BM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BM" - } - }, - "BT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BT" - } - }, - "BO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BO" - } - }, - "BA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BA" - } - }, - "BW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BW" - } - }, - "BR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BR" - } - }, - "IO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IO" - } - }, - "VG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VG" - } - }, - "BN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BN" - } - }, - "BG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BG" - } - }, - "BF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BF" - } - }, - "BI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BI" - } - }, - "KH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KH" - } - }, - "CM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CM" - } - }, - "CA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CA" - } - }, - "CV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CV" - } - }, - "KY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KY" - } - }, - "CF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CF" - } - }, - "TD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TD" - } - }, - "CL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CL" - } - }, - "CN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CN" - } - }, - "CX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CX" - } - }, - "CC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CC" - } - }, - "CO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CO" - } - }, - "KM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KM" - } - }, - "CK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CK" - } - }, - "CR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CR" - } - }, - "HR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HR" - } - }, - "CU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CU" - } - }, - "CW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CW" - } - }, - "CY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CY" - } - }, - "CZ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CZ" - } - }, - "CD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CD" - } - }, - "DK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DK" - } - }, - "DJ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DJ" - } - }, - "DM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DM" - } - }, - "DO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DO" - } - }, - "TL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TL" - } - }, - "EC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EC" - } - }, - "EG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EG" - } - }, - "SV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SV" - } - }, - "GQ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GQ" - } - }, - "ER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ER" - } - }, - "EE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EE" - } - }, - "ET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ET" - } - }, - "FK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FK" - } - }, - "FO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FO" - } - }, - "FJ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FJ" - } - }, - "FI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FI" - } - }, - "FR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FR" - } - }, - "PF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PF" - } - }, - "GA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GA" - } - }, - "GM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GM" - } - }, - "GE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GE" - } - }, - "DE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DE" - } - }, - "GH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GH" - } - }, - "GI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GI" - } - }, - "GR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GR" - } - }, - "GL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GL" - } - }, - "GD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GD" - } - }, - "GU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GU" - } - }, - "GT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GT" - } - }, - "GG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GG" - } - }, - "GN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GN" - } - }, - "GW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GW" - } - }, - "GY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GY" - } - }, - "HT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HT" - } - }, - "HN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HN" - } - }, - "HK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HK" - } - }, - "HU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HU" - } - }, - "IS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IS" - } - }, - "IN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN" - } - }, - "ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ID" - } - }, - "IR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IR" - } - }, - "IQ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IQ" - } - }, - "IE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IE" - } - }, - "IM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IM" - } - }, - "IL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IL" - } - }, - "IT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IT" - } - }, - "CI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CI" - } - }, - "JM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JM" - } - }, - "JP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JP" - } - }, - "JE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JE" - } - }, - "JO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JO" - } - }, - "KZ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KZ" - } - }, - "KE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KE" - } - }, - "KI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KI" - } - }, - "KW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KW" - } - }, - "KG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KG" - } - }, - "LA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LA" - } - }, - "LV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LV" - } - }, - "LB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LB" - } - }, - "LS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LS" - } - }, - "LR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LR" - } - }, - "LY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LY" - } - }, - "LI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LI" - } - }, - "LT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LT" - } - }, - "LU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LU" - } - }, - "MO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MO" - } - }, - "MK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MK" - } - }, - "MG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MG" - } - }, - "MW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MW" - } - }, - "MY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MY" - } - }, - "MV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MV" - } - }, - "ML": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ML" - } - }, - "MT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MT" - } - }, - "MH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MH" - } - }, - "MR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MR" - } - }, - "MU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MU" - } - }, - "YT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "YT" - } - }, - "MX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MX" - } - }, - "FM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FM" - } - }, - "MD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MD" - } - }, - "MC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MC" - } - }, - "MN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MN" - } - }, - "ME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ME" - } - }, - "MS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MS" - } - }, - "MA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MA" - } - }, - "MZ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MZ" - } - }, - "MM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MM" - } - }, - "NA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NA" - } - }, - "NR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NR" - } - }, - "NP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NP" - } - }, - "NL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NL" - } - }, - "AN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AN" - } - }, - "NC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NC" - } - }, - "NZ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NZ" - } - }, - "NI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NI" - } - }, - "NE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NE" - } - }, - "NG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NG" - } - }, - "NU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NU" - } - }, - "KP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KP" - } - }, - "MP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MP" - } - }, - "NO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NO" - } - }, - "OM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OM" - } - }, - "PK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PK" - } - }, - "PW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PW" - } - }, - "PA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PA" - } - }, - "PG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PG" - } - }, - "PY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PY" - } - }, - "PE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PE" - } - }, - "PH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PH" - } - }, - "PN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PN" - } - }, - "PL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PL" - } - }, - "PT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PT" - } - }, - "PR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PR" - } - }, - "QA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QA" - } - }, - "CG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CG" - } - }, - "RE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RE" - } - }, - "RO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RO" - } - }, - "RU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RU" - } - }, - "RW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RW" - } - }, - "BL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BL" - } - }, - "SH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SH" - } - }, - "KN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KN" - } - }, - "LC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LC" - } - }, - "MF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MF" - } - }, - "PM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PM" - } - }, - "VC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VC" - } - }, - "WS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WS" - } - }, - "SM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SM" - } - }, - "ST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ST" - } - }, - "SA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SA" - } - }, - "SN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SN" - } - }, - "RS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RS" - } - }, - "SC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SC" - } - }, - "SL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SL" - } - }, - "SG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SG" - } - }, - "SX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SX" - } - }, - "SK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SK" - } - }, - "SI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SI" - } - }, - "SB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SB" - } - }, - "SO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SO" - } - }, - "ZA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ZA" - } - }, - "KR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KR" - } - }, - "ES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ES" - } - }, - "LK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LK" - } - }, - "SD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SD" - } - }, - "SR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SR" - } - }, - "SJ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SJ" - } - }, - "SZ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SZ" - } - }, - "SE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SE" - } - }, - "CH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CH" - } - }, - "SY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SY" - } - }, - "TW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TW" - } - }, - "TJ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TJ" - } - }, - "TZ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TZ" - } - }, - "TH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TH" - } - }, - "TG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TG" - } - }, - "TK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TK" - } - }, - "TO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TO" - } - }, - "TT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TT" - } - }, - "TN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TN" - } - }, - "TR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TR" - } - }, - "TM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TM" - } - }, - "TC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TC" - } - }, - "TV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TV" - } - }, - "VI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VI" - } - }, - "UG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UG" - } - }, - "UA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UA" - } - }, - "AE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AE" - } - }, - "GB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GB" - } - }, - "US": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "US" - } - }, - "UY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UY" - } - }, - "UZ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UZ" - } - }, - "VU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VU" - } - }, - "VA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VA" - } - }, - "VE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VE" - } - }, - "VN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VN" - } - }, - "WF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WF" - } - }, - "EH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EH" - } - }, - "YE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "YE" - } - }, - "ZM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ZM" - } - }, - "ZW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ZW" - } - } - } - }, - "com.amazonaws.connect#PhoneNumberCountryCodes": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#PhoneNumberCountryCode" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.connect#PhoneNumberDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - }, - "smithy.api#pattern": "^[\\W\\S_]*$" - } - }, - "com.amazonaws.connect#PhoneNumberId": { - "type": "string" - }, - "com.amazonaws.connect#PhoneNumberPrefix": { - "type": "string", - "traits": { - "smithy.api#pattern": "^\\\\+?[0-9]{1,11}$" - } - }, - "com.amazonaws.connect#PhoneNumberQuickConnectConfig": { - "type": "structure", - "members": { - "PhoneNumber": { - "target": "com.amazonaws.connect#PhoneNumber", - "traits": { - "smithy.api#documentation": "

The phone number in E.164 format.

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

Contains information about a phone number for a quick connect.

" - } - }, - "com.amazonaws.connect#PhoneNumberStatus": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.connect#PhoneNumberWorkflowStatus", - "traits": { - "smithy.api#documentation": "

The status.

" - } - }, - "Message": { - "target": "com.amazonaws.connect#PhoneNumberWorkflowMessage", - "traits": { - "smithy.api#documentation": "

The status message.

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

The status of the phone number.

\n " - } - }, - "com.amazonaws.connect#PhoneNumberSummary": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#PhoneNumberId", - "traits": { - "smithy.api#documentation": "

The identifier of the phone number.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the phone number.

" - } - }, - "PhoneNumber": { - "target": "com.amazonaws.connect#PhoneNumber", - "traits": { - "smithy.api#documentation": "

The phone number.

" - } - }, - "PhoneNumberType": { - "target": "com.amazonaws.connect#PhoneNumberType", - "traits": { - "smithy.api#documentation": "

The type of phone number.

" - } - }, - "PhoneNumberCountryCode": { - "target": "com.amazonaws.connect#PhoneNumberCountryCode", - "traits": { - "smithy.api#documentation": "

The ISO country code.

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

Contains summary information about a phone number for a contact center.

" - } - }, - "com.amazonaws.connect#PhoneNumberSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#PhoneNumberSummary" - } - }, - "com.amazonaws.connect#PhoneNumberType": { - "type": "enum", - "members": { - "TOLL_FREE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TOLL_FREE" - } - }, - "DID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DID" - } - } - } - }, - "com.amazonaws.connect#PhoneNumberTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#PhoneNumberType" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2 - } - } - }, - "com.amazonaws.connect#PhoneNumberWorkflowMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": "^[\\W\\S_]*$" - } - }, - "com.amazonaws.connect#PhoneNumberWorkflowStatus": { - "type": "enum", - "members": { - "Claimed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLAIMED" - } - }, - "InProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.connect#PhoneType": { - "type": "enum", - "members": { - "SOFT_PHONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SOFT_PHONE" - } - }, - "DESK_PHONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DESK_PHONE" - } - } - } - }, - "com.amazonaws.connect#Prefix": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.connect#Priority": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 99 - } - } - }, - "com.amazonaws.connect#ProblemDetail": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.connect#ProblemMessageString", - "traits": { - "smithy.api#documentation": "

The problem detail's message.

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

Information about a problem detail.

" - } - }, - "com.amazonaws.connect#ProblemMessageString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.connect#Problems": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#ProblemDetail" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.connect#PromptId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.connect#PromptName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.connect#PromptSummary": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#PromptId", - "traits": { - "smithy.api#documentation": "

The identifier of the prompt.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the prompt.

" - } - }, - "Name": { - "target": "com.amazonaws.connect#PromptName", - "traits": { - "smithy.api#documentation": "

The name of the prompt.

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

Contains information about the prompt.

" - } - }, - "com.amazonaws.connect#PromptSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#PromptSummary" - } - }, - "com.amazonaws.connect#PropertyValidationException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.connect#Message", - "traits": { - "smithy.api#required": {} - } - }, - "PropertyList": { - "target": "com.amazonaws.connect#PropertyValidationExceptionPropertyList" - } - }, - "traits": { - "smithy.api#documentation": "

The property is not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.connect#PropertyValidationExceptionProperty": { - "type": "structure", - "members": { - "PropertyPath": { - "target": "com.amazonaws.connect#String", - "traits": { - "smithy.api#documentation": "

The full property path.

", - "smithy.api#required": {} - } - }, - "Reason": { - "target": "com.amazonaws.connect#PropertyValidationExceptionReason", - "traits": { - "smithy.api#documentation": "

Why the property is not valid.

", - "smithy.api#required": {} - } - }, - "Message": { - "target": "com.amazonaws.connect#Message", - "traits": { - "smithy.api#documentation": "

A message describing why the property is not valid.

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

Contains information about why a property is not valid.

" - } - }, - "com.amazonaws.connect#PropertyValidationExceptionPropertyList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#PropertyValidationExceptionProperty" - } - }, - "com.amazonaws.connect#PropertyValidationExceptionReason": { - "type": "enum", - "members": { - "INVALID_FORMAT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INVALID_FORMAT" - } - }, - "UNIQUE_CONSTRAINT_VIOLATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNIQUE_CONSTRAINT_VIOLATED" - } - }, - "REFERENCED_RESOURCE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REFERENCED_RESOURCE_NOT_FOUND" - } - }, - "RESOURCE_NAME_ALREADY_EXISTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESOURCE_NAME_ALREADY_EXISTS" - } - }, - "REQUIRED_PROPERTY_MISSING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REQUIRED_PROPERTY_MISSING" - } - }, - "NOT_SUPPORTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_SUPPORTED" - } - } - } - }, - "com.amazonaws.connect#PutUserStatus": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#PutUserStatusRequest" - }, - "output": { - "target": "com.amazonaws.connect#PutUserStatusResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Changes the current status of a user or agent in Amazon Connect. If the agent is\n currently handling a contact, this sets the agent's next status.

\n

For more information, see Agent status and Set your next\n status in the Amazon Connect Administrator Guide.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/users/{InstanceId}/{UserId}/status", - "code": 200 - } - } - }, - "com.amazonaws.connect#PutUserStatusRequest": { - "type": "structure", - "members": { - "UserId": { - "target": "com.amazonaws.connect#UserId", - "traits": { - "smithy.api#documentation": "

The identifier of the user.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AgentStatusId": { - "target": "com.amazonaws.connect#AgentStatusId", - "traits": { - "smithy.api#documentation": "

The identifier of the agent status.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#PutUserStatusResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.connect#Queue": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.connect#CommonNameLength127", - "traits": { - "smithy.api#documentation": "

The name of the queue.

" - } - }, - "QueueArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the queue.

" - } - }, - "QueueId": { - "target": "com.amazonaws.connect#QueueId", - "traits": { - "smithy.api#documentation": "

The identifier for the queue.

" - } - }, - "Description": { - "target": "com.amazonaws.connect#QueueDescription", - "traits": { - "smithy.api#documentation": "

The description of the queue.

" - } - }, - "OutboundCallerConfig": { - "target": "com.amazonaws.connect#OutboundCallerConfig", - "traits": { - "smithy.api#documentation": "

The outbound caller ID name, number, and outbound whisper flow.

" - } - }, - "HoursOfOperationId": { - "target": "com.amazonaws.connect#HoursOfOperationId", - "traits": { - "smithy.api#documentation": "

The identifier for the hours of operation.

" - } - }, - "MaxContacts": { - "target": "com.amazonaws.connect#QueueMaxContacts", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of contacts that can be in the queue before it is considered full.

" - } - }, - "Status": { - "target": "com.amazonaws.connect#QueueStatus", - "traits": { - "smithy.api#documentation": "

The status of the queue.

" - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

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

Contains information about a queue.

" - } - }, - "com.amazonaws.connect#QueueDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 250 - } - } - }, - "com.amazonaws.connect#QueueId": { - "type": "string" - }, - "com.amazonaws.connect#QueueInfo": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#QueueId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the queue.

" - } - }, - "EnqueueTimestamp": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp when the contact was added to the queue.

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

If this contact was queued, this contains information about the queue.

" - } - }, - "com.amazonaws.connect#QueueMaxContacts": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.connect#QueueName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.connect#QueueQuickConnectConfig": { - "type": "structure", - "members": { - "QueueId": { - "target": "com.amazonaws.connect#QueueId", - "traits": { - "smithy.api#documentation": "

The identifier for the queue.

", - "smithy.api#required": {} - } - }, - "ContactFlowId": { - "target": "com.amazonaws.connect#ContactFlowId", - "traits": { - "smithy.api#documentation": "

The identifier of the flow.

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

Contains information about a queue for a quick connect. The flow must be of type Transfer to\n Queue.

" - } - }, - "com.amazonaws.connect#QueueReference": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#QueueId", - "traits": { - "smithy.api#documentation": "

The identifier of the queue.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the queue.

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

Contains information about a queue resource for which metrics are returned.

" - } - }, - "com.amazonaws.connect#QueueSearchConditionList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#QueueSearchCriteria" - } - }, - "com.amazonaws.connect#QueueSearchCriteria": { - "type": "structure", - "members": { - "OrConditions": { - "target": "com.amazonaws.connect#QueueSearchConditionList", - "traits": { - "smithy.api#documentation": "

A list of conditions which would be applied together with an OR condition.

" - } - }, - "AndConditions": { - "target": "com.amazonaws.connect#QueueSearchConditionList", - "traits": { - "smithy.api#documentation": "

A list of conditions which would be applied together with an AND condition.

" - } - }, - "StringCondition": { - "target": "com.amazonaws.connect#StringCondition" - }, - "QueueTypeCondition": { - "target": "com.amazonaws.connect#SearchableQueueType", - "traits": { - "smithy.api#documentation": "

The type of queue.

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

The search criteria to be used to return queues.

\n \n

The name and description fields support \"contains\" queries with\n a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths\n outside of this range will throw invalid results.

\n " - } - }, - "com.amazonaws.connect#QueueSearchFilter": { - "type": "structure", - "members": { - "TagFilter": { - "target": "com.amazonaws.connect#ControlPlaneTagFilter" - } - }, - "traits": { - "smithy.api#documentation": "

Filters to be applied to search results.

" - } - }, - "com.amazonaws.connect#QueueSearchSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#Queue" - } - }, - "com.amazonaws.connect#QueueStatus": { - "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.connect#QueueSummary": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#QueueId", - "traits": { - "smithy.api#documentation": "

The identifier of the queue.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the queue.

" - } - }, - "Name": { - "target": "com.amazonaws.connect#QueueName", - "traits": { - "smithy.api#documentation": "

The name of the queue.

" - } - }, - "QueueType": { - "target": "com.amazonaws.connect#QueueType", - "traits": { - "smithy.api#documentation": "

The type of queue.

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

Contains summary information about a queue.

" - } - }, - "com.amazonaws.connect#QueueSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#QueueSummary" - } - }, - "com.amazonaws.connect#QueueType": { - "type": "enum", - "members": { - "STANDARD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STANDARD" - } - }, - "AGENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AGENT" - } - } - } - }, - "com.amazonaws.connect#QueueTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#QueueType" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2 - } - } - }, - "com.amazonaws.connect#Queues": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#QueueId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.connect#QuickConnect": { - "type": "structure", - "members": { - "QuickConnectARN": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the quick connect.

" - } - }, - "QuickConnectId": { - "target": "com.amazonaws.connect#QuickConnectId", - "traits": { - "smithy.api#documentation": "

The identifier for the quick connect.

" - } - }, - "Name": { - "target": "com.amazonaws.connect#QuickConnectName", - "traits": { - "smithy.api#documentation": "

The name of the quick connect.

" - } - }, - "Description": { - "target": "com.amazonaws.connect#QuickConnectDescription", - "traits": { - "smithy.api#documentation": "

The description.

" - } - }, - "QuickConnectConfig": { - "target": "com.amazonaws.connect#QuickConnectConfig", - "traits": { - "smithy.api#documentation": "

Contains information about the quick connect.

" - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

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

Contains information about a quick connect.

" - } - }, - "com.amazonaws.connect#QuickConnectConfig": { - "type": "structure", - "members": { - "QuickConnectType": { - "target": "com.amazonaws.connect#QuickConnectType", - "traits": { - "smithy.api#documentation": "

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are\n prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

", - "smithy.api#required": {} - } - }, - "UserConfig": { - "target": "com.amazonaws.connect#UserQuickConnectConfig", - "traits": { - "smithy.api#documentation": "

The user configuration. This is required only if QuickConnectType is USER.

" - } - }, - "QueueConfig": { - "target": "com.amazonaws.connect#QueueQuickConnectConfig", - "traits": { - "smithy.api#documentation": "

The queue configuration. This is required only if QuickConnectType is QUEUE.

" - } - }, - "PhoneConfig": { - "target": "com.amazonaws.connect#PhoneNumberQuickConnectConfig", - "traits": { - "smithy.api#documentation": "

The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.

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

Contains configuration settings for a quick connect.

" - } - }, - "com.amazonaws.connect#QuickConnectDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 250 - } - } - }, - "com.amazonaws.connect#QuickConnectId": { - "type": "string" - }, - "com.amazonaws.connect#QuickConnectName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 127 - } - } - }, - "com.amazonaws.connect#QuickConnectSummary": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#QuickConnectId", - "traits": { - "smithy.api#documentation": "

The identifier for the quick connect.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the quick connect.

" - } - }, - "Name": { - "target": "com.amazonaws.connect#QuickConnectName", - "traits": { - "smithy.api#documentation": "

The name of the quick connect.

" - } - }, - "QuickConnectType": { - "target": "com.amazonaws.connect#QuickConnectType", - "traits": { - "smithy.api#documentation": "

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are\n prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

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

Contains summary information about a quick connect.

" - } - }, - "com.amazonaws.connect#QuickConnectSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#QuickConnectSummary" - } - }, - "com.amazonaws.connect#QuickConnectType": { - "type": "enum", - "members": { - "USER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "USER" - } - }, - "QUEUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUEUE" - } - }, - "PHONE_NUMBER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PHONE_NUMBER" - } - } - } - }, - "com.amazonaws.connect#QuickConnectTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#QuickConnectType" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 3 - } - } - }, - "com.amazonaws.connect#QuickConnectsList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#QuickConnectId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.connect#ReadOnlyFieldInfo": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#TaskTemplateFieldIdentifier", - "traits": { - "smithy.api#documentation": "

Identifier of the read-only field.

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

Indicates a field that is read-only to an agent.

" - } - }, - "com.amazonaws.connect#ReadOnlyTaskTemplateFields": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#ReadOnlyFieldInfo" - } - }, - "com.amazonaws.connect#Reference": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.connect#ReferenceValue", - "traits": { - "smithy.api#documentation": "

A valid value for the reference. For example, for a URL reference, a formatted URL that is\n displayed to an agent in the Contact Control Panel (CCP).

", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.connect#ReferenceType", - "traits": { - "smithy.api#documentation": "

The type of the reference. DATE must be of type Epoch timestamp.\n

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

Well-formed data on a contact, used by agents to complete a contact request. You can have up\n to 4,096 UTF-8 bytes across all references for a contact.

" - } - }, - "com.amazonaws.connect#ReferenceKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 4096 - } - } - }, - "com.amazonaws.connect#ReferenceStatus": { - "type": "enum", - "members": { - "APPROVED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "APPROVED" - } - }, - "REJECTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REJECTED" - } - } - } - }, - "com.amazonaws.connect#ReferenceSummary": { - "type": "union", - "members": { - "Url": { - "target": "com.amazonaws.connect#UrlReference", - "traits": { - "smithy.api#documentation": "

Information about the reference when the referenceType is URL.\n Otherwise, null.

" - } - }, - "Attachment": { - "target": "com.amazonaws.connect#AttachmentReference", - "traits": { - "smithy.api#documentation": "

Information about the reference when the referenceType is\n ATTACHMENT. Otherwise, null.

" - } - }, - "String": { - "target": "com.amazonaws.connect#StringReference", - "traits": { - "smithy.api#documentation": "

Information about a reference when the referenceType is STRING.\n Otherwise, null.

" - } - }, - "Number": { - "target": "com.amazonaws.connect#NumberReference", - "traits": { - "smithy.api#documentation": "

Information about a reference when the referenceType is NUMBER.\n Otherwise, null.

" - } - }, - "Date": { - "target": "com.amazonaws.connect#DateReference", - "traits": { - "smithy.api#documentation": "

Information about a reference when the referenceType is DATE.\n Otherwise, null.

" - } - }, - "Email": { - "target": "com.amazonaws.connect#EmailReference", - "traits": { - "smithy.api#documentation": "

Information about a reference when the referenceType is EMAIL.\n Otherwise, null.

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

Contains summary information about a reference. ReferenceSummary contains only\n one non null field between the URL and attachment based on the reference type.

" - } - }, - "com.amazonaws.connect#ReferenceSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#ReferenceSummary" - } - }, - "com.amazonaws.connect#ReferenceType": { - "type": "enum", - "members": { - "URL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "URL" - } - }, - "ATTACHMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ATTACHMENT" - } - }, - "NUMBER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NUMBER" - } - }, - "STRING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STRING" - } - }, - "DATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATE" - } - }, - "EMAIL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EMAIL" - } - } - } - }, - "com.amazonaws.connect#ReferenceTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#ReferenceType" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 6 - } - } - }, - "com.amazonaws.connect#ReferenceValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 4096 - } - } - }, - "com.amazonaws.connect#ReleasePhoneNumber": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ReleasePhoneNumberRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#IdempotencyException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#ResourceInUseException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You\n can call this API only in the Amazon Web Services Region where the number was claimed.

\n \n

To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the\n Amazon Connect console.

\n

After releasing a phone number, the phone number enters into a cooldown period of 30 days.\n It cannot be searched for or claimed again until the period has ended. If you accidentally\n release a phone number, contact Amazon Web Services Support.

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/phone-number/{PhoneNumberId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#ReleasePhoneNumberRequest": { - "type": "structure", - "members": { - "PhoneNumberId": { - "target": "com.amazonaws.connect#PhoneNumberId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the phone number.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.connect#ClientToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", - "smithy.api#httpQuery": "clientToken", - "smithy.api#idempotencyToken": {} - } - } - } - }, - "com.amazonaws.connect#ReplicateInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ReplicateInstanceRequest" - }, - "output": { - "target": "com.amazonaws.connect#ReplicateInstanceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceConflictException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ResourceNotReadyException" - }, - { - "target": "com.amazonaws.connect#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Replicates an Amazon Connect instance in the specified Amazon Web Services Region.

\n

For more information about replicating an Amazon Connect instance, see Create\n a replica of your existing Amazon Connect instance in the Amazon Connect\n Administrator Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/instance/{InstanceId}/replicate", - "code": 200 - } - } - }, - "com.amazonaws.connect#ReplicateInstanceRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceIdOrArn", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. You can provide the InstanceId, or the entire ARN.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ReplicaRegion": { - "target": "com.amazonaws.connect#AwsRegion", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region where to replicate the Amazon Connect instance.

", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.connect#ClientToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", - "smithy.api#idempotencyToken": {} - } - }, - "ReplicaAlias": { - "target": "com.amazonaws.connect#DirectoryAlias", - "traits": { - "smithy.api#documentation": "

The alias for the replicated instance. The ReplicaAlias must be unique.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#ReplicateInstanceResponse": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the replicated instance. You can find the instanceId in the\n ARN of the instance. The replicated instance has the same identifier as the instance it was\n replicated from.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicated instance.

" - } - } - } - }, - "com.amazonaws.connect#RequiredFieldInfo": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#TaskTemplateFieldIdentifier", - "traits": { - "smithy.api#documentation": "

The unique identifier for the field.

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

Information about a required field.

" - } - }, - "com.amazonaws.connect#RequiredTaskTemplateFields": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#RequiredFieldInfo" - } - }, - "com.amazonaws.connect#ResourceConflictException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.connect#Message" - } - }, - "traits": { - "smithy.api#documentation": "

A resource already has that name.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.connect#ResourceInUseException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.connect#Message" - }, - "ResourceType": { - "target": "com.amazonaws.connect#ResourceType", - "traits": { - "smithy.api#documentation": "

The type of resource.

" - } - }, - "ResourceId": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The identifier for the resource.

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

That resource is already in use. Please try another.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.connect#ResourceNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.connect#Message", - "traits": { - "smithy.api#documentation": "

The message about the resource.

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

The specified resource was not found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.connect#ResourceNotReadyException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.connect#Message" - } - }, - "traits": { - "smithy.api#documentation": "

The resource is not ready.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.connect#ResourceType": { - "type": "enum", - "members": { - "CONTACT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTACT" - } - }, - "CONTACT_FLOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTACT_FLOW" - } - }, - "INSTANCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INSTANCE" - } - }, - "PARTICIPANT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARTICIPANT" - } - }, - "HIERARCHY_LEVEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HIERARCHY_LEVEL" - } - }, - "HIERARCHY_GROUP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HIERARCHY_GROUP" - } - }, - "USER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "USER" - } - } - } - }, - "com.amazonaws.connect#ResumeContactRecording": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#ResumeContactRecordingRequest" - }, - "output": { - "target": "com.amazonaws.connect#ResumeContactRecordingResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

When a contact is being recorded, and the recording has been suspended using\n SuspendContactRecording, this API resumes recording the call.

\n

Only voice recordings are supported at this time.

", - "smithy.api#http": { - "method": "POST", - "uri": "/contact/resume-recording", - "code": 200 - } - } - }, - "com.amazonaws.connect#ResumeContactRecordingRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#required": {} - } - }, - "ContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the contact.

", - "smithy.api#required": {} - } - }, - "InitialContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the contact. This is the identifier of the contact associated with the\n first interaction with the contact center.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#ResumeContactRecordingResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.connect#RoutingProfile": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

" - } - }, - "Name": { - "target": "com.amazonaws.connect#RoutingProfileName", - "traits": { - "smithy.api#documentation": "

The name of the routing profile.

" - } - }, - "RoutingProfileArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the routing profile.

" - } - }, - "RoutingProfileId": { - "target": "com.amazonaws.connect#RoutingProfileId", - "traits": { - "smithy.api#documentation": "

The identifier of the routing profile.

" - } - }, - "Description": { - "target": "com.amazonaws.connect#RoutingProfileDescription", - "traits": { - "smithy.api#documentation": "

The description of the routing profile.

" - } - }, - "MediaConcurrencies": { - "target": "com.amazonaws.connect#MediaConcurrencies", - "traits": { - "smithy.api#documentation": "

The channels agents can handle in the Contact Control Panel (CCP) for this routing\n profile.

" - } - }, - "DefaultOutboundQueueId": { - "target": "com.amazonaws.connect#QueueId", - "traits": { - "smithy.api#documentation": "

The identifier of the default outbound queue for this routing profile.

" - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" - } - }, - "NumberOfAssociatedQueues": { - "target": "com.amazonaws.connect#Long", - "traits": { - "smithy.api#documentation": "

The number of associated queues in routing profile.

" - } - }, - "NumberOfAssociatedUsers": { - "target": "com.amazonaws.connect#Long", - "traits": { - "smithy.api#documentation": "

The number of associated users in routing profile.

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

Contains information about a routing profile.

" - } - }, - "com.amazonaws.connect#RoutingProfileDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 250 - } - } - }, - "com.amazonaws.connect#RoutingProfileId": { - "type": "string" - }, - "com.amazonaws.connect#RoutingProfileList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#RoutingProfile" - } - }, - "com.amazonaws.connect#RoutingProfileName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 127 - } - } - }, - "com.amazonaws.connect#RoutingProfileQueueConfig": { - "type": "structure", - "members": { - "QueueReference": { - "target": "com.amazonaws.connect#RoutingProfileQueueReference", - "traits": { - "smithy.api#documentation": "

Contains information about a queue resource.

", - "smithy.api#required": {} - } - }, - "Priority": { - "target": "com.amazonaws.connect#Priority", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The order in which contacts are to be handled for the queue. For more information, see\n Queues: priority and\n delay.

", - "smithy.api#required": {} - } - }, - "Delay": { - "target": "com.amazonaws.connect#Delay", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The delay, in seconds, a contact should be in the queue before they are routed to an\n available agent. For more information, see Queues: priority and\n delay in the Amazon Connect Administrator Guide.

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

Contains information about the queue and channel for which priority and delay can be\n set.

" - } - }, - "com.amazonaws.connect#RoutingProfileQueueConfigList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#RoutingProfileQueueConfig" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.connect#RoutingProfileQueueConfigSummary": { - "type": "structure", - "members": { - "QueueId": { - "target": "com.amazonaws.connect#QueueId", - "traits": { - "smithy.api#documentation": "

The identifier for the queue.

", - "smithy.api#required": {} - } - }, - "QueueArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the queue.

", - "smithy.api#required": {} - } - }, - "QueueName": { - "target": "com.amazonaws.connect#QueueName", - "traits": { - "smithy.api#documentation": "

The name of the queue.

", - "smithy.api#required": {} - } - }, - "Priority": { - "target": "com.amazonaws.connect#Priority", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The order in which contacts are to be handled for the queue. For more information, see\n Queues: priority and\n delay.

", - "smithy.api#required": {} - } - }, - "Delay": { - "target": "com.amazonaws.connect#Delay", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The delay, in seconds, that a contact should be in the queue before they are routed to an\n available agent. For more information, see Queues: priority and\n delay in the Amazon Connect Administrator Guide.

", - "smithy.api#required": {} - } - }, - "Channel": { - "target": "com.amazonaws.connect#Channel", - "traits": { - "smithy.api#documentation": "

The channels this queue supports.

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

Contains summary information about a routing profile queue.

" - } - }, - "com.amazonaws.connect#RoutingProfileQueueConfigSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#RoutingProfileQueueConfigSummary" - } - }, - "com.amazonaws.connect#RoutingProfileQueueReference": { - "type": "structure", - "members": { - "QueueId": { - "target": "com.amazonaws.connect#QueueId", - "traits": { - "smithy.api#documentation": "

The identifier for the queue.

", - "smithy.api#required": {} - } - }, - "Channel": { - "target": "com.amazonaws.connect#Channel", - "traits": { - "smithy.api#documentation": "

The channels agents can handle in the Contact Control Panel (CCP) for this routing\n profile.

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

Contains the channel and queue identifier for a routing profile.

" - } - }, - "com.amazonaws.connect#RoutingProfileQueueReferenceList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#RoutingProfileQueueReference" - } - }, - "com.amazonaws.connect#RoutingProfileReference": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#RoutingProfileId", - "traits": { - "smithy.api#documentation": "

The identifier of the routing profile.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the routing profile.

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

Information about the routing profile assigned to the user.

" - } - }, - "com.amazonaws.connect#RoutingProfileSearchConditionList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#RoutingProfileSearchCriteria" - } - }, - "com.amazonaws.connect#RoutingProfileSearchCriteria": { - "type": "structure", - "members": { - "OrConditions": { - "target": "com.amazonaws.connect#RoutingProfileSearchConditionList", - "traits": { - "smithy.api#documentation": "

A list of conditions which would be applied together with an OR condition.

" - } - }, - "AndConditions": { - "target": "com.amazonaws.connect#RoutingProfileSearchConditionList", - "traits": { - "smithy.api#documentation": "

A list of conditions which would be applied together with an AND condition.

" - } - }, - "StringCondition": { - "target": "com.amazonaws.connect#StringCondition" - } - }, - "traits": { - "smithy.api#documentation": "

The search criteria to be used to return routing profiles.

\n \n

The name and description fields support \"contains\" queries with\n a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths\n outside of this range will throw invalid results.

\n " - } - }, - "com.amazonaws.connect#RoutingProfileSearchFilter": { - "type": "structure", - "members": { - "TagFilter": { - "target": "com.amazonaws.connect#ControlPlaneTagFilter" - } - }, - "traits": { - "smithy.api#documentation": "

Filters to be applied to search results.

" - } - }, - "com.amazonaws.connect#RoutingProfileSummary": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#RoutingProfileId", - "traits": { - "smithy.api#documentation": "

The identifier of the routing profile.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the routing profile.

" - } - }, - "Name": { - "target": "com.amazonaws.connect#RoutingProfileName", - "traits": { - "smithy.api#documentation": "

The name of the routing profile.

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

Contains summary information about a routing profile.

" - } - }, - "com.amazonaws.connect#RoutingProfileSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#RoutingProfileSummary" - } - }, - "com.amazonaws.connect#RoutingProfiles": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#RoutingProfileId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.connect#Rule": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.connect#RuleName", - "traits": { - "smithy.api#documentation": "

The name of the rule.

", - "smithy.api#required": {} - } - }, - "RuleId": { - "target": "com.amazonaws.connect#RuleId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the rule.

", - "smithy.api#required": {} - } - }, - "RuleArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule.

", - "smithy.api#required": {} - } - }, - "TriggerEventSource": { - "target": "com.amazonaws.connect#RuleTriggerEventSource", - "traits": { - "smithy.api#documentation": "

The event source to trigger the rule.

", - "smithy.api#required": {} - } - }, - "Function": { - "target": "com.amazonaws.connect#RuleFunction", - "traits": { - "smithy.api#documentation": "

The conditions of the rule.

", - "smithy.api#required": {} - } - }, - "Actions": { - "target": "com.amazonaws.connect#RuleActions", - "traits": { - "smithy.api#documentation": "

A list of actions to be run when the rule is triggered.

", - "smithy.api#required": {} - } - }, - "PublishStatus": { - "target": "com.amazonaws.connect#RulePublishStatus", - "traits": { - "smithy.api#documentation": "

The publish status of the rule.

", - "smithy.api#required": {} - } - }, - "CreatedTime": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp for when the rule was created.

", - "smithy.api#required": {} - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp for the when the rule was last updated.

", - "smithy.api#required": {} - } - }, - "LastUpdatedBy": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who last updated the rule.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

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

Information about a rule.

" - } - }, - "com.amazonaws.connect#RuleAction": { - "type": "structure", - "members": { - "ActionType": { - "target": "com.amazonaws.connect#ActionType", - "traits": { - "smithy.api#documentation": "

The type of action that creates a rule.

", - "smithy.api#required": {} - } - }, - "TaskAction": { - "target": "com.amazonaws.connect#TaskActionDefinition", - "traits": { - "smithy.api#documentation": "

Information about the task action. This field is required if TriggerEventSource\n is one of the following values: OnZendeskTicketCreate |\n OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate\n

" - } - }, - "EventBridgeAction": { - "target": "com.amazonaws.connect#EventBridgeActionDefinition", - "traits": { - "smithy.api#documentation": "

Information about the EventBridge action.

" - } - }, - "AssignContactCategoryAction": { - "target": "com.amazonaws.connect#AssignContactCategoryActionDefinition", - "traits": { - "smithy.api#documentation": "

Information about the contact category action.

" - } - }, - "SendNotificationAction": { - "target": "com.amazonaws.connect#SendNotificationActionDefinition", - "traits": { - "smithy.api#documentation": "

Information about the send notification action.

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

Information about the action to be performed when a rule is triggered.

" - } - }, - "com.amazonaws.connect#RuleActions": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#RuleAction" - } - }, - "com.amazonaws.connect#RuleFunction": { - "type": "string" - }, - "com.amazonaws.connect#RuleId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.connect#RuleName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - }, - "smithy.api#pattern": "^[0-9a-zA-Z._-]+$" - } - }, - "com.amazonaws.connect#RulePublishStatus": { - "type": "enum", - "members": { - "DRAFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DRAFT" - } - }, - "PUBLISHED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PUBLISHED" - } - } - } - }, - "com.amazonaws.connect#RuleSummary": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.connect#RuleName", - "traits": { - "smithy.api#documentation": "

The name of the rule.

", - "smithy.api#required": {} - } - }, - "RuleId": { - "target": "com.amazonaws.connect#RuleId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the rule.

", - "smithy.api#required": {} - } - }, - "RuleArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule.

", - "smithy.api#required": {} - } - }, - "EventSourceName": { - "target": "com.amazonaws.connect#EventSourceName", - "traits": { - "smithy.api#documentation": "

The name of the event source.

", - "smithy.api#required": {} - } - }, - "PublishStatus": { - "target": "com.amazonaws.connect#RulePublishStatus", - "traits": { - "smithy.api#documentation": "

The publish status of the rule.

", - "smithy.api#required": {} - } - }, - "ActionSummaries": { - "target": "com.amazonaws.connect#ActionSummaries", - "traits": { - "smithy.api#documentation": "

A list of ActionTypes associated with a rule.

", - "smithy.api#required": {} - } - }, - "CreatedTime": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp for when the rule was created.

", - "smithy.api#required": {} - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp for when the rule was last updated.

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

A list of ActionTypes associated with a rule.

" - } - }, - "com.amazonaws.connect#RuleSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#RuleSummary" - } - }, - "com.amazonaws.connect#RuleTriggerEventSource": { - "type": "structure", - "members": { - "EventSourceName": { - "target": "com.amazonaws.connect#EventSourceName", - "traits": { - "smithy.api#documentation": "

The name of the event source.

", - "smithy.api#required": {} - } - }, - "IntegrationAssociationId": { - "target": "com.amazonaws.connect#IntegrationAssociationId", - "traits": { - "smithy.api#documentation": "

The identifier for the integration association.

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

The name of the event source. This field is required if TriggerEventSource is one of the\n following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate |\n OnSalesforceCaseCreate\n

" - } - }, - "com.amazonaws.connect#S3Config": { - "type": "structure", - "members": { - "BucketName": { - "target": "com.amazonaws.connect#BucketName", - "traits": { - "smithy.api#documentation": "

The S3 bucket name.

", - "smithy.api#required": {} - } - }, - "BucketPrefix": { - "target": "com.amazonaws.connect#Prefix", - "traits": { - "smithy.api#documentation": "

The S3 bucket prefix.

", - "smithy.api#required": {} - } - }, - "EncryptionConfig": { - "target": "com.amazonaws.connect#EncryptionConfig", - "traits": { - "smithy.api#documentation": "

The Amazon S3 encryption configuration.

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

Information about the Amazon Simple Storage Service (Amazon S3) storage type.

" - } - }, - "com.amazonaws.connect#SearchAvailablePhoneNumbers": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#SearchAvailablePhoneNumbersRequest" - }, - "output": { - "target": "com.amazonaws.connect#SearchAvailablePhoneNumbersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Searches for available phone numbers that you can claim to your Amazon Connect instance\n or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both\n Amazon Web Services Regions associated with the traffic distribution group.

", - "smithy.api#http": { - "method": "POST", - "uri": "/phone-number/search-available", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "AvailableNumbersList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#SearchAvailablePhoneNumbersRequest": { - "type": "structure", - "members": { - "TargetArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

", - "smithy.api#required": {} - } - }, - "PhoneNumberCountryCode": { - "target": "com.amazonaws.connect#PhoneNumberCountryCode", - "traits": { - "smithy.api#documentation": "

The ISO country code.

", - "smithy.api#required": {} - } - }, - "PhoneNumberType": { - "target": "com.amazonaws.connect#PhoneNumberType", - "traits": { - "smithy.api#documentation": "

The type of phone number.

", - "smithy.api#required": {} - } - }, - "PhoneNumberPrefix": { - "target": "com.amazonaws.connect#PhoneNumberPrefix", - "traits": { - "smithy.api#documentation": "

The prefix of the phone number. If provided, it must contain + as part of the country code.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult10", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#LargeNextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#SearchAvailablePhoneNumbersResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.connect#LargeNextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - }, - "AvailableNumbersList": { - "target": "com.amazonaws.connect#AvailableNumbersList", - "traits": { - "smithy.api#documentation": "

A list of available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.

" - } - } - } - }, - "com.amazonaws.connect#SearchQueues": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#SearchQueuesRequest" - }, - "output": { - "target": "com.amazonaws.connect#SearchQueuesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Searches queues in an Amazon Connect instance, with optional filtering.

", - "smithy.api#http": { - "method": "POST", - "uri": "/search-queues", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Queues", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#SearchQueuesRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken2500", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult100", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page.

" - } - }, - "SearchFilter": { - "target": "com.amazonaws.connect#QueueSearchFilter", - "traits": { - "smithy.api#documentation": "

Filters to be applied to search results.

" - } - }, - "SearchCriteria": { - "target": "com.amazonaws.connect#QueueSearchCriteria", - "traits": { - "smithy.api#documentation": "

The search criteria to be used to return queues.

\n \n

The name and description fields support \"contains\" queries with\n a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths\n outside of this range will throw invalid results.

\n " - } - } - } - }, - "com.amazonaws.connect#SearchQueuesResponse": { - "type": "structure", - "members": { - "Queues": { - "target": "com.amazonaws.connect#QueueSearchSummaryList", - "traits": { - "smithy.api#documentation": "

Information about the queues.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken2500", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - }, - "ApproximateTotalCount": { - "target": "com.amazonaws.connect#ApproximateTotalCount", - "traits": { - "smithy.api#documentation": "

The total number of queues which matched your search query.

" - } - } - } - }, - "com.amazonaws.connect#SearchRoutingProfiles": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#SearchRoutingProfilesRequest" - }, - "output": { - "target": "com.amazonaws.connect#SearchRoutingProfilesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Searches routing profiles in an Amazon Connect instance, with optional filtering.

", - "smithy.api#http": { - "method": "POST", - "uri": "/search-routing-profiles", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "RoutingProfiles", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#SearchRoutingProfilesRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken2500", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult100", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page.

" - } - }, - "SearchFilter": { - "target": "com.amazonaws.connect#RoutingProfileSearchFilter", - "traits": { - "smithy.api#documentation": "

Filters to be applied to search results.

" - } - }, - "SearchCriteria": { - "target": "com.amazonaws.connect#RoutingProfileSearchCriteria", - "traits": { - "smithy.api#documentation": "

The search criteria to be used to return routing profiles.

\n \n

The name and description fields support \"contains\" queries with\n a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths\n outside of this range will throw invalid results.

\n " - } - } - } - }, - "com.amazonaws.connect#SearchRoutingProfilesResponse": { - "type": "structure", - "members": { - "RoutingProfiles": { - "target": "com.amazonaws.connect#RoutingProfileList", - "traits": { - "smithy.api#documentation": "

Information about the routing profiles.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken2500", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - }, - "ApproximateTotalCount": { - "target": "com.amazonaws.connect#ApproximateTotalCount", - "traits": { - "smithy.api#documentation": "

The total number of routing profiles which matched your search query.

" - } - } - } - }, - "com.amazonaws.connect#SearchSecurityProfiles": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#SearchSecurityProfilesRequest" - }, - "output": { - "target": "com.amazonaws.connect#SearchSecurityProfilesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Searches security profiles in an Amazon Connect instance, with optional\n filtering.

", - "smithy.api#http": { - "method": "POST", - "uri": "/search-security-profiles", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "SecurityProfiles", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#SearchSecurityProfilesRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken2500", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult100", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page.

" - } - }, - "SearchCriteria": { - "target": "com.amazonaws.connect#SecurityProfileSearchCriteria", - "traits": { - "smithy.api#documentation": "

The search criteria to be used to return security profiles.

\n \n

The name field support \"contains\" queries with a minimum of 2 characters and\n maximum of 25 characters. Any queries with character lengths outside of this range will throw\n invalid results.

\n \n \n

The currently supported value for FieldName: name\n

\n " - } - }, - "SearchFilter": { - "target": "com.amazonaws.connect#SecurityProfilesSearchFilter", - "traits": { - "smithy.api#documentation": "

Filters to be applied to search results.

" - } - } - } - }, - "com.amazonaws.connect#SearchSecurityProfilesResponse": { - "type": "structure", - "members": { - "SecurityProfiles": { - "target": "com.amazonaws.connect#SecurityProfilesSearchSummaryList", - "traits": { - "smithy.api#documentation": "

Information about the security profiles.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken2500", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - }, - "ApproximateTotalCount": { - "target": "com.amazonaws.connect#ApproximateTotalCount", - "traits": { - "smithy.api#documentation": "

The total number of security profiles which matched your search query.

" - } - } - } - }, - "com.amazonaws.connect#SearchUsers": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#SearchUsersRequest" - }, - "output": { - "target": "com.amazonaws.connect#SearchUsersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Searches users in an Amazon Connect instance, with optional filtering.

\n \n

\n AfterContactWorkTimeLimit is returned in milliseconds.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/search-users", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Users", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#SearchUsersRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken2500", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult100", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return per page.

" - } - }, - "SearchFilter": { - "target": "com.amazonaws.connect#UserSearchFilter", - "traits": { - "smithy.api#documentation": "

Filters to be applied to search results.

" - } - }, - "SearchCriteria": { - "target": "com.amazonaws.connect#UserSearchCriteria" - } - } - }, - "com.amazonaws.connect#SearchUsersResponse": { - "type": "structure", - "members": { - "Users": { - "target": "com.amazonaws.connect#UserSearchSummaryList", - "traits": { - "smithy.api#documentation": "

Information about the users.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken2500", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - }, - "ApproximateTotalCount": { - "target": "com.amazonaws.connect#ApproximateTotalCount", - "traits": { - "smithy.api#documentation": "

The total number of users who matched your search query.

" - } - } - } - }, - "com.amazonaws.connect#SearchVocabularies": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#SearchVocabulariesRequest" - }, - "output": { - "target": "com.amazonaws.connect#SearchVocabulariesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Searches for vocabularies within a specific Amazon Connect instance using\n State, NameStartsWith, and LanguageCode.

", - "smithy.api#http": { - "method": "POST", - "uri": "/vocabulary-summary/{InstanceId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "VocabularySummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.connect#SearchVocabulariesRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult100", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return per page.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#VocabularyNextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" - } - }, - "State": { - "target": "com.amazonaws.connect#VocabularyState", - "traits": { - "smithy.api#documentation": "

The current state of the custom vocabulary.

" - } - }, - "NameStartsWith": { - "target": "com.amazonaws.connect#VocabularyName", - "traits": { - "smithy.api#documentation": "

The starting pattern of the name of the vocabulary.

" - } - }, - "LanguageCode": { - "target": "com.amazonaws.connect#VocabularyLanguageCode", - "traits": { - "smithy.api#documentation": "

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see \nWhat is Amazon Transcribe?\n

" - } - } - } - }, - "com.amazonaws.connect#SearchVocabulariesResponse": { - "type": "structure", - "members": { - "VocabularySummaryList": { - "target": "com.amazonaws.connect#VocabularySummaryList", - "traits": { - "smithy.api#documentation": "

The list of the available custom vocabularies.

" - } - }, - "NextToken": { - "target": "com.amazonaws.connect#VocabularyNextToken", - "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" - } - } - } - }, - "com.amazonaws.connect#SearchableQueueType": { - "type": "enum", - "members": { - "STANDARD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STANDARD" - } - } - } - }, - "com.amazonaws.connect#SecurityKey": { - "type": "structure", - "members": { - "AssociationId": { - "target": "com.amazonaws.connect#AssociationId", - "traits": { - "smithy.api#documentation": "

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

" - } - }, - "Key": { - "target": "com.amazonaws.connect#PEM", - "traits": { - "smithy.api#documentation": "

The key of the security key.

" - } - }, - "CreationTime": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

When the security key was created.

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

Configuration information of the security key.

" - } - }, - "com.amazonaws.connect#SecurityKeysList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#SecurityKey" - } - }, - "com.amazonaws.connect#SecurityProfile": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#SecurityProfileId", - "traits": { - "smithy.api#documentation": "

The identifier for the security profile.

" - } - }, - "OrganizationResourceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The organization resource identifier for the security profile.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the secruity profile.

" - } - }, - "SecurityProfileName": { - "target": "com.amazonaws.connect#SecurityProfileName", - "traits": { - "smithy.api#documentation": "

The name for the security profile.

" - } - }, - "Description": { - "target": "com.amazonaws.connect#SecurityProfileDescription", - "traits": { - "smithy.api#documentation": "

The description of the security profile.

" - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" - } - }, - "AllowedAccessControlTags": { - "target": "com.amazonaws.connect#AllowedAccessControlTags", - "traits": { - "smithy.api#documentation": "

The list of tags that a security profile uses to restrict access to resources in Amazon Connect.

" - } - }, - "TagRestrictedResources": { - "target": "com.amazonaws.connect#TagRestrictedResourceList", - "traits": { - "smithy.api#documentation": "

The list of resources that a security profile applies tag restrictions to in Amazon Connect.

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

Contains information about a security profile.

" - } - }, - "com.amazonaws.connect#SecurityProfileDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 250 - } - } - }, - "com.amazonaws.connect#SecurityProfileId": { - "type": "string" - }, - "com.amazonaws.connect#SecurityProfileIds": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#SecurityProfileId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.connect#SecurityProfileName": { - "type": "string" - }, - "com.amazonaws.connect#SecurityProfilePermission": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.connect#SecurityProfilePolicyKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.connect#SecurityProfilePolicyValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.connect#SecurityProfileSearchConditionList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#SecurityProfileSearchCriteria" - } - }, - "com.amazonaws.connect#SecurityProfileSearchCriteria": { - "type": "structure", - "members": { - "OrConditions": { - "target": "com.amazonaws.connect#SecurityProfileSearchConditionList", - "traits": { - "smithy.api#documentation": "

A list of conditions which would be applied together with an OR condition.

" - } - }, - "AndConditions": { - "target": "com.amazonaws.connect#SecurityProfileSearchConditionList", - "traits": { - "smithy.api#documentation": "

A list of conditions which would be applied together with an AND condition.

" - } - }, - "StringCondition": { - "target": "com.amazonaws.connect#StringCondition" - } - }, - "traits": { - "smithy.api#documentation": "

The search criteria to be used to return security profiles.

\n \n

The name field support \"contains\" queries with a minimum of 2 characters and\n maximum of 25 characters. Any queries with character lengths outside of this range will throw\n invalid results.

\n " - } - }, - "com.amazonaws.connect#SecurityProfileSearchSummary": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#SecurityProfileId", - "traits": { - "smithy.api#documentation": "

The identifier of the security profile.

" - } - }, - "OrganizationResourceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The organization resource identifier.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the security profile.

" - } - }, - "SecurityProfileName": { - "target": "com.amazonaws.connect#SecurityProfileName", - "traits": { - "smithy.api#documentation": "

The name of the security profile.

" - } - }, - "Description": { - "target": "com.amazonaws.connect#SecurityProfileDescription", - "traits": { - "smithy.api#documentation": "

The description of the security profile.

" - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

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

Information about the returned security profiles.

" - } - }, - "com.amazonaws.connect#SecurityProfileSummary": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#SecurityProfileId", - "traits": { - "smithy.api#documentation": "

The identifier of the security profile.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the security profile.

" - } - }, - "Name": { - "target": "com.amazonaws.connect#SecurityProfileName", - "traits": { - "smithy.api#documentation": "

The name of the security profile.

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

Contains information about a security profile.

" - } - }, - "com.amazonaws.connect#SecurityProfileSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#SecurityProfileSummary" - } - }, - "com.amazonaws.connect#SecurityProfilesSearchFilter": { - "type": "structure", - "members": { - "TagFilter": { - "target": "com.amazonaws.connect#ControlPlaneTagFilter" - } - }, - "traits": { - "smithy.api#documentation": "

Filters to be applied to search results.

" - } - }, - "com.amazonaws.connect#SecurityProfilesSearchSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#SecurityProfileSearchSummary" - } - }, - "com.amazonaws.connect#SecurityToken": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.connect#SendNotificationActionDefinition": { - "type": "structure", - "members": { - "DeliveryMethod": { - "target": "com.amazonaws.connect#NotificationDeliveryType", - "traits": { - "smithy.api#documentation": "

Notification delivery method.

", - "smithy.api#required": {} - } - }, - "Subject": { - "target": "com.amazonaws.connect#Subject", - "traits": { - "smithy.api#documentation": "

The subject of the email if the delivery method is EMAIL.\n Supports variable injection. For more information, see \nJSONPath reference \nin the Amazon Connect Administrators Guide.

" - } - }, - "Content": { - "target": "com.amazonaws.connect#Content", - "traits": { - "smithy.api#documentation": "

Notification content. Supports variable injection. For more information, see \nJSONPath reference \nin the Amazon Connect Administrators Guide.

", - "smithy.api#required": {} - } - }, - "ContentType": { - "target": "com.amazonaws.connect#NotificationContentType", - "traits": { - "smithy.api#documentation": "

Content type format.

", - "smithy.api#required": {} - } - }, - "Recipient": { - "target": "com.amazonaws.connect#NotificationRecipientType", - "traits": { - "smithy.api#documentation": "

Notification recipient.

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

Information about the send notification action.

" - } - }, - "com.amazonaws.connect#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.connect#Message" - } - }, - "traits": { - "smithy.api#documentation": "

The service quota has been exceeded.

", - "smithy.api#error": "client", - "smithy.api#httpError": 402 - } - }, - "com.amazonaws.connect#SingleSelectOptions": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#TaskTemplateSingleSelectOption" - } - }, - "com.amazonaws.connect#SnapshotVersion": { - "type": "string" - }, - "com.amazonaws.connect#SortOrder": { - "type": "enum", - "members": { - "ASCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASCENDING" - } - }, - "DESCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DESCENDING" - } - } - } - }, - "com.amazonaws.connect#SourceApplicationName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_ -]+$" - } - }, - "com.amazonaws.connect#SourceType": { - "type": "enum", - "members": { - "SALESFORCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SALESFORCE" - } - }, - "ZENDESK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ZENDESK" - } - } - } - }, - "com.amazonaws.connect#StartChatContact": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#StartChatContactRequest" - }, - "output": { - "target": "com.amazonaws.connect#StartChatContactResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#LimitExceededException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Initiates a flow to start a new chat for the customer. Response of this API provides a token\n required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.

\n

When a new chat contact is successfully created, clients must subscribe to the participantā€™s\n connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.

\n

A 429 error occurs in the following situations:

\n \n

If you use the ChatDurationInMinutes parameter and receive a 400 error, your\n account may not support the ability to configure custom chat durations. For more information,\n contact Amazon Web Services Support.

\n

For more information about chat, see Chat in the Amazon Connect\n Administrator Guide.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/contact/chat", - "code": 200 - } - } - }, - "com.amazonaws.connect#StartChatContactRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#required": {} - } - }, - "ContactFlowId": { - "target": "com.amazonaws.connect#ContactFlowId", - "traits": { - "smithy.api#documentation": "

The identifier of the flow for initiating the chat.\n To\n see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go\n to Routing, Contact Flows.\n Choose the flow. On the flow page, under the name of the flow, choose Show\n additional flow information. The ContactFlowId is the last part of the ARN, shown\n here in bold:

\n

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n

", - "smithy.api#required": {} - } - }, - "Attributes": { - "target": "com.amazonaws.connect#Attributes", - "traits": { - "smithy.api#documentation": "

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes.

\n

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys\n can include only alphanumeric, dash, and underscore characters.

" - } - }, - "ParticipantDetails": { - "target": "com.amazonaws.connect#ParticipantDetails", - "traits": { - "smithy.api#documentation": "

Information identifying the participant.

", - "smithy.api#required": {} - } - }, - "InitialMessage": { - "target": "com.amazonaws.connect#ChatMessage", - "traits": { - "smithy.api#documentation": "

The initial message to be sent to the newly created chat.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.connect#ClientToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", - "smithy.api#idempotencyToken": {} - } - }, - "ChatDurationInMinutes": { - "target": "com.amazonaws.connect#ChatDurationInMinutes", - "traits": { - "smithy.api#documentation": "

The total duration of the newly started chat session. If not specified, the chat session\n duration defaults to 25 hour. The minumum configurable time is 60 minutes. The maximum\n configurable time is 10,080 minutes (7 days).

" - } - }, - "SupportedMessagingContentTypes": { - "target": "com.amazonaws.connect#SupportedMessagingContentTypes", - "traits": { - "smithy.api#documentation": "

The supported chat message content types. Content types must always contain text/plain. You\n can then put any other supported type in the list. For example, all the following lists are valid\n because they contain text/plain: [text/plain, text/markdown, application/json], [text/markdown,\n text/plain], [text/plain, application/json].

" - } - } - } - }, - "com.amazonaws.connect#StartChatContactResponse": { - "type": "structure", - "members": { - "ContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of this contact within the Amazon Connect instance.

" - } - }, - "ParticipantId": { - "target": "com.amazonaws.connect#ParticipantId", - "traits": { - "smithy.api#documentation": "

The identifier for a chat participant. The participantId for a chat participant is the same\n throughout the chat lifecycle.

" - } - }, - "ParticipantToken": { - "target": "com.amazonaws.connect#ParticipantToken", - "traits": { - "smithy.api#documentation": "

The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat\n participant.

" - } - } - } - }, - "com.amazonaws.connect#StartContactRecording": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#StartContactRecordingRequest" - }, - "output": { - "target": "com.amazonaws.connect#StartContactRecordingResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts recording the contact:

\n \n

StartContactRecording is a one-time action. For example, if you use StopContactRecording to\n stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios\n where the recording has started and you want to suspend and resume it, such as when collecting\n sensitive information (for example, a credit card number), use SuspendContactRecording and\n ResumeContactRecording.

\n

You can use this API to override the recording behavior configured in the Set recording\n behavior block.

\n

Only voice recordings are supported at this time.

", - "smithy.api#http": { - "method": "POST", - "uri": "/contact/start-recording", - "code": 200 - } - } - }, - "com.amazonaws.connect#StartContactRecordingRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#required": {} - } - }, - "ContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the contact.

", - "smithy.api#required": {} - } - }, - "InitialContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the contact. This is the identifier of the contact associated with the\n first interaction with the contact center.

", - "smithy.api#required": {} - } - }, - "VoiceRecordingConfiguration": { - "target": "com.amazonaws.connect#VoiceRecordingConfiguration", - "traits": { - "smithy.api#documentation": "

The person being recorded.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#StartContactRecordingResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.connect#StartContactStreaming": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#StartContactStreamingRequest" - }, - "output": { - "target": "com.amazonaws.connect#StartContactStreamingResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#LimitExceededException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Initiates real-time message streaming for a new chat contact.

\n

For more information about message streaming, see Enable real-time chat message\n streaming in the Amazon Connect Administrator Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/contact/start-streaming", - "code": 200 - } - } - }, - "com.amazonaws.connect#StartContactStreamingRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#required": {} - } - }, - "ContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the contact. This is the identifier of the contact associated with the\n first interaction with the contact center.

", - "smithy.api#required": {} - } - }, - "ChatStreamingConfiguration": { - "target": "com.amazonaws.connect#ChatStreamingConfiguration", - "traits": { - "smithy.api#documentation": "

The streaming configuration, such as the Amazon SNS streaming endpoint.

", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.connect#ClientToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#StartContactStreamingResponse": { - "type": "structure", - "members": { - "StreamingId": { - "target": "com.amazonaws.connect#StreamingId", - "traits": { - "smithy.api#documentation": "

The identifier of the streaming configuration enabled.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#StartOutboundVoiceContact": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#StartOutboundVoiceContactRequest" - }, - "output": { - "target": "com.amazonaws.connect#StartOutboundVoiceContactResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#DestinationNotAllowedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#LimitExceededException" - }, - { - "target": "com.amazonaws.connect#OutboundContactNotPermittedException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Places an outbound call to a contact, and then initiates the flow. It performs the actions\n in the flow that's specified (in ContactFlowId).

\n

Agents do not initiate the outbound API, which means that they do not dial the contact. If\n the flow places an outbound call to a contact, and then puts the contact in queue, the call is\n then routed to the agent, like any other inbound case.

\n

There is a 60-second dialing timeout for this operation. If the call is not connected after\n 60 seconds, it fails.

\n \n

UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK\n mobile numbers, you must submit a service quota increase request. For more information, see\n Amazon Connect Service Quotas in the Amazon Connect Administrator\n Guide.

\n \n \n

Campaign calls are not allowed by default. Before you can make a call with\n TrafficType = CAMPAIGN, you must submit a service quota increase\n request to the quota Amazon Connect campaigns.

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/contact/outbound-voice", - "code": 200 - } - } - }, - "com.amazonaws.connect#StartOutboundVoiceContactRequest": { - "type": "structure", - "members": { - "DestinationPhoneNumber": { - "target": "com.amazonaws.connect#PhoneNumber", - "traits": { - "smithy.api#documentation": "

The phone number of the customer, in E.164 format.

", - "smithy.api#required": {} - } - }, - "ContactFlowId": { - "target": "com.amazonaws.connect#ContactFlowId", - "traits": { - "smithy.api#documentation": "

The\n identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect\n console user interface, on the navigation menu go to Routing,\n Contact Flows. Choose the flow. On the flow page, under the\n name of the flow, choose Show additional flow information. The\n ContactFlowId is the last part of the ARN, shown here in bold:

\n

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n

", - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.connect#ClientToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started,\n the contact ID is returned.\n

", - "smithy.api#idempotencyToken": {} - } - }, - "SourcePhoneNumber": { - "target": "com.amazonaws.connect#PhoneNumber", - "traits": { - "smithy.api#documentation": "

The phone number associated with the Amazon Connect instance, in E.164 format. If you do\n not specify a source phone number, you must specify a queue.

" - } - }, - "QueueId": { - "target": "com.amazonaws.connect#QueueId", - "traits": { - "smithy.api#documentation": "

The queue for the call. If you specify a queue, the phone displayed for caller ID is the\n phone number specified in the queue. If you do not specify a queue, the queue defined in the flow\n is used. If you do not specify a queue, you must specify a source phone number.

" - } - }, - "Attributes": { - "target": "com.amazonaws.connect#Attributes", - "traits": { - "smithy.api#documentation": "

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

\n

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys\n can include only alphanumeric, dash, and underscore characters.

" - } - }, - "AnswerMachineDetectionConfig": { - "target": "com.amazonaws.connect#AnswerMachineDetectionConfig", - "traits": { - "smithy.api#documentation": "

Configuration of the answering machine detection for this outbound call.

" - } - }, - "CampaignId": { - "target": "com.amazonaws.connect#CampaignId", - "traits": { - "smithy.api#documentation": "

The campaign identifier of the outbound communication.

" - } - }, - "TrafficType": { - "target": "com.amazonaws.connect#TrafficType", - "traits": { - "smithy.api#documentation": "

Denotes the class of traffic. Calls with different traffic types are handled differently by\n Amazon Connect. The default value is GENERAL. Use CAMPAIGN if\n EnableAnswerMachineDetection is set to true. For all other cases, use\n GENERAL.

" - } - } - } - }, - "com.amazonaws.connect#StartOutboundVoiceContactResponse": { - "type": "structure", - "members": { - "ContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of this contact within the Amazon Connect instance.

" - } - } - } - }, - "com.amazonaws.connect#StartTaskContact": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#StartTaskContactRequest" - }, - "output": { - "target": "com.amazonaws.connect#StartTaskContactResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Initiates a flow to start a new task.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/contact/task", - "code": 200 - } - } - }, - "com.amazonaws.connect#StartTaskContactRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#required": {} - } - }, - "PreviousContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the previous chat, voice, or task contact.

" - } - }, - "ContactFlowId": { - "target": "com.amazonaws.connect#ContactFlowId", - "traits": { - "smithy.api#documentation": "

The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the\n flow page, under the name of the flow, choose Show additional flow\n information. The ContactFlowId is the last part of the ARN, shown here in bold:

\n

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n

" - } - }, - "Attributes": { - "target": "com.amazonaws.connect#Attributes", - "traits": { - "smithy.api#documentation": "

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

\n

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys\n can include only alphanumeric, dash, and underscore characters.

" - } - }, - "Name": { - "target": "com.amazonaws.connect#Name", - "traits": { - "smithy.api#documentation": "

The name of a task that is shown to an agent in the Contact Control Panel (CCP).

", - "smithy.api#required": {} - } - }, - "References": { - "target": "com.amazonaws.connect#ContactReferences", - "traits": { - "smithy.api#documentation": "

A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

" - } - }, - "Description": { - "target": "com.amazonaws.connect#Description", - "traits": { - "smithy.api#documentation": "

A description of the task that is shown to an agent in the Contact Control Panel\n (CCP).

" - } - }, - "ClientToken": { - "target": "com.amazonaws.connect#ClientToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", - "smithy.api#idempotencyToken": {} - } - }, - "ScheduledTime": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

" - } - }, - "TaskTemplateId": { - "target": "com.amazonaws.connect#TaskTemplateId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the task template.

" - } - }, - "QuickConnectId": { - "target": "com.amazonaws.connect#QuickConnectId", - "traits": { - "smithy.api#documentation": "

The identifier for the quick connect.

" - } - } - } - }, - "com.amazonaws.connect#StartTaskContactResponse": { - "type": "structure", - "members": { - "ContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of this contact within the Amazon Connect instance.

" - } - } - } - }, - "com.amazonaws.connect#Statistic": { - "type": "enum", - "members": { - "SUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUM" - } - }, - "MAX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX" - } - }, - "AVG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVG" - } - } - } - }, - "com.amazonaws.connect#StopContact": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#StopContactRequest" - }, - "output": { - "target": "com.amazonaws.connect#StopContactResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#ContactNotFoundException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Ends the specified contact. This call does not work for the following initiation\n methods:

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/contact/stop", - "code": 200 - } - } - }, - "com.amazonaws.connect#StopContactRecording": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#StopContactRecordingRequest" - }, - "output": { - "target": "com.amazonaws.connect#StopContactRecordingResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Stops recording a call when a contact is being recorded. StopContactRecording is a one-time\n action. If you use StopContactRecording to stop recording an ongoing call, you can't use\n StartContactRecording to restart it. For scenarios where the recording has started and you want\n to suspend it for sensitive information (for example, to collect a credit card number), and then\n restart it, use SuspendContactRecording and ResumeContactRecording.

\n

Only voice recordings are supported at this time.

", - "smithy.api#http": { - "method": "POST", - "uri": "/contact/stop-recording", - "code": 200 - } - } - }, - "com.amazonaws.connect#StopContactRecordingRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#required": {} - } - }, - "ContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the contact.

", - "smithy.api#required": {} - } - }, - "InitialContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the contact. This is the identifier of the contact associated with the\n first interaction with the contact center.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#StopContactRecordingResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.connect#StopContactRequest": { - "type": "structure", - "members": { - "ContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The ID of the contact.

", - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#StopContactResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.connect#StopContactStreaming": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#StopContactStreamingRequest" - }, - "output": { - "target": "com.amazonaws.connect#StopContactStreamingResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Ends message streaming on a specified contact. To restart message streaming on that\n contact, call the StartContactStreaming\n API.

", - "smithy.api#http": { - "method": "POST", - "uri": "/contact/stop-streaming", - "code": 200 - } - } - }, - "com.amazonaws.connect#StopContactStreamingRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#required": {} - } - }, - "ContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the contact. This is the identifier of the contact that is associated with\n the first interaction with the contact center.

", - "smithy.api#required": {} - } - }, - "StreamingId": { - "target": "com.amazonaws.connect#StreamingId", - "traits": { - "smithy.api#documentation": "

The identifier of the streaming configuration enabled.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#StopContactStreamingResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.connect#StorageType": { - "type": "enum", - "members": { - "S3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3" - } - }, - "KINESIS_VIDEO_STREAM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KINESIS_VIDEO_STREAM" - } - }, - "KINESIS_STREAM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KINESIS_STREAM" - } - }, - "KINESIS_FIREHOSE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KINESIS_FIREHOSE" - } - } - } - }, - "com.amazonaws.connect#StreamingId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.connect#String": { - "type": "string" - }, - "com.amazonaws.connect#StringComparisonType": { - "type": "enum", - "members": { - "STARTS_WITH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTS_WITH" - } - }, - "CONTAINS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTAINS" - } - }, - "EXACT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXACT" - } - } - } - }, - "com.amazonaws.connect#StringCondition": { - "type": "structure", - "members": { - "FieldName": { - "target": "com.amazonaws.connect#String", - "traits": { - "smithy.api#documentation": "

The name of the field in the string condition.

" - } - }, - "Value": { - "target": "com.amazonaws.connect#String", - "traits": { - "smithy.api#documentation": "

The value of the string.

" - } - }, - "ComparisonType": { - "target": "com.amazonaws.connect#StringComparisonType", - "traits": { - "smithy.api#documentation": "

The type of comparison to be made when evaluating the string condition.

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

A leaf node condition which can be used to specify a string condition.

\n \n

The currently supported value for FieldName: name\n

\n " - } - }, - "com.amazonaws.connect#StringReference": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.connect#ReferenceKey", - "traits": { - "smithy.api#documentation": "

Identifier of the string reference.

" - } - }, - "Value": { - "target": "com.amazonaws.connect#ReferenceValue", - "traits": { - "smithy.api#documentation": "

A valid string.

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

Information about a reference when the referenceType is STRING.\n Otherwise, null.

" - } - }, - "com.amazonaws.connect#Subject": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.connect#SupportedMessagingContentType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.connect#SupportedMessagingContentTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#SupportedMessagingContentType" - } - }, - "com.amazonaws.connect#SuspendContactRecording": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#SuspendContactRecordingRequest" - }, - "output": { - "target": "com.amazonaws.connect#SuspendContactRecordingResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

When a contact is being recorded, this API suspends recording the call. For example, you\n might suspend the call recording while collecting sensitive information, such as a credit card\n number. Then use ResumeContactRecording to restart recording.

\n

The period of time that the recording is suspended is filled with silence in the final\n recording.

\n

Only voice recordings are supported at this time.

", - "smithy.api#http": { - "method": "POST", - "uri": "/contact/suspend-recording", - "code": 200 - } - } - }, - "com.amazonaws.connect#SuspendContactRecordingRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#required": {} - } - }, - "ContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the contact.

", - "smithy.api#required": {} - } - }, - "InitialContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the contact. This is the identifier of the contact associated with the\n first interaction with the contact center.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#SuspendContactRecordingResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.connect#TagAndConditionList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#TagCondition" - } - }, - "com.amazonaws.connect#TagCondition": { - "type": "structure", - "members": { - "TagKey": { - "target": "com.amazonaws.connect#String", - "traits": { - "smithy.api#documentation": "

The tag key in the tag condition.

" - } - }, - "TagValue": { - "target": "com.amazonaws.connect#String", - "traits": { - "smithy.api#documentation": "

The tag value in the tag condition.

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

A leaf node condition which can be used to specify a tag condition, for example, HAVE\n BPO = 123.

" - } - }, - "com.amazonaws.connect#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" - } - }, - "com.amazonaws.connect#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.connect#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.connect#TagKey" - }, - "value": { - "target": "com.amazonaws.connect#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.connect#TagOrConditionList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#TagAndConditionList" - } - }, - "com.amazonaws.connect#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#TagResourceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds the specified tags to the specified resource.

\n

Some of the supported resource types are agents, routing profiles, queues, quick connects,\n contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task\n templates. For a complete list, see Tagging resources in Amazon Connect.

\n

For sample policies that use tags, see Amazon Connect\n Identity-Based Policy Examples in the Amazon Connect Administrator\n Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.connect#TagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#TagRestrictedResourceList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#TagRestrictedResourceName" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.connect#TagRestrictedResourceName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.connect#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.connect#TaskActionDefinition": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.connect#TaskNameExpression", - "traits": { - "smithy.api#documentation": "

The name. Supports variable injection. For more information, see \nJSONPath reference \nin the Amazon Connect Administrators Guide.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.connect#TaskDescriptionExpression", - "traits": { - "smithy.api#documentation": "

The description. Supports variable injection. For more information, see \nJSONPath reference \nin the Amazon Connect Administrators Guide.

" - } - }, - "ContactFlowId": { - "target": "com.amazonaws.connect#ContactFlowId", - "traits": { - "smithy.api#documentation": "

The identifier of the flow.

", - "smithy.api#required": {} - } - }, - "References": { - "target": "com.amazonaws.connect#ContactReferences", - "traits": { - "smithy.api#documentation": "

Information about the reference when the referenceType is URL.\n Otherwise, null. (Supports variable injection in the Value field.)

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

Information about the task action.

" - } - }, - "com.amazonaws.connect#TaskDescriptionExpression": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 4096 - } - } - }, - "com.amazonaws.connect#TaskNameExpression": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.connect#TaskTemplateArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 500 - } - } - }, - "com.amazonaws.connect#TaskTemplateConstraints": { - "type": "structure", - "members": { - "RequiredFields": { - "target": "com.amazonaws.connect#RequiredTaskTemplateFields", - "traits": { - "smithy.api#documentation": "

Lists the fields that are required to be filled by agents.

" - } - }, - "ReadOnlyFields": { - "target": "com.amazonaws.connect#ReadOnlyTaskTemplateFields", - "traits": { - "smithy.api#documentation": "

Lists the fields that are read-only to agents, and cannot be edited.

" - } - }, - "InvisibleFields": { - "target": "com.amazonaws.connect#InvisibleTaskTemplateFields", - "traits": { - "smithy.api#documentation": "

Lists the fields that are invisible to agents.

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

Describes constraints that apply to the template fields.

" - } - }, - "com.amazonaws.connect#TaskTemplateDefaultFieldValue": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#TaskTemplateFieldIdentifier", - "traits": { - "smithy.api#documentation": "

Identifier of a field.

" - } - }, - "DefaultValue": { - "target": "com.amazonaws.connect#TaskTemplateFieldValue", - "traits": { - "smithy.api#documentation": "

Default value for the field.

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

Describes a default field and its corresponding value.

" - } - }, - "com.amazonaws.connect#TaskTemplateDefaultFieldValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#TaskTemplateDefaultFieldValue" - } - }, - "com.amazonaws.connect#TaskTemplateDefaults": { - "type": "structure", - "members": { - "DefaultFieldValues": { - "target": "com.amazonaws.connect#TaskTemplateDefaultFieldValueList", - "traits": { - "smithy.api#documentation": "

Default value for the field.

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

Describes default values for fields on a template.

" - } - }, - "com.amazonaws.connect#TaskTemplateDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.connect#TaskTemplateField": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#TaskTemplateFieldIdentifier", - "traits": { - "smithy.api#documentation": "

The unique identifier for the field.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.connect#TaskTemplateFieldDescription", - "traits": { - "smithy.api#documentation": "

The description of the field.

" - } - }, - "Type": { - "target": "com.amazonaws.connect#TaskTemplateFieldType", - "traits": { - "smithy.api#documentation": "

Indicates the type of field.

" - } - }, - "SingleSelectOptions": { - "target": "com.amazonaws.connect#SingleSelectOptions", - "traits": { - "smithy.api#documentation": "

A list of options for a single select field.

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

Describes a single task template field.

" - } - }, - "com.amazonaws.connect#TaskTemplateFieldDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.connect#TaskTemplateFieldIdentifier": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.connect#TaskTemplateFieldName", - "traits": { - "smithy.api#documentation": "

The name of the task template field.

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

The identifier of the task template field.

" - } - }, - "com.amazonaws.connect#TaskTemplateFieldName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.connect#TaskTemplateFieldType": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NAME" - } - }, - "DESCRIPTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DESCRIPTION" - } - }, - "SCHEDULED_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SCHEDULED_TIME" - } - }, - "QUICK_CONNECT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICK_CONNECT" - } - }, - "URL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "URL" - } - }, - "NUMBER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NUMBER" - } - }, - "TEXT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TEXT" - } - }, - "TEXT_AREA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TEXT_AREA" - } - }, - "DATE_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATE_TIME" - } - }, - "BOOLEAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BOOLEAN" - } - }, - "SINGLE_SELECT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SINGLE_SELECT" - } - }, - "EMAIL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EMAIL" - } - } - } - }, - "com.amazonaws.connect#TaskTemplateFieldValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 4096 - } - } - }, - "com.amazonaws.connect#TaskTemplateFields": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#TaskTemplateField" - } - }, - "com.amazonaws.connect#TaskTemplateId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 500 - } - } - }, - "com.amazonaws.connect#TaskTemplateList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#TaskTemplateMetadata" - } - }, - "com.amazonaws.connect#TaskTemplateMetadata": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#TaskTemplateId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the task template.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#TaskTemplateArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task template.

" - } - }, - "Name": { - "target": "com.amazonaws.connect#TaskTemplateName", - "traits": { - "smithy.api#documentation": "

The name of the task template.

" - } - }, - "Description": { - "target": "com.amazonaws.connect#TaskTemplateDescription", - "traits": { - "smithy.api#documentation": "

The description of the task template.

" - } - }, - "Status": { - "target": "com.amazonaws.connect#TaskTemplateStatus", - "traits": { - "smithy.api#documentation": "

Marks a template as ACTIVE or INACTIVE for a task to refer to it. \nTasks can only be created from ACTIVE templates.\nIf a template is marked as INACTIVE, then a task that refers to this template cannot be created.

" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp when the task template was last modified.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp when the task template was created.

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

Contains summary information about the task template.

" - } - }, - "com.amazonaws.connect#TaskTemplateName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.connect#TaskTemplateSingleSelectOption": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.connect#TaskTemplateStatus": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "INACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INACTIVE" - } - } - } - }, - "com.amazonaws.connect#TelephonyConfig": { - "type": "structure", - "members": { - "Distributions": { - "target": "com.amazonaws.connect#DistributionList", - "traits": { - "smithy.api#documentation": "

Information about traffic distributions.

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

The distribution of traffic between the instance and its replicas.

" - } - }, - "com.amazonaws.connect#Threshold": { - "type": "structure", - "members": { - "Comparison": { - "target": "com.amazonaws.connect#Comparison", - "traits": { - "smithy.api#documentation": "

The type of comparison. Only \"less than\" (LT) comparisons are supported.

" - } - }, - "ThresholdValue": { - "target": "com.amazonaws.connect#ThresholdValue", - "traits": { - "smithy.api#documentation": "

The threshold value to compare.

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

Contains information about the threshold for service level metrics.

" - } - }, - "com.amazonaws.connect#ThresholdValue": { - "type": "double" - }, - "com.amazonaws.connect#ThrottlingException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.connect#Message" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ThrottlingException", - "httpResponseCode": 429 - }, - "smithy.api#documentation": "

The throttling limit has been exceeded.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.connect#TimeZone": { - "type": "string" - }, - "com.amazonaws.connect#TimerEligibleParticipantRoles": { - "type": "enum", - "members": { - "CUSTOMER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOMER" - } - }, - "AGENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AGENT" - } - } - } - }, - "com.amazonaws.connect#Timestamp": { - "type": "timestamp" - }, - "com.amazonaws.connect#TrafficDistributionGroup": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#TrafficDistributionGroupId", - "traits": { - "smithy.api#documentation": "

The identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#TrafficDistributionGroupArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the traffic distribution group.

" - } - }, - "Name": { - "target": "com.amazonaws.connect#Name128", - "traits": { - "smithy.api#documentation": "

The name of the traffic distribution group.

" - } - }, - "Description": { - "target": "com.amazonaws.connect#Description250", - "traits": { - "smithy.api#documentation": "

The description of the traffic distribution group.

" - } - }, - "InstanceArn": { - "target": "com.amazonaws.connect#InstanceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN).

" - } - }, - "Status": { - "target": "com.amazonaws.connect#TrafficDistributionGroupStatus", - "traits": { - "smithy.api#documentation": "

The status of the traffic distribution group.

\n " - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

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

Information about a traffic distribution group.

" - } - }, - "com.amazonaws.connect#TrafficDistributionGroupArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:traffic-distribution-group/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" - } - }, - "com.amazonaws.connect#TrafficDistributionGroupId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" - } - }, - "com.amazonaws.connect#TrafficDistributionGroupIdOrArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z-]+-[0-9]{1}:[0-9]{1,20}:traffic-distribution-group/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" - } - }, - "com.amazonaws.connect#TrafficDistributionGroupStatus": { - "type": "enum", - "members": { - "CREATION_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATION_IN_PROGRESS" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "CREATION_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATION_FAILED" - } - }, - "PENDING_DELETION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_DELETION" - } - }, - "DELETION_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETION_FAILED" - } - }, - "UPDATE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_IN_PROGRESS" - } - } - } - }, - "com.amazonaws.connect#TrafficDistributionGroupSummary": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#TrafficDistributionGroupId", - "traits": { - "smithy.api#documentation": "

The identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#TrafficDistributionGroupArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the traffic distribution group.

" - } - }, - "Name": { - "target": "com.amazonaws.connect#Name128", - "traits": { - "smithy.api#documentation": "

The name of the traffic distribution group.

" - } - }, - "InstanceArn": { - "target": "com.amazonaws.connect#InstanceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the traffic distribution group.

" - } - }, - "Status": { - "target": "com.amazonaws.connect#TrafficDistributionGroupStatus", - "traits": { - "smithy.api#documentation": "

The status of the traffic distribution group.

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

Information about traffic distribution groups.

" - } - }, - "com.amazonaws.connect#TrafficDistributionGroupSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#TrafficDistributionGroupSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.connect#TrafficType": { - "type": "enum", - "members": { - "GENERAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GENERAL" - } - }, - "CAMPAIGN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CAMPAIGN" - } - } - } - }, - "com.amazonaws.connect#TransferContact": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#TransferContactRequest" - }, - "output": { - "target": "com.amazonaws.connect#TransferContactResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#IdempotencyException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Transfers contacts from one agent or queue to another agent or queue at any point after a\n contact is created. You can transfer a contact to another queue by providing the flow which\n orchestrates the contact to the destination queue. This gives you more control over contact\n handling and helps you adhere to the service level agreement (SLA) guaranteed to your\n customers.

\n

Note the following requirements:

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/contact/transfer", - "code": 200 - } - } - }, - "com.amazonaws.connect#TransferContactRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#required": {} - } - }, - "ContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the contact in this instance of Amazon Connect.

", - "smithy.api#required": {} - } - }, - "QueueId": { - "target": "com.amazonaws.connect#QueueId", - "traits": { - "smithy.api#documentation": "

The identifier for the queue.

" - } - }, - "UserId": { - "target": "com.amazonaws.connect#AgentResourceId", - "traits": { - "smithy.api#documentation": "

The identifier for the user.

" - } - }, - "ContactFlowId": { - "target": "com.amazonaws.connect#ContactFlowId", - "traits": { - "smithy.api#documentation": "

The identifier of the flow.

", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.connect#ClientToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", - "smithy.api#idempotencyToken": {} - } - } - } - }, - "com.amazonaws.connect#TransferContactResponse": { - "type": "structure", - "members": { - "ContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the contact in this instance of Amazon Connect.

" - } - }, - "ContactArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the contact.

" - } - } - } - }, - "com.amazonaws.connect#URI": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2000 - } - } - }, - "com.amazonaws.connect#Unit": { - "type": "enum", - "members": { - "SECONDS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SECONDS" - } - }, - "COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNT" - } - }, - "PERCENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENT" - } - } - } - }, - "com.amazonaws.connect#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UntagResourceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes the specified tags from the specified resource.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.connect#UntagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tagKeys": { - "target": "com.amazonaws.connect#TagKeyList", - "traits": { - "smithy.api#documentation": "

The tag keys.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#UpdateAgentStatus": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateAgentStatusRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#DuplicateResourceException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#LimitExceededException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates agent status.

", - "smithy.api#http": { - "method": "POST", - "uri": "/agent-status/{InstanceId}/{AgentStatusId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateAgentStatusDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 250 - } - } - }, - "com.amazonaws.connect#UpdateAgentStatusRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AgentStatusId": { - "target": "com.amazonaws.connect#AgentStatusId", - "traits": { - "smithy.api#documentation": "

The identifier of the agent status.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.connect#AgentStatusName", - "traits": { - "smithy.api#documentation": "

The name of the agent status.

" - } - }, - "Description": { - "target": "com.amazonaws.connect#UpdateAgentStatusDescription", - "traits": { - "smithy.api#documentation": "

The description of the agent status.

" - } - }, - "State": { - "target": "com.amazonaws.connect#AgentStatusState", - "traits": { - "smithy.api#documentation": "

The state of the agent status.

" - } - }, - "DisplayOrder": { - "target": "com.amazonaws.connect#AgentStatusOrderNumber", - "traits": { - "smithy.api#documentation": "

The display order of the agent status.

" - } - }, - "ResetOrderNumber": { - "target": "com.amazonaws.connect#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A number indicating the reset order of the agent status.

" - } - } - } - }, - "com.amazonaws.connect#UpdateContact": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateContactRequest" - }, - "output": { - "target": "com.amazonaws.connect#UpdateContactResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Adds or updates user-defined contact information associated with the specified contact. At\n least one field to be updated must be present in the request.

\n \n

You can add or update user-defined contact information for both ongoing and completed\n contacts.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/contacts/{InstanceId}/{ContactId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateContactAttributes": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateContactAttributesRequest" - }, - "output": { - "target": "com.amazonaws.connect#UpdateContactAttributesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates or updates\n user-defined contact attributes\n associated with the specified contact.

\n

You can create or update user-defined attributes for both ongoing and completed contacts.\n For example, while the call is active, you can update the customer's name or the reason the\n customer called. You can add notes about steps that the agent took during the call that display\n to the next agent that takes the call. You can also update attributes for a contact using data\n from your CRM application and save the data with the contact in Amazon Connect. You could\n also flag calls for additional analysis, such as legal review or to identify abusive\n callers.

\n

Contact attributes are available in Amazon Connect for 24 months, and are then deleted.\n For information about contact record retention and the maximum size of the contact record\n attributes section, see Feature\n specifications in the Amazon Connect Administrator Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/contact/attributes", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateContactAttributesRequest": { - "type": "structure", - "members": { - "InitialContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the contact. This is the identifier of the contact associated with the\n first interaction with the contact center.

", - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#required": {} - } - }, - "Attributes": { - "target": "com.amazonaws.connect#Attributes", - "traits": { - "smithy.api#documentation": "

The Amazon Connect attributes. These attributes can be accessed in flows just like any\n other contact attributes.

\n

You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys\n can include only alphanumeric, dash, and underscore characters.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#UpdateContactAttributesResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.connect#UpdateContactFlowContent": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateContactFlowContentRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidContactFlowException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the specified flow.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

", - "smithy.api#http": { - "method": "POST", - "uri": "/contact-flows/{InstanceId}/{ContactFlowId}/content", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateContactFlowContentRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContactFlowId": { - "target": "com.amazonaws.connect#ContactFlowId", - "traits": { - "smithy.api#documentation": "

The identifier of the flow.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Content": { - "target": "com.amazonaws.connect#ContactFlowContent", - "traits": { - "smithy.api#documentation": "

The JSON string that represents flow's content. For an example, see Example contact\n flow in Amazon Connect Flow language.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#UpdateContactFlowMetadata": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateContactFlowMetadataRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#DuplicateResourceException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates metadata about specified flow.

", - "smithy.api#http": { - "method": "POST", - "uri": "/contact-flows/{InstanceId}/{ContactFlowId}/metadata", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateContactFlowMetadataRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContactFlowId": { - "target": "com.amazonaws.connect#ContactFlowId", - "traits": { - "smithy.api#documentation": "

The identifier of the flow.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.connect#ContactFlowName", - "traits": { - "smithy.api#documentation": "

The name of the flow.

" - } - }, - "Description": { - "target": "com.amazonaws.connect#ContactFlowDescription", - "traits": { - "smithy.api#documentation": "

The description of the flow.

" - } - }, - "ContactFlowState": { - "target": "com.amazonaws.connect#ContactFlowState", - "traits": { - "smithy.api#documentation": "

The state of flow.

" - } - } - } - }, - "com.amazonaws.connect#UpdateContactFlowModuleContent": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateContactFlowModuleContentRequest" - }, - "output": { - "target": "com.amazonaws.connect#UpdateContactFlowModuleContentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidContactFlowModuleException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates specified flow module for the specified Amazon Connect instance.

", - "smithy.api#http": { - "method": "POST", - "uri": "/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}/content", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateContactFlowModuleContentRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContactFlowModuleId": { - "target": "com.amazonaws.connect#ContactFlowModuleId", - "traits": { - "smithy.api#documentation": "

The identifier of the flow module.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Content": { - "target": "com.amazonaws.connect#ContactFlowModuleContent", - "traits": { - "smithy.api#documentation": "

The content of the flow module.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#UpdateContactFlowModuleContentResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.connect#UpdateContactFlowModuleMetadata": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateContactFlowModuleMetadataRequest" - }, - "output": { - "target": "com.amazonaws.connect#UpdateContactFlowModuleMetadataResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#DuplicateResourceException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates metadata about specified flow module.

", - "smithy.api#http": { - "method": "POST", - "uri": "/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}/metadata", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateContactFlowModuleMetadataRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContactFlowModuleId": { - "target": "com.amazonaws.connect#ContactFlowModuleId", - "traits": { - "smithy.api#documentation": "

The identifier of the flow module.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.connect#ContactFlowModuleName", - "traits": { - "smithy.api#documentation": "

The name of the flow module.

" - } - }, - "Description": { - "target": "com.amazonaws.connect#ContactFlowModuleDescription", - "traits": { - "smithy.api#documentation": "

The description of the flow module.

" - } - }, - "State": { - "target": "com.amazonaws.connect#ContactFlowModuleState", - "traits": { - "smithy.api#documentation": "

The state of flow module.

" - } - } - } - }, - "com.amazonaws.connect#UpdateContactFlowModuleMetadataResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.connect#UpdateContactFlowName": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateContactFlowNameRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#DuplicateResourceException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

The name of the flow.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

", - "smithy.api#http": { - "method": "POST", - "uri": "/contact-flows/{InstanceId}/{ContactFlowId}/name", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateContactFlowNameRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContactFlowId": { - "target": "com.amazonaws.connect#ContactFlowId", - "traits": { - "smithy.api#documentation": "

The identifier of the flow.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.connect#ContactFlowName", - "traits": { - "smithy.api#documentation": "

The name of the flow.

" - } - }, - "Description": { - "target": "com.amazonaws.connect#ContactFlowDescription", - "traits": { - "smithy.api#documentation": "

The description of the flow.

" - } - } - } - }, - "com.amazonaws.connect#UpdateContactRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the contact. This is the identifier of the contact associated with the\n first interaction with your contact center.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.connect#Name", - "traits": { - "smithy.api#documentation": "

The name of the contact.

" - } - }, - "Description": { - "target": "com.amazonaws.connect#Description", - "traits": { - "smithy.api#documentation": "

The description of the contact.

" - } - }, - "References": { - "target": "com.amazonaws.connect#ContactReferences", - "traits": { - "smithy.api#documentation": "

Well-formed data on contact, shown to agents on Contact Control Panel (CCP).

" - } - } - } - }, - "com.amazonaws.connect#UpdateContactResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.connect#UpdateContactSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateContactScheduleRequest" - }, - "output": { - "target": "com.amazonaws.connect#UpdateContactScheduleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#LimitExceededException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the scheduled time of a task contact that is already scheduled.

", - "smithy.api#http": { - "method": "POST", - "uri": "/contact/schedule", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateContactScheduleRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#required": {} - } - }, - "ContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the contact.

", - "smithy.api#required": {} - } - }, - "ScheduledTime": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#UpdateContactScheduleResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.connect#UpdateHoursOfOperation": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateHoursOfOperationRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#DuplicateResourceException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates the hours of operation.

", - "smithy.api#http": { - "method": "POST", - "uri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateHoursOfOperationDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 250 - } - } - }, - "com.amazonaws.connect#UpdateHoursOfOperationRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "HoursOfOperationId": { - "target": "com.amazonaws.connect#HoursOfOperationId", - "traits": { - "smithy.api#documentation": "

The identifier of the hours of operation.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.connect#CommonNameLength127", - "traits": { - "smithy.api#documentation": "

The name of the hours of operation.

" - } - }, - "Description": { - "target": "com.amazonaws.connect#UpdateHoursOfOperationDescription", - "traits": { - "smithy.api#documentation": "

The description of the hours of operation.

" - } - }, - "TimeZone": { - "target": "com.amazonaws.connect#TimeZone", - "traits": { - "smithy.api#documentation": "

The time zone of the hours of operation.

" - } - }, - "Config": { - "target": "com.amazonaws.connect#HoursOfOperationConfigList", - "traits": { - "smithy.api#documentation": "

Configuration information of the hours of operation.

" - } - } - } - }, - "com.amazonaws.connect#UpdateInstanceAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateInstanceAttributeRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates the value for the specified attribute type.

", - "smithy.api#http": { - "method": "POST", - "uri": "/instance/{InstanceId}/attribute/{AttributeType}", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateInstanceAttributeRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AttributeType": { - "target": "com.amazonaws.connect#InstanceAttributeType", - "traits": { - "smithy.api#documentation": "

The type of attribute.

\n \n

Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature,\n contact Amazon Web Services Support for allowlisting.

\n ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.connect#InstanceAttributeValue", - "traits": { - "smithy.api#documentation": "

The value for the attribute. Maximum character limit is 100.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#UpdateInstanceStorageConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateInstanceStorageConfigRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates an existing configuration for a resource type. This API is idempotent.

", - "smithy.api#http": { - "method": "POST", - "uri": "/instance/{InstanceId}/storage-config/{AssociationId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateInstanceStorageConfigRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssociationId": { - "target": "com.amazonaws.connect#AssociationId", - "traits": { - "smithy.api#documentation": "

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ResourceType": { - "target": "com.amazonaws.connect#InstanceStorageResourceType", - "traits": { - "smithy.api#documentation": "

A valid resource type.

", - "smithy.api#httpQuery": "resourceType", - "smithy.api#required": {} - } - }, - "StorageConfig": { - "target": "com.amazonaws.connect#InstanceStorageConfig", - "traits": { - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#UpdateParticipantRoleConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateParticipantRoleConfigRequest" - }, - "output": { - "target": "com.amazonaws.connect#UpdateParticipantRoleConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates timeouts for when human chat participants are to be considered idle, and when agents\n are automatically disconnected from a chat due to idleness. You can set four timers:

\n \n

For more information about how chat timeouts work, see \n Set up chat timeouts for human participants.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/contact/participant-role-config/{InstanceId}/{ContactId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateParticipantRoleConfigChannelInfo": { - "type": "union", - "members": { - "Chat": { - "target": "com.amazonaws.connect#ChatParticipantRoleConfig", - "traits": { - "smithy.api#documentation": "

Configuration information for the chat participant role.

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

Configuration information for the chat participant role.

" - } - }, - "com.amazonaws.connect#UpdateParticipantRoleConfigRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ContactId": { - "target": "com.amazonaws.connect#ContactId", - "traits": { - "smithy.api#documentation": "

The identifier of the contact in this instance of Amazon Connect.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ChannelConfiguration": { - "target": "com.amazonaws.connect#UpdateParticipantRoleConfigChannelInfo", - "traits": { - "smithy.api#documentation": "

The Amazon Connect channel you want to configure.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#UpdateParticipantRoleConfigResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.connect#UpdatePhoneNumber": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdatePhoneNumberRequest" - }, - "output": { - "target": "com.amazonaws.connect#UpdatePhoneNumberResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#IdempotencyException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#ResourceInUseException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to\n another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.

\n \n

You can call DescribePhoneNumber API\n to verify the status of a previous UpdatePhoneNumber\n operation.

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/phone-number/{PhoneNumberId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdatePhoneNumberRequest": { - "type": "structure", - "members": { - "PhoneNumberId": { - "target": "com.amazonaws.connect#PhoneNumberId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the phone number.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TargetArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.connect#ClientToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", - "smithy.api#idempotencyToken": {} - } - } - } - }, - "com.amazonaws.connect#UpdatePhoneNumberResponse": { - "type": "structure", - "members": { - "PhoneNumberId": { - "target": "com.amazonaws.connect#PhoneNumberId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the phone number.

" - } - }, - "PhoneNumberArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the phone number.

" - } - } - } - }, - "com.amazonaws.connect#UpdateQueueHoursOfOperation": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateQueueHoursOfOperationRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates the hours of operation for the specified queue.

", - "smithy.api#http": { - "method": "POST", - "uri": "/queues/{InstanceId}/{QueueId}/hours-of-operation", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateQueueHoursOfOperationRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "QueueId": { - "target": "com.amazonaws.connect#QueueId", - "traits": { - "smithy.api#documentation": "

The identifier for the queue.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "HoursOfOperationId": { - "target": "com.amazonaws.connect#HoursOfOperationId", - "traits": { - "smithy.api#documentation": "

The identifier for the hours of operation.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#UpdateQueueMaxContacts": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateQueueMaxContactsRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates the maximum number of contacts allowed in a queue before it is considered\n full.

", - "smithy.api#http": { - "method": "POST", - "uri": "/queues/{InstanceId}/{QueueId}/max-contacts", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateQueueMaxContactsRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "QueueId": { - "target": "com.amazonaws.connect#QueueId", - "traits": { - "smithy.api#documentation": "

The identifier for the queue.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MaxContacts": { - "target": "com.amazonaws.connect#QueueMaxContacts", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of contacts that can be in the queue before it is considered full.

" - } - } - } - }, - "com.amazonaws.connect#UpdateQueueName": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateQueueNameRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#DuplicateResourceException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates the name and description of a queue. At least Name or Description must be provided.

", - "smithy.api#http": { - "method": "POST", - "uri": "/queues/{InstanceId}/{QueueId}/name", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateQueueNameRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "QueueId": { - "target": "com.amazonaws.connect#QueueId", - "traits": { - "smithy.api#documentation": "

The identifier for the queue.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.connect#CommonNameLength127", - "traits": { - "smithy.api#documentation": "

The name of the queue.

" - } - }, - "Description": { - "target": "com.amazonaws.connect#QueueDescription", - "traits": { - "smithy.api#documentation": "

The description of the queue.

" - } - } - } - }, - "com.amazonaws.connect#UpdateQueueOutboundCallerConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateQueueOutboundCallerConfigRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates the outbound caller ID name, number, and outbound whisper flow for a specified\n queue.

\n \n

If the number being used in the input is claimed to a traffic distribution group, and you are calling this API\n using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use\n either a full phone number ARN or UUID value for the OutboundCallerIdNumberId value\n of the OutboundCallerConfig request body parameter. However, if the number is claimed to a\n traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region\n associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided\n in\n this scenario, you will receive a\n ResourceNotFoundException.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/queues/{InstanceId}/{QueueId}/outbound-caller-config", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateQueueOutboundCallerConfigRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "QueueId": { - "target": "com.amazonaws.connect#QueueId", - "traits": { - "smithy.api#documentation": "

The identifier for the queue.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "OutboundCallerConfig": { - "target": "com.amazonaws.connect#OutboundCallerConfig", - "traits": { - "smithy.api#documentation": "

The outbound caller ID name, number, and outbound whisper flow.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#UpdateQueueStatus": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateQueueStatusRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates the status of the queue.

", - "smithy.api#http": { - "method": "POST", - "uri": "/queues/{InstanceId}/{QueueId}/status", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateQueueStatusRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "QueueId": { - "target": "com.amazonaws.connect#QueueId", - "traits": { - "smithy.api#documentation": "

The identifier for the queue.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.connect#QueueStatus", - "traits": { - "smithy.api#documentation": "

The status of the queue.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#UpdateQuickConnectConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateQuickConnectConfigRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the configuration settings for the specified quick connect.

", - "smithy.api#http": { - "method": "POST", - "uri": "/quick-connects/{InstanceId}/{QuickConnectId}/config", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateQuickConnectConfigRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "QuickConnectId": { - "target": "com.amazonaws.connect#QuickConnectId", - "traits": { - "smithy.api#documentation": "

The identifier for the quick connect.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "QuickConnectConfig": { - "target": "com.amazonaws.connect#QuickConnectConfig", - "traits": { - "smithy.api#documentation": "

Information about the configuration settings for the quick connect.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#UpdateQuickConnectDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 250 - } - } - }, - "com.amazonaws.connect#UpdateQuickConnectName": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateQuickConnectNameRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided.

", - "smithy.api#http": { - "method": "POST", - "uri": "/quick-connects/{InstanceId}/{QuickConnectId}/name", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateQuickConnectNameRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "QuickConnectId": { - "target": "com.amazonaws.connect#QuickConnectId", - "traits": { - "smithy.api#documentation": "

The identifier for the quick connect.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.connect#QuickConnectName", - "traits": { - "smithy.api#documentation": "

The name of the quick connect.

" - } - }, - "Description": { - "target": "com.amazonaws.connect#UpdateQuickConnectDescription", - "traits": { - "smithy.api#documentation": "

The description of the quick connect.

" - } - } - } - }, - "com.amazonaws.connect#UpdateRoutingProfileConcurrency": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateRoutingProfileConcurrencyRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing\n profile.

", - "smithy.api#http": { - "method": "POST", - "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/concurrency", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateRoutingProfileConcurrencyRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RoutingProfileId": { - "target": "com.amazonaws.connect#RoutingProfileId", - "traits": { - "smithy.api#documentation": "

The identifier of the routing profile.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MediaConcurrencies": { - "target": "com.amazonaws.connect#MediaConcurrencies", - "traits": { - "smithy.api#documentation": "

The channels that agents can handle in the Contact Control Panel (CCP).

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#UpdateRoutingProfileDefaultOutboundQueue": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateRoutingProfileDefaultOutboundQueueRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the default outbound queue of a routing profile.

", - "smithy.api#http": { - "method": "POST", - "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/default-outbound-queue", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateRoutingProfileDefaultOutboundQueueRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RoutingProfileId": { - "target": "com.amazonaws.connect#RoutingProfileId", - "traits": { - "smithy.api#documentation": "

The identifier of the routing profile.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DefaultOutboundQueueId": { - "target": "com.amazonaws.connect#QueueId", - "traits": { - "smithy.api#documentation": "

The identifier for the default outbound queue.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#UpdateRoutingProfileName": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateRoutingProfileNameRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#DuplicateResourceException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the name and description of a routing profile. The request accepts the following data in JSON format.\n At least Name or Description must be provided.

", - "smithy.api#http": { - "method": "POST", - "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/name", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateRoutingProfileNameRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RoutingProfileId": { - "target": "com.amazonaws.connect#RoutingProfileId", - "traits": { - "smithy.api#documentation": "

The identifier of the routing profile.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.connect#RoutingProfileName", - "traits": { - "smithy.api#documentation": "

The name of the routing profile. Must not be more than 127 characters.

" - } - }, - "Description": { - "target": "com.amazonaws.connect#RoutingProfileDescription", - "traits": { - "smithy.api#documentation": "

The description of the routing profile. Must not be more than 250 characters.

" - } - } - } - }, - "com.amazonaws.connect#UpdateRoutingProfileQueues": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateRoutingProfileQueuesRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the properties associated with a set of queues for a routing profile.

", - "smithy.api#http": { - "method": "POST", - "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/queues", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateRoutingProfileQueuesRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RoutingProfileId": { - "target": "com.amazonaws.connect#RoutingProfileId", - "traits": { - "smithy.api#documentation": "

The identifier of the routing profile.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "QueueConfigs": { - "target": "com.amazonaws.connect#RoutingProfileQueueConfigList", - "traits": { - "smithy.api#documentation": "

The queues to be updated for this routing profile.\n Queues must first be associated to the routing\n profile. You can do this using AssociateRoutingProfileQueues.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#UpdateRule": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateRuleRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceConflictException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a rule for the specified Amazon Connect instance.

\n

Use the Rules Function language to code conditions for the rule.\n

", - "smithy.api#http": { - "method": "PUT", - "uri": "/rules/{InstanceId}/{RuleId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateRuleRequest": { - "type": "structure", - "members": { - "RuleId": { - "target": "com.amazonaws.connect#RuleId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the rule.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.connect#RuleName", - "traits": { - "smithy.api#documentation": "

The name of the rule. You can change the name only if TriggerEventSource is one\n of the following values: OnZendeskTicketCreate |\n OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate\n

", - "smithy.api#required": {} - } - }, - "Function": { - "target": "com.amazonaws.connect#RuleFunction", - "traits": { - "smithy.api#documentation": "

The conditions of the rule.

", - "smithy.api#required": {} - } - }, - "Actions": { - "target": "com.amazonaws.connect#RuleActions", - "traits": { - "smithy.api#documentation": "

A list of actions to be run when the rule is triggered.

", - "smithy.api#required": {} - } - }, - "PublishStatus": { - "target": "com.amazonaws.connect#RulePublishStatus", - "traits": { - "smithy.api#documentation": "

The publish status of the rule.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#UpdateSecurityProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateSecurityProfileRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates a security profile.

", - "smithy.api#http": { - "method": "POST", - "uri": "/security-profiles/{InstanceId}/{SecurityProfileId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateSecurityProfileRequest": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.connect#SecurityProfileDescription", - "traits": { - "smithy.api#documentation": "

The description of the security profile.

" - } - }, - "Permissions": { - "target": "com.amazonaws.connect#PermissionsList", - "traits": { - "smithy.api#documentation": "

The permissions granted to a security profile. For a list of valid permissions, see List of security\n profile permissions.

" - } - }, - "SecurityProfileId": { - "target": "com.amazonaws.connect#SecurityProfileId", - "traits": { - "smithy.api#documentation": "

The identifier for the security profle.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AllowedAccessControlTags": { - "target": "com.amazonaws.connect#AllowedAccessControlTags", - "traits": { - "smithy.api#documentation": "

The list of tags that a security profile uses to restrict access to resources in Amazon Connect.

" - } - }, - "TagRestrictedResources": { - "target": "com.amazonaws.connect#TagRestrictedResourceList", - "traits": { - "smithy.api#documentation": "

The list of resources that a security profile applies tag restrictions to in Amazon Connect.

" - } - } - } - }, - "com.amazonaws.connect#UpdateTaskTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateTaskTemplateRequest" - }, - "output": { - "target": "com.amazonaws.connect#UpdateTaskTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#PropertyValidationException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates details about a specific task template in the specified Amazon Connect instance.\n This operation does not support partial updates. Instead it does a full update of template\n content.

", - "smithy.api#http": { - "method": "POST", - "uri": "/instance/{InstanceId}/task/template/{TaskTemplateId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateTaskTemplateRequest": { - "type": "structure", - "members": { - "TaskTemplateId": { - "target": "com.amazonaws.connect#TaskTemplateId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the task template.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.connect#TaskTemplateName", - "traits": { - "smithy.api#documentation": "

The name of the task template.

" - } - }, - "Description": { - "target": "com.amazonaws.connect#TaskTemplateDescription", - "traits": { - "smithy.api#documentation": "

The description of the task template.

" - } - }, - "ContactFlowId": { - "target": "com.amazonaws.connect#ContactFlowId", - "traits": { - "smithy.api#documentation": "

The identifier of the flow that runs by default when a task is created by referencing this template.

" - } - }, - "Constraints": { - "target": "com.amazonaws.connect#TaskTemplateConstraints", - "traits": { - "smithy.api#documentation": "

Constraints that are applicable to the fields listed.

" - } - }, - "Defaults": { - "target": "com.amazonaws.connect#TaskTemplateDefaults", - "traits": { - "smithy.api#documentation": "

The default values for fields when a task is created by referencing this template.

" - } - }, - "Status": { - "target": "com.amazonaws.connect#TaskTemplateStatus", - "traits": { - "smithy.api#documentation": "

Marks a template as ACTIVE or INACTIVE for a task to refer to it. \nTasks can only be created from ACTIVE templates.\nIf a template is marked as INACTIVE, then a task that refers to this template cannot be created.

" - } - }, - "Fields": { - "target": "com.amazonaws.connect#TaskTemplateFields", - "traits": { - "smithy.api#documentation": "

Fields that are part of the template.

" - } - } - } - }, - "com.amazonaws.connect#UpdateTaskTemplateResponse": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

" - } - }, - "Id": { - "target": "com.amazonaws.connect#TaskTemplateId", - "traits": { - "smithy.api#documentation": "

The identifier of the task template resource.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#TaskTemplateArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the task template resource.

" - } - }, - "Name": { - "target": "com.amazonaws.connect#TaskTemplateName", - "traits": { - "smithy.api#documentation": "

The name of the task template.

" - } - }, - "Description": { - "target": "com.amazonaws.connect#TaskTemplateDescription", - "traits": { - "smithy.api#documentation": "

The description of the task template.

" - } - }, - "ContactFlowId": { - "target": "com.amazonaws.connect#ContactFlowId", - "traits": { - "smithy.api#documentation": "

The identifier of the flow that runs by default when a task is created by referencing this template.

" - } - }, - "Constraints": { - "target": "com.amazonaws.connect#TaskTemplateConstraints", - "traits": { - "smithy.api#documentation": "

Constraints that are applicable to the fields listed.

" - } - }, - "Defaults": { - "target": "com.amazonaws.connect#TaskTemplateDefaults", - "traits": { - "smithy.api#documentation": "

The default values for fields when a task is created by referencing this template.

" - } - }, - "Fields": { - "target": "com.amazonaws.connect#TaskTemplateFields", - "traits": { - "smithy.api#documentation": "

Fields that are part of the template.

" - } - }, - "Status": { - "target": "com.amazonaws.connect#TaskTemplateStatus", - "traits": { - "smithy.api#documentation": "

Marks a template as ACTIVE or INACTIVE for a task to refer to it. \nTasks can only be created from ACTIVE templates.\nIf a template is marked as INACTIVE, then a task that refers to this template cannot be created.

" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp when the task template was last modified.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.connect#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp when the task template was created.

" - } - } - } - }, - "com.amazonaws.connect#UpdateTrafficDistribution": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateTrafficDistributionRequest" - }, - "output": { - "target": "com.amazonaws.connect#UpdateTrafficDistributionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.connect#AccessDeniedException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceConflictException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the traffic distribution for a given traffic distribution group.

\n

For more information about updating a traffic distribution group, see Update telephony\n traffic distribution across Amazon Web Services Regions\n in the Amazon Connect Administrator Guide.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/traffic-distribution/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateTrafficDistributionRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#TrafficDistributionGroupIdOrArn", - "traits": { - "smithy.api#documentation": "

The identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TelephonyConfig": { - "target": "com.amazonaws.connect#TelephonyConfig", - "traits": { - "smithy.api#documentation": "

The distribution of traffic between the instance and its replica(s).

" - } - } - } - }, - "com.amazonaws.connect#UpdateTrafficDistributionResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.connect#UpdateUserHierarchy": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateUserHierarchyRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Assigns the specified hierarchy group to the specified user.

", - "smithy.api#http": { - "method": "POST", - "uri": "/users/{InstanceId}/{UserId}/hierarchy", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateUserHierarchyGroupName": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateUserHierarchyGroupNameRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#DuplicateResourceException" - }, - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the name of the user hierarchy group.

", - "smithy.api#http": { - "method": "POST", - "uri": "/user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}/name", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateUserHierarchyGroupNameRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.connect#HierarchyGroupName", - "traits": { - "smithy.api#documentation": "

The name of the hierarchy group. Must not be more than 100 characters.

", - "smithy.api#required": {} - } - }, - "HierarchyGroupId": { - "target": "com.amazonaws.connect#HierarchyGroupId", - "traits": { - "smithy.api#documentation": "

The identifier of the hierarchy group.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#UpdateUserHierarchyRequest": { - "type": "structure", - "members": { - "HierarchyGroupId": { - "target": "com.amazonaws.connect#HierarchyGroupId", - "traits": { - "smithy.api#documentation": "

The identifier of the hierarchy group.

" - } - }, - "UserId": { - "target": "com.amazonaws.connect#UserId", - "traits": { - "smithy.api#documentation": "

The identifier of the user account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#UpdateUserHierarchyStructure": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateUserHierarchyStructureRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceInUseException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.

", - "smithy.api#http": { - "method": "POST", - "uri": "/user-hierarchy-structure/{InstanceId}", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateUserHierarchyStructureRequest": { - "type": "structure", - "members": { - "HierarchyStructure": { - "target": "com.amazonaws.connect#HierarchyStructureUpdate", - "traits": { - "smithy.api#documentation": "

The hierarchy levels to update.

", - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#UpdateUserIdentityInfo": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateUserIdentityInfoRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the identity information for the specified user.

\n \n

We strongly recommend limiting who has the ability to invoke\n UpdateUserIdentityInfo. Someone with that ability can change the login credentials\n of other users by changing their email address. This poses a security risk to your organization.\n They can change the email address of a user to the attacker's email address, and then reset the\n password through email. For more information, see Best Practices for\n Security Profiles in the Amazon Connect Administrator\n Guide.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/users/{InstanceId}/{UserId}/identity-info", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateUserIdentityInfoRequest": { - "type": "structure", - "members": { - "IdentityInfo": { - "target": "com.amazonaws.connect#UserIdentityInfo", - "traits": { - "smithy.api#documentation": "

The identity information for the user.

", - "smithy.api#required": {} - } - }, - "UserId": { - "target": "com.amazonaws.connect#UserId", - "traits": { - "smithy.api#documentation": "

The identifier of the user account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#UpdateUserPhoneConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateUserPhoneConfigRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the phone configuration settings for the specified user.

", - "smithy.api#http": { - "method": "POST", - "uri": "/users/{InstanceId}/{UserId}/phone-config", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateUserPhoneConfigRequest": { - "type": "structure", - "members": { - "PhoneConfig": { - "target": "com.amazonaws.connect#UserPhoneConfig", - "traits": { - "smithy.api#documentation": "

Information about phone configuration settings for the user.

", - "smithy.api#required": {} - } - }, - "UserId": { - "target": "com.amazonaws.connect#UserId", - "traits": { - "smithy.api#documentation": "

The identifier of the user account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#UpdateUserRoutingProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateUserRoutingProfileRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Assigns the specified routing profile to the specified user.

", - "smithy.api#http": { - "method": "POST", - "uri": "/users/{InstanceId}/{UserId}/routing-profile", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateUserRoutingProfileRequest": { - "type": "structure", - "members": { - "RoutingProfileId": { - "target": "com.amazonaws.connect#RoutingProfileId", - "traits": { - "smithy.api#documentation": "

The identifier of the routing profile for the user.

", - "smithy.api#required": {} - } - }, - "UserId": { - "target": "com.amazonaws.connect#UserId", - "traits": { - "smithy.api#documentation": "

The identifier of the user account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#UpdateUserSecurityProfiles": { - "type": "operation", - "input": { - "target": "com.amazonaws.connect#UpdateUserSecurityProfilesRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.connect#InternalServiceException" - }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, - { - "target": "com.amazonaws.connect#InvalidRequestException" - }, - { - "target": "com.amazonaws.connect#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.connect#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Assigns the specified security profiles to the specified user.

", - "smithy.api#http": { - "method": "POST", - "uri": "/users/{InstanceId}/{UserId}/security-profiles", - "code": 200 - } - } - }, - "com.amazonaws.connect#UpdateUserSecurityProfilesRequest": { - "type": "structure", - "members": { - "SecurityProfileIds": { - "target": "com.amazonaws.connect#SecurityProfileIds", - "traits": { - "smithy.api#documentation": "

The identifiers of the security profiles for the user.

", - "smithy.api#required": {} - } - }, - "UserId": { - "target": "com.amazonaws.connect#UserId", - "traits": { - "smithy.api#documentation": "

The identifier of the user account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", - "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.connect#Url": { - "type": "string" - }, - "com.amazonaws.connect#UrlReference": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.connect#ReferenceKey", - "traits": { - "smithy.api#documentation": "

Identifier of the URL reference.

" - } - }, - "Value": { - "target": "com.amazonaws.connect#ReferenceValue", - "traits": { - "smithy.api#documentation": "

A valid URL.

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

The URL reference.

" - } - }, - "com.amazonaws.connect#UseCase": { - "type": "structure", - "members": { - "UseCaseId": { - "target": "com.amazonaws.connect#UseCaseId", - "traits": { - "smithy.api#documentation": "

The identifier for the use case.

" - } - }, - "UseCaseArn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the use case.

" - } - }, - "UseCaseType": { - "target": "com.amazonaws.connect#UseCaseType", - "traits": { - "smithy.api#documentation": "

The type of use case to associate to the integration association. Each integration\n association can have only one of each use case type.

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

Contains the\n use\n case.

" - } - }, - "com.amazonaws.connect#UseCaseId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.connect#UseCaseSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#UseCase" - } - }, - "com.amazonaws.connect#UseCaseType": { - "type": "enum", - "members": { - "RULES_EVALUATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RULES_EVALUATION" - } - }, - "CONNECT_CAMPAIGNS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONNECT_CAMPAIGNS" - } - } - } - }, - "com.amazonaws.connect#User": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#UserId", - "traits": { - "smithy.api#documentation": "

The identifier of the user account.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user account.

" - } - }, - "Username": { - "target": "com.amazonaws.connect#AgentUsername", - "traits": { - "smithy.api#documentation": "

The user name assigned to the user account.

" - } - }, - "IdentityInfo": { - "target": "com.amazonaws.connect#UserIdentityInfo", - "traits": { - "smithy.api#documentation": "

Information about the user identity.

" - } - }, - "PhoneConfig": { - "target": "com.amazonaws.connect#UserPhoneConfig", - "traits": { - "smithy.api#documentation": "

Information about the phone configuration for the user.

" - } - }, - "DirectoryUserId": { - "target": "com.amazonaws.connect#DirectoryUserId", - "traits": { - "smithy.api#documentation": "

The identifier of the user account in the directory used for identity management.

" - } - }, - "SecurityProfileIds": { - "target": "com.amazonaws.connect#SecurityProfileIds", - "traits": { - "smithy.api#documentation": "

The identifiers of the security profiles for the user.

" - } - }, - "RoutingProfileId": { - "target": "com.amazonaws.connect#RoutingProfileId", - "traits": { - "smithy.api#documentation": "

The identifier of the routing profile for the user.

" - } - }, - "HierarchyGroupId": { - "target": "com.amazonaws.connect#HierarchyGroupId", - "traits": { - "smithy.api#documentation": "

The identifier of the hierarchy group for the user.

" - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The\n tags.

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

Contains information about a user account for an Amazon Connect instance.

" - } - }, - "com.amazonaws.connect#UserData": { - "type": "structure", - "members": { - "User": { - "target": "com.amazonaws.connect#UserReference", - "traits": { - "smithy.api#documentation": "

Information about the user for the data that is returned. It contains the\n resourceId and ARN of the user.

" - } - }, - "RoutingProfile": { - "target": "com.amazonaws.connect#RoutingProfileReference", - "traits": { - "smithy.api#documentation": "

Information about the routing profile that is assigned to the user.

" - } - }, - "HierarchyPath": { - "target": "com.amazonaws.connect#HierarchyPathReference", - "traits": { - "smithy.api#documentation": "

Contains information about the levels of a hierarchy group assigned to a user.

" - } - }, - "Status": { - "target": "com.amazonaws.connect#AgentStatusReference", - "traits": { - "smithy.api#documentation": "

The status of the agent that they manually set in their Contact Control Panel (CCP), or that\n the supervisor manually changes in the real-time metrics report.

" - } - }, - "AvailableSlotsByChannel": { - "target": "com.amazonaws.connect#ChannelToCountMap", - "traits": { - "smithy.api#documentation": "

A map of available slots by channel. The key is a channel name. The value is an integer: the\n available number of slots.

" - } - }, - "MaxSlotsByChannel": { - "target": "com.amazonaws.connect#ChannelToCountMap", - "traits": { - "smithy.api#documentation": "

A map of maximum slots by channel. The key is a channel name. The value is an integer: the\n maximum number of slots. This is calculated from MediaConcurrency of the\n RoutingProfile assigned to the agent.

" - } - }, - "ActiveSlotsByChannel": { - "target": "com.amazonaws.connect#ChannelToCountMap", - "traits": { - "smithy.api#documentation": "

A map of active slots by channel. The key is a channel name. The value is an integer: the\n number of active slots.

" - } - }, - "Contacts": { - "target": "com.amazonaws.connect#AgentContactReferenceList", - "traits": { - "smithy.api#documentation": "

A list of contact reference information.

" - } - }, - "NextStatus": { - "target": "com.amazonaws.connect#AgentStatusName", - "traits": { - "smithy.api#documentation": "

The Next status of the agent.

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

Data for a user.

" - } - }, - "com.amazonaws.connect#UserDataFilters": { - "type": "structure", - "members": { - "Queues": { - "target": "com.amazonaws.connect#Queues", - "traits": { - "smithy.api#documentation": "

A list of up to 100 queues or ARNs.

" - } - }, - "ContactFilter": { - "target": "com.amazonaws.connect#ContactFilter", - "traits": { - "smithy.api#documentation": "

A filter for the user data based on the contact information that is associated to the user.\n It contains a list of contact states.

" - } - }, - "RoutingProfiles": { - "target": "com.amazonaws.connect#RoutingProfiles", - "traits": { - "smithy.api#documentation": "

A list of up to 100 routing profile IDs or ARNs.

" - } - }, - "Agents": { - "target": "com.amazonaws.connect#AgentsMinOneMaxHundred", - "traits": { - "smithy.api#documentation": "

A list of up to 100 agent IDs or ARNs.

" - } - }, - "UserHierarchyGroups": { - "target": "com.amazonaws.connect#UserDataHierarchyGroups", - "traits": { - "smithy.api#documentation": "

A UserHierarchyGroup ID or ARN.

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

A filter for the user data.

" - } - }, - "com.amazonaws.connect#UserDataHierarchyGroups": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#HierarchyGroupId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.connect#UserDataList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#UserData" - } - }, - "com.amazonaws.connect#UserId": { - "type": "string" - }, - "com.amazonaws.connect#UserIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#UserId" - } - }, - "com.amazonaws.connect#UserIdentityInfo": { - "type": "structure", - "members": { - "FirstName": { - "target": "com.amazonaws.connect#AgentFirstName", - "traits": { - "smithy.api#documentation": "

The first name. This is required if you are using Amazon Connect or SAML for identity\n management.

" - } - }, - "LastName": { - "target": "com.amazonaws.connect#AgentLastName", - "traits": { - "smithy.api#documentation": "

The last name. This is required if you are using Amazon Connect or SAML for identity\n management.

" - } - }, - "Email": { - "target": "com.amazonaws.connect#Email", - "traits": { - "smithy.api#documentation": "

The email address. If you are using SAML for identity management and include this parameter,\n an error is returned.

" - } - }, - "SecondaryEmail": { - "target": "com.amazonaws.connect#Email", - "traits": { - "smithy.api#documentation": "

The user's secondary email address. If you provide a secondary email, the user receives\n email notifications - other than password reset notifications - to this email address instead of\n to their primary email address.

\n

Pattern: (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,63}\n

" - } - }, - "Mobile": { - "target": "com.amazonaws.connect#PhoneNumber", - "traits": { - "smithy.api#documentation": "

The user's mobile number.

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

Contains information about the identity of a user.

" - } - }, - "com.amazonaws.connect#UserIdentityInfoLite": { - "type": "structure", - "members": { - "FirstName": { - "target": "com.amazonaws.connect#AgentFirstName", - "traits": { - "smithy.api#documentation": "

The user's first name.

" - } - }, - "LastName": { - "target": "com.amazonaws.connect#AgentLastName", - "traits": { - "smithy.api#documentation": "

The user's last name.

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

The user's first name and last name.

" - } - }, - "com.amazonaws.connect#UserNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.connect#Message" - } - }, - "traits": { - "smithy.api#documentation": "

No user with the specified credentials was found in the Amazon Connect instance.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.connect#UserPhoneConfig": { - "type": "structure", - "members": { - "PhoneType": { - "target": "com.amazonaws.connect#PhoneType", - "traits": { - "smithy.api#documentation": "

The phone type.

", - "smithy.api#required": {} - } - }, - "AutoAccept": { - "target": "com.amazonaws.connect#AutoAccept", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The Auto accept setting.

" - } - }, - "AfterContactWorkTimeLimit": { - "target": "com.amazonaws.connect#AfterContactWorkTimeLimit", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The After Call Work (ACW) timeout setting, in seconds.

\n \n

When returned by a SearchUsers call, AfterContactWorkTimeLimit is\n returned in milliseconds.

\n " - } - }, - "DeskPhoneNumber": { - "target": "com.amazonaws.connect#PhoneNumber", - "traits": { - "smithy.api#documentation": "

The phone number for the user's desk phone.

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

Contains information about the phone configuration settings for a user.

" - } - }, - "com.amazonaws.connect#UserQuickConnectConfig": { - "type": "structure", - "members": { - "UserId": { - "target": "com.amazonaws.connect#UserId", - "traits": { - "smithy.api#documentation": "

The identifier of the user.

", - "smithy.api#required": {} - } - }, - "ContactFlowId": { - "target": "com.amazonaws.connect#ContactFlowId", - "traits": { - "smithy.api#documentation": "

The identifier of the flow.

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

Contains information about the quick connect configuration settings for a user. The contact\n flow must be of type Transfer to Agent.

" - } - }, - "com.amazonaws.connect#UserReference": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#UserId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the user.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the user.

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

Information about the user.

" - } - }, - "com.amazonaws.connect#UserSearchConditionList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#UserSearchCriteria" - } - }, - "com.amazonaws.connect#UserSearchCriteria": { - "type": "structure", - "members": { - "OrConditions": { - "target": "com.amazonaws.connect#UserSearchConditionList", - "traits": { - "smithy.api#documentation": "

A list of conditions which would be applied together with an OR\n condition.

" - } - }, - "AndConditions": { - "target": "com.amazonaws.connect#UserSearchConditionList", - "traits": { - "smithy.api#documentation": "

A list of conditions which would be applied together with an AND condition.\n

" - } - }, - "StringCondition": { - "target": "com.amazonaws.connect#StringCondition", - "traits": { - "smithy.api#documentation": "

A leaf node condition which can be used to specify a string condition.

" - } - }, - "HierarchyGroupCondition": { - "target": "com.amazonaws.connect#HierarchyGroupCondition", - "traits": { - "smithy.api#documentation": "

A leaf node condition which can be used to specify a hierarchy group condition.

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

The search criteria to be used to return users.

\n \n

The name and description fields support \"contains\" queries with\n a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths\n outside of this range will throw invalid results.

\n " - } - }, - "com.amazonaws.connect#UserSearchFilter": { - "type": "structure", - "members": { - "TagFilter": { - "target": "com.amazonaws.connect#ControlPlaneTagFilter" - } - }, - "traits": { - "smithy.api#documentation": "

Filters to be applied to search results.

" - } - }, - "com.amazonaws.connect#UserSearchSummary": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user.

" - } - }, - "DirectoryUserId": { - "target": "com.amazonaws.connect#DirectoryUserId", - "traits": { - "smithy.api#documentation": "

The directory identifier of the user.

" - } - }, - "HierarchyGroupId": { - "target": "com.amazonaws.connect#HierarchyGroupId", - "traits": { - "smithy.api#documentation": "

The identifier of the user's hierarchy group.

" - } - }, - "Id": { - "target": "com.amazonaws.connect#UserId", - "traits": { - "smithy.api#documentation": "

The identifier of the user's summary.

" - } - }, - "IdentityInfo": { - "target": "com.amazonaws.connect#UserIdentityInfoLite", - "traits": { - "smithy.api#documentation": "

The user's first name and last name.

" - } - }, - "PhoneConfig": { - "target": "com.amazonaws.connect#UserPhoneConfig" - }, - "RoutingProfileId": { - "target": "com.amazonaws.connect#RoutingProfileId", - "traits": { - "smithy.api#documentation": "

The identifier of the user's routing profile.

" - } - }, - "SecurityProfileIds": { - "target": "com.amazonaws.connect#SecurityProfileIds", - "traits": { - "smithy.api#documentation": "

The identifiers of the user's security profiles.

" - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" - } - }, - "Username": { - "target": "com.amazonaws.connect#AgentUsername", - "traits": { - "smithy.api#documentation": "

The name of the user.

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

Information about the returned users.

" - } - }, - "com.amazonaws.connect#UserSearchSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#UserSearchSummary" - } - }, - "com.amazonaws.connect#UserSummary": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.connect#UserId", - "traits": { - "smithy.api#documentation": "

The identifier of the user account.

" - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user account.

" - } - }, - "Username": { - "target": "com.amazonaws.connect#AgentUsername", - "traits": { - "smithy.api#documentation": "

The Amazon Connect user name of the user account.

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

Contains summary information about a user.

" - } - }, - "com.amazonaws.connect#UserSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#UserSummary" - } - }, - "com.amazonaws.connect#UserTagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.connect#String" - }, - "value": { - "target": "com.amazonaws.connect#String" - } - }, - "com.amazonaws.connect#Value": { - "type": "double" - }, - "com.amazonaws.connect#Vocabulary": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.connect#VocabularyName", - "traits": { - "smithy.api#documentation": "

A unique name of the custom vocabulary.

", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.connect#VocabularyId", - "traits": { - "smithy.api#documentation": "

The identifier of the custom vocabulary.

", - "smithy.api#required": {} - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom vocabulary.

", - "smithy.api#required": {} - } - }, - "LanguageCode": { - "target": "com.amazonaws.connect#VocabularyLanguageCode", - "traits": { - "smithy.api#documentation": "

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see \nWhat is Amazon Transcribe?\n

", - "smithy.api#required": {} - } - }, - "State": { - "target": "com.amazonaws.connect#VocabularyState", - "traits": { - "smithy.api#documentation": "

The current state of the custom vocabulary.

", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.connect#VocabularyLastModifiedTime", - "traits": { - "smithy.api#documentation": "

The timestamp when the custom vocabulary was last modified.

", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.connect#VocabularyFailureReason", - "traits": { - "smithy.api#documentation": "

The reason why the custom vocabulary was not created.

" - } - }, - "Content": { - "target": "com.amazonaws.connect#VocabularyContent", - "traits": { - "smithy.api#documentation": "

The content of the custom vocabulary in plain-text format with a table of values. Each row\n in the table represents a word or a phrase, described with Phrase, IPA,\n SoundsLike, and DisplayAs fields. Separate the fields with TAB\n characters. For more information, see Create a custom\n vocabulary using a table.

" - } - }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", - "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

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

Contains information about a custom vocabulary.

" - } - }, - "com.amazonaws.connect#VocabularyContent": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 60000 - } - } - }, - "com.amazonaws.connect#VocabularyFailureReason": { - "type": "string" - }, - "com.amazonaws.connect#VocabularyId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 500 - } - } - }, - "com.amazonaws.connect#VocabularyLanguageCode": { - "type": "enum", - "members": { - "AR_AE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ar-AE" - } - }, - "DE_CH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "de-CH" - } - }, - "DE_DE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "de-DE" - } - }, - "EN_AB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "en-AB" - } - }, - "EN_AU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "en-AU" - } - }, - "EN_GB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "en-GB" - } - }, - "EN_IE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "en-IE" - } - }, - "EN_IN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "en-IN" - } - }, - "EN_US": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "en-US" - } - }, - "EN_WL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "en-WL" - } - }, - "ES_ES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "es-ES" - } - }, - "ES_US": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "es-US" - } - }, - "FR_CA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fr-CA" - } - }, - "FR_FR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fr-FR" - } - }, - "HI_IN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "hi-IN" - } - }, - "IT_IT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "it-IT" - } - }, - "JA_JP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ja-JP" - } - }, - "KO_KR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ko-KR" - } - }, - "PT_BR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pt-BR" - } - }, - "PT_PT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pt-PT" - } - }, - "ZH_CN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "zh-CN" - } - }, - "EN_NZ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "en-NZ" - } - }, - "EN_ZA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "en-ZA" - } - } - } - }, - "com.amazonaws.connect#VocabularyLastModifiedTime": { - "type": "timestamp" - }, - "com.amazonaws.connect#VocabularyName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 140 - }, - "smithy.api#pattern": "^[0-9a-zA-Z._-]+$" - } - }, - "com.amazonaws.connect#VocabularyNextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 131070 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.connect#VocabularyState": { - "type": "enum", - "members": { - "CREATION_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATION_IN_PROGRESS" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "CREATION_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATION_FAILED" - } - }, - "DELETE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_IN_PROGRESS" - } - } - } - }, - "com.amazonaws.connect#VocabularySummary": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.connect#VocabularyName", - "traits": { - "smithy.api#documentation": "

A unique name of the custom vocabulary.

", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.connect#VocabularyId", - "traits": { - "smithy.api#documentation": "

The identifier of the custom vocabulary.

", - "smithy.api#required": {} - } - }, - "Arn": { - "target": "com.amazonaws.connect#ARN", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom vocabulary.

", - "smithy.api#required": {} - } - }, - "LanguageCode": { - "target": "com.amazonaws.connect#VocabularyLanguageCode", - "traits": { - "smithy.api#documentation": "

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see \nWhat is Amazon Transcribe?\n

", - "smithy.api#required": {} - } - }, - "State": { - "target": "com.amazonaws.connect#VocabularyState", - "traits": { - "smithy.api#documentation": "

The current state of the custom vocabulary.

", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.connect#VocabularyLastModifiedTime", - "traits": { - "smithy.api#documentation": "

The timestamp when the custom vocabulary was last modified.

", - "smithy.api#required": {} - } - }, - "FailureReason": { - "target": "com.amazonaws.connect#VocabularyFailureReason", - "traits": { - "smithy.api#documentation": "

The reason why the custom vocabulary was not created.

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

Contains summary information about the custom vocabulary.

" - } - }, - "com.amazonaws.connect#VocabularySummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#VocabularySummary" - } - }, - "com.amazonaws.connect#VoiceRecordingConfiguration": { - "type": "structure", - "members": { - "VoiceRecordingTrack": { - "target": "com.amazonaws.connect#VoiceRecordingTrack", - "traits": { - "smithy.api#documentation": "

Identifies which track is being recorded.

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

Contains information about the recording configuration settings.

" - } - }, - "com.amazonaws.connect#VoiceRecordingTrack": { - "type": "enum", - "members": { - "FROM_AGENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FROM_AGENT" - } - }, - "TO_AGENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TO_AGENT" - } - }, - "ALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL" - } + "target": "com.amazonaws.connect#AssociateLexBot" + }, + { + "target": "com.amazonaws.connect#AssociatePhoneNumberContactFlow" + }, + { + "target": "com.amazonaws.connect#AssociateQueueQuickConnects" + }, + { + "target": "com.amazonaws.connect#AssociateRoutingProfileQueues" + }, + { + "target": "com.amazonaws.connect#AssociateSecurityKey" + }, + { + "target": "com.amazonaws.connect#ClaimPhoneNumber" + }, + { + "target": "com.amazonaws.connect#CreateAgentStatus" + }, + { + "target": "com.amazonaws.connect#CreateContactFlow" + }, + { + "target": "com.amazonaws.connect#CreateContactFlowModule" + }, + { + "target": "com.amazonaws.connect#CreateHoursOfOperation" + }, + { + "target": "com.amazonaws.connect#CreateInstance" + }, + { + "target": "com.amazonaws.connect#CreateIntegrationAssociation" + }, + { + "target": "com.amazonaws.connect#CreateQueue" + }, + { + "target": "com.amazonaws.connect#CreateQuickConnect" + }, + { + "target": "com.amazonaws.connect#CreateRoutingProfile" + }, + { + "target": "com.amazonaws.connect#CreateRule" + }, + { + "target": "com.amazonaws.connect#CreateSecurityProfile" + }, + { + "target": "com.amazonaws.connect#CreateTaskTemplate" + }, + { + "target": "com.amazonaws.connect#CreateTrafficDistributionGroup" + }, + { + "target": "com.amazonaws.connect#CreateUseCase" + }, + { + "target": "com.amazonaws.connect#CreateUser" + }, + { + "target": "com.amazonaws.connect#CreateUserHierarchyGroup" + }, + { + "target": "com.amazonaws.connect#CreateVocabulary" + }, + { + "target": "com.amazonaws.connect#DeleteContactFlow" + }, + { + "target": "com.amazonaws.connect#DeleteContactFlowModule" + }, + { + "target": "com.amazonaws.connect#DeleteHoursOfOperation" + }, + { + "target": "com.amazonaws.connect#DeleteInstance" + }, + { + "target": "com.amazonaws.connect#DeleteIntegrationAssociation" + }, + { + "target": "com.amazonaws.connect#DeleteQuickConnect" + }, + { + "target": "com.amazonaws.connect#DeleteRule" + }, + { + "target": "com.amazonaws.connect#DeleteSecurityProfile" + }, + { + "target": "com.amazonaws.connect#DeleteTaskTemplate" + }, + { + "target": "com.amazonaws.connect#DeleteTrafficDistributionGroup" + }, + { + "target": "com.amazonaws.connect#DeleteUseCase" + }, + { + "target": "com.amazonaws.connect#DeleteUser" + }, + { + "target": "com.amazonaws.connect#DeleteUserHierarchyGroup" + }, + { + "target": "com.amazonaws.connect#DeleteVocabulary" + }, + { + "target": "com.amazonaws.connect#DescribeAgentStatus" + }, + { + "target": "com.amazonaws.connect#DescribeContact" + }, + { + "target": "com.amazonaws.connect#DescribeContactFlow" + }, + { + "target": "com.amazonaws.connect#DescribeContactFlowModule" + }, + { + "target": "com.amazonaws.connect#DescribeHoursOfOperation" + }, + { + "target": "com.amazonaws.connect#DescribeInstance" + }, + { + "target": "com.amazonaws.connect#DescribeInstanceAttribute" + }, + { + "target": "com.amazonaws.connect#DescribeInstanceStorageConfig" + }, + { + "target": "com.amazonaws.connect#DescribePhoneNumber" + }, + { + "target": "com.amazonaws.connect#DescribeQueue" + }, + { + "target": "com.amazonaws.connect#DescribeQuickConnect" + }, + { + "target": "com.amazonaws.connect#DescribeRoutingProfile" + }, + { + "target": "com.amazonaws.connect#DescribeRule" + }, + { + "target": "com.amazonaws.connect#DescribeSecurityProfile" + }, + { + "target": "com.amazonaws.connect#DescribeTrafficDistributionGroup" + }, + { + "target": "com.amazonaws.connect#DescribeUser" + }, + { + "target": "com.amazonaws.connect#DescribeUserHierarchyGroup" + }, + { + "target": "com.amazonaws.connect#DescribeUserHierarchyStructure" + }, + { + "target": "com.amazonaws.connect#DescribeVocabulary" + }, + { + "target": "com.amazonaws.connect#DisassociateApprovedOrigin" + }, + { + "target": "com.amazonaws.connect#DisassociateBot" + }, + { + "target": "com.amazonaws.connect#DisassociateInstanceStorageConfig" + }, + { + "target": "com.amazonaws.connect#DisassociateLambdaFunction" + }, + { + "target": "com.amazonaws.connect#DisassociateLexBot" + }, + { + "target": "com.amazonaws.connect#DisassociatePhoneNumberContactFlow" + }, + { + "target": "com.amazonaws.connect#DisassociateQueueQuickConnects" + }, + { + "target": "com.amazonaws.connect#DisassociateRoutingProfileQueues" + }, + { + "target": "com.amazonaws.connect#DisassociateSecurityKey" + }, + { + "target": "com.amazonaws.connect#DismissUserContact" + }, + { + "target": "com.amazonaws.connect#GetContactAttributes" + }, + { + "target": "com.amazonaws.connect#GetCurrentMetricData" + }, + { + "target": "com.amazonaws.connect#GetCurrentUserData" + }, + { + "target": "com.amazonaws.connect#GetFederationToken" + }, + { + "target": "com.amazonaws.connect#GetMetricData" + }, + { + "target": "com.amazonaws.connect#GetTaskTemplate" + }, + { + "target": "com.amazonaws.connect#GetTrafficDistribution" + }, + { + "target": "com.amazonaws.connect#ListAgentStatuses" + }, + { + "target": "com.amazonaws.connect#ListApprovedOrigins" + }, + { + "target": "com.amazonaws.connect#ListBots" + }, + { + "target": "com.amazonaws.connect#ListContactFlowModules" + }, + { + "target": "com.amazonaws.connect#ListContactFlows" + }, + { + "target": "com.amazonaws.connect#ListContactReferences" + }, + { + "target": "com.amazonaws.connect#ListDefaultVocabularies" + }, + { + "target": "com.amazonaws.connect#ListHoursOfOperations" + }, + { + "target": "com.amazonaws.connect#ListInstanceAttributes" + }, + { + "target": "com.amazonaws.connect#ListInstances" + }, + { + "target": "com.amazonaws.connect#ListInstanceStorageConfigs" + }, + { + "target": "com.amazonaws.connect#ListIntegrationAssociations" + }, + { + "target": "com.amazonaws.connect#ListLambdaFunctions" + }, + { + "target": "com.amazonaws.connect#ListLexBots" + }, + { + "target": "com.amazonaws.connect#ListPhoneNumbers" + }, + { + "target": "com.amazonaws.connect#ListPhoneNumbersV2" + }, + { + "target": "com.amazonaws.connect#ListPrompts" + }, + { + "target": "com.amazonaws.connect#ListQueueQuickConnects" + }, + { + "target": "com.amazonaws.connect#ListQueues" + }, + { + "target": "com.amazonaws.connect#ListQuickConnects" + }, + { + "target": "com.amazonaws.connect#ListRoutingProfileQueues" + }, + { + "target": "com.amazonaws.connect#ListRoutingProfiles" + }, + { + "target": "com.amazonaws.connect#ListRules" + }, + { + "target": "com.amazonaws.connect#ListSecurityKeys" + }, + { + "target": "com.amazonaws.connect#ListSecurityProfilePermissions" + }, + { + "target": "com.amazonaws.connect#ListSecurityProfiles" + }, + { + "target": "com.amazonaws.connect#ListTagsForResource" + }, + { + "target": "com.amazonaws.connect#ListTaskTemplates" + }, + { + "target": "com.amazonaws.connect#ListTrafficDistributionGroups" + }, + { + "target": "com.amazonaws.connect#ListUseCases" + }, + { + "target": "com.amazonaws.connect#ListUserHierarchyGroups" + }, + { + "target": "com.amazonaws.connect#ListUsers" + }, + { + "target": "com.amazonaws.connect#MonitorContact" + }, + { + "target": "com.amazonaws.connect#PutUserStatus" + }, + { + "target": "com.amazonaws.connect#ReleasePhoneNumber" + }, + { + "target": "com.amazonaws.connect#ReplicateInstance" + }, + { + "target": "com.amazonaws.connect#ResumeContactRecording" + }, + { + "target": "com.amazonaws.connect#SearchAvailablePhoneNumbers" + }, + { + "target": "com.amazonaws.connect#SearchQueues" + }, + { + "target": "com.amazonaws.connect#SearchRoutingProfiles" + }, + { + "target": "com.amazonaws.connect#SearchSecurityProfiles" + }, + { + "target": "com.amazonaws.connect#SearchUsers" + }, + { + "target": "com.amazonaws.connect#SearchVocabularies" + }, + { + "target": "com.amazonaws.connect#StartChatContact" + }, + { + "target": "com.amazonaws.connect#StartContactRecording" + }, + { + "target": "com.amazonaws.connect#StartContactStreaming" + }, + { + "target": "com.amazonaws.connect#StartOutboundVoiceContact" + }, + { + "target": "com.amazonaws.connect#StartTaskContact" + }, + { + "target": "com.amazonaws.connect#StopContact" + }, + { + "target": "com.amazonaws.connect#StopContactRecording" + }, + { + "target": "com.amazonaws.connect#StopContactStreaming" + }, + { + "target": "com.amazonaws.connect#SuspendContactRecording" + }, + { + "target": "com.amazonaws.connect#TagResource" + }, + { + "target": "com.amazonaws.connect#TransferContact" + }, + { + "target": "com.amazonaws.connect#UntagResource" + }, + { + "target": "com.amazonaws.connect#UpdateAgentStatus" + }, + { + "target": "com.amazonaws.connect#UpdateContact" + }, + { + "target": "com.amazonaws.connect#UpdateContactAttributes" + }, + { + "target": "com.amazonaws.connect#UpdateContactFlowContent" + }, + { + "target": "com.amazonaws.connect#UpdateContactFlowMetadata" + }, + { + "target": "com.amazonaws.connect#UpdateContactFlowModuleContent" + }, + { + "target": "com.amazonaws.connect#UpdateContactFlowModuleMetadata" + }, + { + "target": "com.amazonaws.connect#UpdateContactFlowName" + }, + { + "target": "com.amazonaws.connect#UpdateContactSchedule" + }, + { + "target": "com.amazonaws.connect#UpdateHoursOfOperation" + }, + { + "target": "com.amazonaws.connect#UpdateInstanceAttribute" + }, + { + "target": "com.amazonaws.connect#UpdateInstanceStorageConfig" + }, + { + "target": "com.amazonaws.connect#UpdateParticipantRoleConfig" + }, + { + "target": "com.amazonaws.connect#UpdatePhoneNumber" + }, + { + "target": "com.amazonaws.connect#UpdateQueueHoursOfOperation" + }, + { + "target": "com.amazonaws.connect#UpdateQueueMaxContacts" + }, + { + "target": "com.amazonaws.connect#UpdateQueueName" + }, + { + "target": "com.amazonaws.connect#UpdateQueueOutboundCallerConfig" + }, + { + "target": "com.amazonaws.connect#UpdateQueueStatus" + }, + { + "target": "com.amazonaws.connect#UpdateQuickConnectConfig" + }, + { + "target": "com.amazonaws.connect#UpdateQuickConnectName" + }, + { + "target": "com.amazonaws.connect#UpdateRoutingProfileConcurrency" + }, + { + "target": "com.amazonaws.connect#UpdateRoutingProfileDefaultOutboundQueue" + }, + { + "target": "com.amazonaws.connect#UpdateRoutingProfileName" + }, + { + "target": "com.amazonaws.connect#UpdateRoutingProfileQueues" + }, + { + "target": "com.amazonaws.connect#UpdateRule" + }, + { + "target": "com.amazonaws.connect#UpdateSecurityProfile" + }, + { + "target": "com.amazonaws.connect#UpdateTaskTemplate" + }, + { + "target": "com.amazonaws.connect#UpdateTrafficDistribution" + }, + { + "target": "com.amazonaws.connect#UpdateUserHierarchy" + }, + { + "target": "com.amazonaws.connect#UpdateUserHierarchyGroupName" + }, + { + "target": "com.amazonaws.connect#UpdateUserHierarchyStructure" + }, + { + "target": "com.amazonaws.connect#UpdateUserIdentityInfo" + }, + { + "target": "com.amazonaws.connect#UpdateUserPhoneConfig" + }, + { + "target": "com.amazonaws.connect#UpdateUserRoutingProfile" + }, + { + "target": "com.amazonaws.connect#UpdateUserSecurityProfiles" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Connect", + "arnNamespace": "connect", + "cloudFormationName": "Connect", + "cloudTrailEventSource": "connect.amazonaws.com", + "endpointPrefix": "connect" + }, + "aws.auth#sigv4": { + "name": "connect" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

Amazon Connect is a cloud-based contact center solution that you use to set up and\n manage a customer contact center and provide reliable customer engagement at any scale.

\n

Amazon Connect provides metrics and real-time reporting that enable you to optimize\n contact routing. You can also resolve customer issues more efficiently by getting customers in\n touch with the appropriate agents.

\n

There are limits to the number of Amazon Connect resources that you can create. There\n are also limits to the number of requests that you can make per second. For more information, see\n Amazon Connect Service Quotas in the Amazon Connect Administrator\n Guide.

\n

You can connect programmatically to an Amazon Web Services service by using an endpoint. For\n a list of Amazon Connect endpoints, see Amazon Connect Endpoints.

", + "smithy.api#title": "Amazon Connect Service", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": true, + "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": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "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" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://connect-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": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://connect-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://connect.{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://connect.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://connect-fips.ap-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://connect-fips.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://connect.ap-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://connect.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://connect-fips.ca-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ca-central-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://connect-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ca-central-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://connect.ca-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ca-central-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://connect.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ca-central-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://connect-fips.eu-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-central-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://connect-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-central-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://connect.eu-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-central-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://connect.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-central-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://connect-fips.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://connect-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://connect.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://connect.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://connect-fips.af-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "af-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://connect-fips.af-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "af-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://connect.af-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "af-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://connect.af-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "af-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://connect-fips.eu-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://connect-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://connect.eu-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://connect.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://connect-fips.ap-northeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://connect-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://connect.ap-northeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-2", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://connect.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-2", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://connect-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://connect-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://connect.ap-northeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://connect.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://connect-fips.us-gov-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-gov-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://connect-fips.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-gov-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://connect.us-gov-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-gov-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://connect.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-gov-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://connect-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://connect-fips.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://connect.ap-southeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://connect.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://connect-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://connect-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://connect.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-2", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://connect.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-2", + "UseFIPS": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://connect-fips.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://connect-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://connect.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://connect.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": 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": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": true, + "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": { + "UseDualStack": true, + "Region": "us-east-1", + "UseFIPS": false, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.connect#AnswerMachineDetectionConfig": { + "type": "structure", + "members": { + "EnableAnswerMachineDetection": { + "target": "com.amazonaws.connect#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The flag to indicate if answer machine detection analysis needs to be performed for a voice\n call. If set to true, TrafficType must be set as CAMPAIGN.\n

" + } + }, + "AwaitAnswerMachinePrompt": { + "target": "com.amazonaws.connect#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Wait for the answering machine prompt.

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

Configuration of the answering machine detection.

" + } + }, + "com.amazonaws.connect#ApproximateTotalCount": { + "type": "long" + }, + "com.amazonaws.connect#AssignContactCategoryActionDefinition": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

This action must be set if TriggerEventSource is one of the following values:\n OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable |\n OnPostChatAnalysisAvailable. Contact is categorized using the rule name.

\n

\n RuleName is used as ContactCategory.

" + } + }, + "com.amazonaws.connect#AssociateApprovedOrigin": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#AssociateApprovedOriginRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceConflictException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Associates an approved origin to an Amazon Connect instance.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/instance/{InstanceId}/approved-origin", + "code": 200 + } + } + }, + "com.amazonaws.connect#AssociateApprovedOriginRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Origin": { + "target": "com.amazonaws.connect#Origin", + "traits": { + "smithy.api#documentation": "

The domain to add to your allow list.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#AssociateBot": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#AssociateBotRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, + { + "target": "com.amazonaws.connect#ResourceConflictException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2\n bot.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/instance/{InstanceId}/bot", + "code": 200 + } + } + }, + "com.amazonaws.connect#AssociateBotRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LexBot": { + "target": "com.amazonaws.connect#LexBot" + }, + "LexV2Bot": { + "target": "com.amazonaws.connect#LexV2Bot", + "traits": { + "smithy.api#documentation": "

The Amazon Lex V2 bot to associate with the instance.

" + } + } + } + }, + "com.amazonaws.connect#AssociateDefaultVocabulary": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#AssociateDefaultVocabularyRequest" + }, + "output": { + "target": "com.amazonaws.connect#AssociateDefaultVocabularyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call\n and real-time analysis sessions for the given language.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/default-vocabulary/{InstanceId}/{LanguageCode}", + "code": 200 + } + } + }, + "com.amazonaws.connect#AssociateDefaultVocabularyRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.connect#VocabularyLanguageCode", + "traits": { + "smithy.api#documentation": "

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see \nWhat is Amazon Transcribe?\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VocabularyId": { + "target": "com.amazonaws.connect#VocabularyId", + "traits": { + "smithy.api#documentation": "

The identifier of the custom vocabulary. If this is empty, the default is set to none.

" + } + } + } + }, + "com.amazonaws.connect#AssociateDefaultVocabularyResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.connect#AssociateInstanceStorageConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#AssociateInstanceStorageConfigRequest" + }, + "output": { + "target": "com.amazonaws.connect#AssociateInstanceStorageConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceConflictException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Associates a storage resource type for the first time. You can only associate one type of\n storage configuration in a single call. This means, for example, that you can't define an\n instance with multiple S3 buckets for storing chat transcripts.

\n

This API does not create a resource that doesn't exist. It only associates it to the\n instance. Ensure that the resource being specified in the storage configuration, like an S3\n bucket, exists when being used for association.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/instance/{InstanceId}/storage-config", + "code": 200 + } + } + }, + "com.amazonaws.connect#AssociateInstanceStorageConfigRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.connect#InstanceStorageResourceType", + "traits": { + "smithy.api#documentation": "

A valid resource type.

", + "smithy.api#required": {} + } + }, + "StorageConfig": { + "target": "com.amazonaws.connect#InstanceStorageConfig", + "traits": { + "smithy.api#documentation": "

A valid storage type.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#AssociateInstanceStorageConfigResponse": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.connect#AssociationId", + "traits": { + "smithy.api#documentation": "

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

" + } + } + } + }, + "com.amazonaws.connect#AssociateLambdaFunction": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#AssociateLambdaFunctionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceConflictException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Allows the specified Amazon Connect instance to access the specified Lambda\n function.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/instance/{InstanceId}/lambda-function", + "code": 200 + } + } + }, + "com.amazonaws.connect#AssociateLambdaFunctionRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FunctionArn": { + "target": "com.amazonaws.connect#FunctionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is\n 140.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#AssociateLexBot": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#AssociateLexBotRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceConflictException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Allows the specified Amazon Connect instance to access the specified Amazon Lex bot.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/instance/{InstanceId}/lex-bot", + "code": 200 + } + } + }, + "com.amazonaws.connect#AssociateLexBotRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LexBot": { + "target": "com.amazonaws.connect#LexBot", + "traits": { + "smithy.api#documentation": "

The Amazon Lex bot to associate with the instance.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#AssociatePhoneNumberContactFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#AssociatePhoneNumberContactFlowRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates a flow with a phone number claimed to your Amazon Connect instance.

\n \n

If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the\n Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number\n ARN or UUID value for the PhoneNumberId URI request parameter. However, if the\n number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate\n Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN.\n If a UUID is provided\n in\n this scenario, you will receive a\n ResourceNotFoundException.

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/phone-number/{PhoneNumberId}/contact-flow", + "code": 200 + } + } + }, + "com.amazonaws.connect#AssociatePhoneNumberContactFlowRequest": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the phone number.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The identifier of the flow.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#AssociateQueueQuickConnects": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#AssociateQueueQuickConnectsRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Associates a set of quick connects with a queue.

", + "smithy.api#http": { + "method": "POST", + "uri": "/queues/{InstanceId}/{QueueId}/associate-quick-connects", + "code": 200 + } + } + }, + "com.amazonaws.connect#AssociateQueueQuickConnectsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QueueId": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier for the queue.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QuickConnectIds": { + "target": "com.amazonaws.connect#QuickConnectsList", + "traits": { + "smithy.api#documentation": "

The quick connects to associate with this queue.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#AssociateRoutingProfileQueues": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#AssociateRoutingProfileQueuesRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates a set of queues with a routing profile.

", + "smithy.api#http": { + "method": "POST", + "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/associate-queues", + "code": 200 + } + } + }, + "com.amazonaws.connect#AssociateRoutingProfileQueuesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the routing profile.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QueueConfigs": { + "target": "com.amazonaws.connect#RoutingProfileQueueConfigList", + "traits": { + "smithy.api#documentation": "

The queues to associate with this routing profile.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#AssociateSecurityKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#AssociateSecurityKeyRequest" + }, + "output": { + "target": "com.amazonaws.connect#AssociateSecurityKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceConflictException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Associates a security key to the instance.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/instance/{InstanceId}/security-key", + "code": 200 + } + } + }, + "com.amazonaws.connect#AssociateSecurityKeyRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.connect#PEM", + "traits": { + "smithy.api#documentation": "

A valid security key in PEM format.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#AssociateSecurityKeyResponse": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.connect#AssociationId", + "traits": { + "smithy.api#documentation": "

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

" + } + } + } + }, + "com.amazonaws.connect#AssociationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.connect#AttachmentReference": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#ReferenceKey", + "traits": { + "smithy.api#documentation": "

Identifier of the attachment reference.

" + } + }, + "Value": { + "target": "com.amazonaws.connect#ReferenceValue", + "traits": { + "smithy.api#documentation": "

The location path of the attachment reference.

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

Status of the attachment reference type.

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

Information about a reference when the referenceType is\n ATTACHMENT. Otherwise, null.

" + } + }, + "com.amazonaws.connect#Attribute": { + "type": "structure", + "members": { + "AttributeType": { + "target": "com.amazonaws.connect#InstanceAttributeType", + "traits": { + "smithy.api#documentation": "

The type of attribute.

" + } + }, + "Value": { + "target": "com.amazonaws.connect#InstanceAttributeValue", + "traits": { + "smithy.api#documentation": "

The value of the attribute.

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

A toggle for an individual feature at the instance level.

" + } + }, + "com.amazonaws.connect#AttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32767 + } + } + }, + "com.amazonaws.connect#AttributeValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32767 + } + } + }, + "com.amazonaws.connect#Attributes": { + "type": "map", + "key": { + "target": "com.amazonaws.connect#AttributeName" + }, + "value": { + "target": "com.amazonaws.connect#AttributeValue" + } + }, + "com.amazonaws.connect#AttributesList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#Attribute" + } + }, + "com.amazonaws.connect#AutoAccept": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.connect#AvailableNumberSummary": { + "type": "structure", + "members": { + "PhoneNumber": { + "target": "com.amazonaws.connect#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

" + } + }, + "PhoneNumberCountryCode": { + "target": "com.amazonaws.connect#PhoneNumberCountryCode", + "traits": { + "smithy.api#documentation": "

The ISO country code.

" + } + }, + "PhoneNumberType": { + "target": "com.amazonaws.connect#PhoneNumberType", + "traits": { + "smithy.api#documentation": "

The type of phone number.

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

Information about available phone numbers.

" + } + }, + "com.amazonaws.connect#AvailableNumbersList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#AvailableNumberSummary" + } + }, + "com.amazonaws.connect#AwsRegion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 8, + "max": 31 + }, + "smithy.api#pattern": "^[a-z]{2}(-[a-z]+){1,2}(-[0-9])?$" + } + }, + "com.amazonaws.connect#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.connect#BotName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.connect#BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.connect#CampaignId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.connect#Channel": { + "type": "enum", + "members": { + "VOICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VOICE" + } + }, + "CHAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHAT" + } + }, + "TASK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TASK" + } + } + } + }, + "com.amazonaws.connect#ChannelToCountMap": { + "type": "map", + "key": { + "target": "com.amazonaws.connect#Channel" + }, + "value": { + "target": "com.amazonaws.connect#IntegerCount" + } + }, + "com.amazonaws.connect#Channels": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#Channel" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.connect#ChatContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16384 + } + } + }, + "com.amazonaws.connect#ChatContentType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.connect#ChatDurationInMinutes": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 10080 + } + } + }, + "com.amazonaws.connect#ChatMessage": { + "type": "structure", + "members": { + "ContentType": { + "target": "com.amazonaws.connect#ChatContentType", + "traits": { + "smithy.api#documentation": "

The type of the content. Supported types are text/plain, text/markdown, and application/json.

", + "smithy.api#required": {} + } + }, + "Content": { + "target": "com.amazonaws.connect#ChatContent", + "traits": { + "smithy.api#documentation": "

The content of the chat message.

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

A chat message.

" + } + }, + "com.amazonaws.connect#ChatParticipantRoleConfig": { + "type": "structure", + "members": { + "ParticipantTimerConfigList": { + "target": "com.amazonaws.connect#ParticipantTimerConfigList", + "traits": { + "smithy.api#documentation": "

A list of participant timers. You can specify any unique combination of role and timer type.\n Duplicate entries error out the request with a 400.

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

Configuration information for the chat participant role.

" + } + }, + "com.amazonaws.connect#ChatStreamingConfiguration": { + "type": "structure", + "members": { + "StreamingEndpointArn": { + "target": "com.amazonaws.connect#ChatStreamingEndpointARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the standard Amazon SNS topic. The Amazon Resource Name (ARN) of the streaming endpoint that is used\n to publish real-time message streaming for chat conversations.

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

The streaming configuration, such as the Amazon SNS streaming endpoint.

" + } + }, + "com.amazonaws.connect#ChatStreamingEndpointARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 350 + } + } + }, + "com.amazonaws.connect#ClaimPhoneNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ClaimPhoneNumberRequest" + }, + "output": { + "target": "com.amazonaws.connect#ClaimPhoneNumberResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#IdempotencyException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Claims an available phone number to your Amazon Connect instance or traffic distribution\n group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.

\n

For more information about how to use this operation, see Claim a phone number in your\n country and Claim phone\n numbers to traffic distribution groups in the Amazon Connect Administrator\n Guide.

\n \n

You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API\n to verify the status of a previous ClaimPhoneNumber\n operation.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/phone-number/claim", + "code": 200 + } + } + }, + "com.amazonaws.connect#ClaimPhoneNumberRequest": { + "type": "structure", + "members": { + "TargetArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

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

The phone number you want to claim. Phone numbers are formatted [+] [country code]\n [subscriber number including area code].

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

The description of the phone number.

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

\n

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$\n

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.connect#ClaimPhoneNumberResponse": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the phone number.

" + } + }, + "PhoneNumberArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the phone number.

" + } + } + } + }, + "com.amazonaws.connect#ClaimedPhoneNumberSummary": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the phone number.

" + } + }, + "PhoneNumberArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the phone number.

" + } + }, + "PhoneNumber": { + "target": "com.amazonaws.connect#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

" + } + }, + "PhoneNumberCountryCode": { + "target": "com.amazonaws.connect#PhoneNumberCountryCode", + "traits": { + "smithy.api#documentation": "

The ISO country code.

" + } + }, + "PhoneNumberType": { + "target": "com.amazonaws.connect#PhoneNumberType", + "traits": { + "smithy.api#documentation": "

The type of phone number.

" + } + }, + "PhoneNumberDescription": { + "target": "com.amazonaws.connect#PhoneNumberDescription", + "traits": { + "smithy.api#documentation": "

The description of the phone number.

" + } + }, + "TargetArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" + } + }, + "PhoneNumberStatus": { + "target": "com.amazonaws.connect#PhoneNumberStatus", + "traits": { + "smithy.api#documentation": "

The status of the phone number.

\n \n \n

You will not be billed for the phone number during the 1-day period if number claiming\n fails.

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

Information about a phone number that has been claimed to your Amazon Connect instance\n or traffic distribution group.

" + } + }, + "com.amazonaws.connect#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.connect#CommonNameLength127": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + } + } + }, + "com.amazonaws.connect#Comparison": { + "type": "enum", + "members": { + "LT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LT" + } + } + } + }, + "com.amazonaws.connect#Concurrency": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.connect#Contact": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the contact.

" + } + }, + "Id": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier for the contact.

" + } + }, + "InitialContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

If this contact is related to other contacts, this is the ID of the initial contact.

" + } + }, + "PreviousContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

If this contact is not the first contact, this is the ID of the previous contact.

" + } + }, + "InitiationMethod": { + "target": "com.amazonaws.connect#ContactInitiationMethod", + "traits": { + "smithy.api#documentation": "

Indicates how the contact was initiated.

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

The name of the contact.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#Description", + "traits": { + "smithy.api#documentation": "

The description of the contact.

" + } + }, + "Channel": { + "target": "com.amazonaws.connect#Channel", + "traits": { + "smithy.api#documentation": "

How the contact reached your contact center.

" + } + }, + "QueueInfo": { + "target": "com.amazonaws.connect#QueueInfo", + "traits": { + "smithy.api#documentation": "

If this contact was queued, this contains information about the queue.

" + } + }, + "AgentInfo": { + "target": "com.amazonaws.connect#AgentInfo", + "traits": { + "smithy.api#documentation": "

Information about the agent who accepted the contact.

" + } + }, + "InitiationTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time this contact was initiated, in UTC time. For INBOUND, this is\n when the contact arrived. For OUTBOUND, this is when the agent began dialing. For\n CALLBACK, this is when the callback contact was created. For TRANSFER\n and QUEUE_TRANSFER, this is when the transfer was initiated. For API,\n this is when the request arrived.

" + } + }, + "DisconnectTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the customer endpoint disconnected from Amazon Connect.

" + } + }, + "LastUpdateTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when contact was last updated.

" + } + }, + "ScheduledTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp, in Unix epoch time format, at which to start running the inbound flow.\n

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

Contains information about a contact.

" + } + }, + "com.amazonaws.connect#ContactFilter": { + "type": "structure", + "members": { + "ContactStates": { + "target": "com.amazonaws.connect#ContactStates", + "traits": { + "smithy.api#documentation": "

A list of up to 9 contact states.

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

Filters user data based on the contact information that is associated to the users. It\n contains a list of contact states.

" + } + }, + "com.amazonaws.connect#ContactFlow": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the flow.

" + } + }, + "Id": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

The identifier of the flow.

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

The name of the flow.

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

The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator\n Guide.

" + } + }, + "State": { + "target": "com.amazonaws.connect#ContactFlowState", + "traits": { + "smithy.api#documentation": "

The type of flow.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#ContactFlowDescription", + "traits": { + "smithy.api#documentation": "

The description of the flow.

" + } + }, + "Content": { + "target": "com.amazonaws.connect#ContactFlowContent", + "traits": { + "smithy.api#documentation": "

The content of the flow.

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

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

Contains information about a flow.

" + } + }, + "com.amazonaws.connect#ContactFlowContent": { + "type": "string" + }, + "com.amazonaws.connect#ContactFlowDescription": { + "type": "string" + }, + "com.amazonaws.connect#ContactFlowId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.connect#ContactFlowModule": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN).

" + } + }, + "Id": { + "target": "com.amazonaws.connect#ContactFlowModuleId", + "traits": { + "smithy.api#documentation": "

The identifier of the flow module.

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

The name of the flow module.

" + } + }, + "Content": { + "target": "com.amazonaws.connect#ContactFlowModuleContent", + "traits": { + "smithy.api#documentation": "

The content of the flow module.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#ContactFlowModuleDescription", + "traits": { + "smithy.api#documentation": "

The description of the flow module.

" + } + }, + "State": { + "target": "com.amazonaws.connect#ContactFlowModuleState", + "traits": { + "smithy.api#documentation": "

The type of flow module.

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

The status of the flow module.

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

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

Contains information about a flow module.

" + } + }, + "com.amazonaws.connect#ContactFlowModuleContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256000 + } + } + }, + "com.amazonaws.connect#ContactFlowModuleDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.connect#ContactFlowModuleId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.connect#ContactFlowModuleName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.connect#ContactFlowModuleState": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "ARCHIVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARCHIVED" + } + } + } + }, + "com.amazonaws.connect#ContactFlowModuleStatus": { + "type": "enum", + "members": { + "PUBLISHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUBLISHED" + } + }, + "SAVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAVED" + } + } + } + }, + "com.amazonaws.connect#ContactFlowModuleSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#ContactFlowModuleId", + "traits": { + "smithy.api#documentation": "

The identifier of the flow module.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the flow module.

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

The name of the flow module.

" + } + }, + "State": { + "target": "com.amazonaws.connect#ContactFlowModuleState", + "traits": { + "smithy.api#documentation": "

The type of flow module.

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

Contains summary information about a flow.

" + } + }, + "com.amazonaws.connect#ContactFlowModulesSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ContactFlowModuleSummary" + } + }, + "com.amazonaws.connect#ContactFlowName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.connect#ContactFlowNotPublishedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message" + } + }, + "traits": { + "smithy.api#documentation": "

The flow has not been published.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.connect#ContactFlowState": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "ARCHIVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARCHIVED" + } + } + } + }, + "com.amazonaws.connect#ContactFlowSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

The identifier of the flow.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the flow.

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

The name of the flow.

" + } + }, + "ContactFlowType": { + "target": "com.amazonaws.connect#ContactFlowType", + "traits": { + "smithy.api#documentation": "

The type of flow.

" + } + }, + "ContactFlowState": { + "target": "com.amazonaws.connect#ContactFlowState", + "traits": { + "smithy.api#documentation": "

The type of flow.

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

Contains summary information about a flow.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

" + } + }, + "com.amazonaws.connect#ContactFlowSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ContactFlowSummary" + } + }, + "com.amazonaws.connect#ContactFlowType": { + "type": "enum", + "members": { + "CONTACT_FLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTACT_FLOW" + } + }, + "CUSTOMER_QUEUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOMER_QUEUE" + } + }, + "CUSTOMER_HOLD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOMER_HOLD" + } + }, + "CUSTOMER_WHISPER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOMER_WHISPER" + } + }, + "AGENT_HOLD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENT_HOLD" + } + }, + "AGENT_WHISPER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENT_WHISPER" + } + }, + "OUTBOUND_WHISPER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUTBOUND_WHISPER" + } + }, + "AGENT_TRANSFER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENT_TRANSFER" + } + }, + "QUEUE_TRANSFER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUEUE_TRANSFER" + } + } + } + }, + "com.amazonaws.connect#ContactFlowTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ContactFlowType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.connect#ContactId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.connect#ContactInitiationMethod": { + "type": "enum", + "members": { + "INBOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INBOUND" + } + }, + "OUTBOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUTBOUND" + } + }, + "TRANSFER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSFER" + } + }, + "QUEUE_TRANSFER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUEUE_TRANSFER" + } + }, + "CALLBACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CALLBACK" + } + }, + "API": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "API" + } + }, + "DISCONNECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISCONNECT" + } + }, + "MONITOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONITOR" + } + } + } + }, + "com.amazonaws.connect#ContactNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message", + "traits": { + "smithy.api#documentation": "

The message.

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

The contact with the specified ID is not active or does not exist. Applies to Voice calls\n only, not to Chat, Task, or Voice Callback.

", + "smithy.api#error": "client", + "smithy.api#httpError": 410 + } + }, + "com.amazonaws.connect#ContactReferences": { + "type": "map", + "key": { + "target": "com.amazonaws.connect#ReferenceKey" + }, + "value": { + "target": "com.amazonaws.connect#Reference" + } + }, + "com.amazonaws.connect#ContactState": { + "type": "enum", + "members": { + "INCOMING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCOMING" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "CONNECTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECTING" + } + }, + "CONNECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECTED" + } + }, + "CONNECTED_ONHOLD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECTED_ONHOLD" + } + }, + "MISSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISSED" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "ENDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENDED" + } + }, + "REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REJECTED" + } + } + } + }, + "com.amazonaws.connect#ContactStates": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ContactState" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 9 + } + } + }, + "com.amazonaws.connect#Content": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.connect#ControlPlaneTagFilter": { + "type": "structure", + "members": { + "OrConditions": { + "target": "com.amazonaws.connect#TagOrConditionList", + "traits": { + "smithy.api#documentation": "

A list of conditions which would be applied together with an OR condition.\n

" + } + }, + "AndConditions": { + "target": "com.amazonaws.connect#TagAndConditionList", + "traits": { + "smithy.api#documentation": "

A list of conditions which would be applied together with an AND\n condition.

" + } + }, + "TagCondition": { + "target": "com.amazonaws.connect#TagCondition", + "traits": { + "smithy.api#documentation": "

A leaf node condition which can be used to specify a tag condition.

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

An object that can be used to specify Tag conditions inside the SearchFilter.\n This accepts an OR of AND (List of List) input where:

\n " + } + }, + "com.amazonaws.connect#CreateAgentStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CreateAgentStatusRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateAgentStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Creates an agent status for the specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/agent-status/{InstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#CreateAgentStatusRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#AgentStatusName", + "traits": { + "smithy.api#documentation": "

The name of the status.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.connect#AgentStatusDescription", + "traits": { + "smithy.api#documentation": "

The description of the status.

" + } + }, + "State": { + "target": "com.amazonaws.connect#AgentStatusState", + "traits": { + "smithy.api#documentation": "

The state of the status.

", + "smithy.api#required": {} + } + }, + "DisplayOrder": { + "target": "com.amazonaws.connect#AgentStatusOrderNumber", + "traits": { + "smithy.api#documentation": "

The display order of the status.

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" + } + } + } + }, + "com.amazonaws.connect#CreateAgentStatusResponse": { + "type": "structure", + "members": { + "AgentStatusARN": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agent status.

" + } + }, + "AgentStatusId": { + "target": "com.amazonaws.connect#AgentStatusId", + "traits": { + "smithy.api#documentation": "

The identifier of the agent status.

" + } + } + } + }, + "com.amazonaws.connect#CreateContactFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CreateContactFlowRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateContactFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidContactFlowException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a flow for the specified Amazon Connect instance.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/contact-flows/{InstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#CreateContactFlowModule": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CreateContactFlowModuleRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateContactFlowModuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "target": "com.amazonaws.connect#IdempotencyException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidContactFlowModuleException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a flow module for the specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/contact-flow-modules/{InstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#CreateContactFlowModuleRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#ContactFlowModuleName", + "traits": { + "smithy.api#documentation": "

The name of the flow module.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.connect#ContactFlowModuleDescription", + "traits": { + "smithy.api#documentation": "

The description of the flow module.

" + } + }, + "Content": { + "target": "com.amazonaws.connect#ContactFlowModuleContent", + "traits": { + "smithy.api#documentation": "

The content of the flow module.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.connect#CreateContactFlowModuleResponse": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#ContactFlowModuleId", + "traits": { + "smithy.api#documentation": "

The identifier of the flow module.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the flow module.

" + } + } + } + }, + "com.amazonaws.connect#CreateContactFlowRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#ContactFlowName", + "traits": { + "smithy.api#documentation": "

The name of the flow.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.connect#ContactFlowType", + "traits": { + "smithy.api#documentation": "

The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator\n Guide.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.connect#ContactFlowDescription", + "traits": { + "smithy.api#documentation": "

The description of the flow.

" + } + }, + "Content": { + "target": "com.amazonaws.connect#ContactFlowContent", + "traits": { + "smithy.api#documentation": "

The content of the flow.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" + } + } + } + }, + "com.amazonaws.connect#CreateContactFlowResponse": { + "type": "structure", + "members": { + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

The identifier of the flow.

" + } + }, + "ContactFlowArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the flow.

" + } + } + } + }, + "com.amazonaws.connect#CreateHoursOfOperation": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CreateHoursOfOperationRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateHoursOfOperationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Creates hours of operation.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/hours-of-operations/{InstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#CreateHoursOfOperationRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#CommonNameLength127", + "traits": { + "smithy.api#documentation": "

The name of the hours of operation.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.connect#HoursOfOperationDescription", + "traits": { + "smithy.api#documentation": "

The description of the hours of operation.

" + } + }, + "TimeZone": { + "target": "com.amazonaws.connect#TimeZone", + "traits": { + "smithy.api#documentation": "

The time zone of the hours of operation.

", + "smithy.api#required": {} + } + }, + "Config": { + "target": "com.amazonaws.connect#HoursOfOperationConfigList", + "traits": { + "smithy.api#documentation": "

Configuration information for the hours of operation: day, start time, and end time.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" + } + } + } + }, + "com.amazonaws.connect#CreateHoursOfOperationResponse": { + "type": "structure", + "members": { + "HoursOfOperationId": { + "target": "com.amazonaws.connect#HoursOfOperationId", + "traits": { + "smithy.api#documentation": "

The identifier for the hours of operation.

" + } + }, + "HoursOfOperationArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the hours of operation.

" + } + } + } + }, + "com.amazonaws.connect#CreateInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CreateInstanceRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Initiates an Amazon Connect instance with all the supported channels enabled. It does\n not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It\n also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.

\n

Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. \nIf you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. \nYou must wait 30 days before you can restart creating and deleting instances in your account.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/instance", + "code": 200 + } + } + }, + "com.amazonaws.connect#CreateInstanceRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token.

" + } + }, + "IdentityManagementType": { + "target": "com.amazonaws.connect#DirectoryType", + "traits": { + "smithy.api#documentation": "

The type of identity management for your Amazon Connect users.

", + "smithy.api#required": {} + } + }, + "InstanceAlias": { + "target": "com.amazonaws.connect#DirectoryAlias", + "traits": { + "smithy.api#documentation": "

The name for your instance.

" + } + }, + "DirectoryId": { + "target": "com.amazonaws.connect#DirectoryId", + "traits": { + "smithy.api#documentation": "

The identifier for the directory.

" + } + }, + "InboundCallsEnabled": { + "target": "com.amazonaws.connect#InboundCallsEnabled", + "traits": { + "smithy.api#documentation": "

Your contact center handles incoming contacts.

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

Your contact center allows outbound calls.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#CreateInstanceResponse": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier for the instance.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance.

" + } + } + } + }, + "com.amazonaws.connect#CreateIntegrationAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CreateIntegrationAssociationRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateIntegrationAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon Web Services resource association with an Amazon Connect\n instance.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/instance/{InstanceId}/integration-associations", + "code": 200 + } + } + }, + "com.amazonaws.connect#CreateIntegrationAssociationRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IntegrationType": { + "target": "com.amazonaws.connect#IntegrationType", + "traits": { + "smithy.api#documentation": "

The type of information to be ingested.

", + "smithy.api#required": {} + } + }, + "IntegrationArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the integration.

\n \n

When integrating with Amazon Pinpoint, the Amazon Connect and Amazon Pinpoint\n instances must be in the same account.

\n ", + "smithy.api#required": {} + } + }, + "SourceApplicationUrl": { + "target": "com.amazonaws.connect#URI", + "traits": { + "smithy.api#documentation": "

The URL for the external application. This field is only required for the EVENT integration type.

" + } + }, + "SourceApplicationName": { + "target": "com.amazonaws.connect#SourceApplicationName", + "traits": { + "smithy.api#documentation": "

The name of the external application. This field is only required for the EVENT integration type.

" + } + }, + "SourceType": { + "target": "com.amazonaws.connect#SourceType", + "traits": { + "smithy.api#documentation": "

The type of the data source. This field is only required for the EVENT integration type.

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" + } + } + } + }, + "com.amazonaws.connect#CreateIntegrationAssociationResponse": { + "type": "structure", + "members": { + "IntegrationAssociationId": { + "target": "com.amazonaws.connect#IntegrationAssociationId", + "traits": { + "smithy.api#documentation": "

The identifier for the integration association.

" + } + }, + "IntegrationAssociationArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the association.

" + } + } + } + }, + "com.amazonaws.connect#CreateQueue": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CreateQueueRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateQueueResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Creates a new queue for the specified Amazon Connect instance.

\n \n

If the number being used in the input is claimed to a traffic distribution group, and you are calling this API\n using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use\n either a full phone number ARN or UUID value for the OutboundCallerIdNumberId value\n of the OutboundCallerConfig request body parameter. However, if the number is claimed to a\n traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region\n associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided\n in\n this scenario, you will receive a\n ResourceNotFoundException.

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/queues/{InstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#CreateQueueRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#CommonNameLength127", + "traits": { + "smithy.api#documentation": "

The name of the queue.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.connect#QueueDescription", + "traits": { + "smithy.api#documentation": "

The description of the queue.

" + } + }, + "OutboundCallerConfig": { + "target": "com.amazonaws.connect#OutboundCallerConfig", + "traits": { + "smithy.api#documentation": "

The outbound caller ID name, number, and outbound whisper flow.

" + } + }, + "HoursOfOperationId": { + "target": "com.amazonaws.connect#HoursOfOperationId", + "traits": { + "smithy.api#documentation": "

The identifier for the hours of operation.

", + "smithy.api#required": {} + } + }, + "MaxContacts": { + "target": "com.amazonaws.connect#QueueMaxContacts", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of contacts that can be in the queue before it is considered full.

" + } + }, + "QuickConnectIds": { + "target": "com.amazonaws.connect#QuickConnectsList", + "traits": { + "smithy.api#documentation": "

The quick connects available to agents who are working the queue.

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" + } + } + } + }, + "com.amazonaws.connect#CreateQueueResponse": { + "type": "structure", + "members": { + "QueueArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the queue.

" + } + }, + "QueueId": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier for the queue.

" + } + } + } + }, + "com.amazonaws.connect#CreateQuickConnect": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CreateQuickConnectRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateQuickConnectResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a quick connect for the specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/quick-connects/{InstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#CreateQuickConnectRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#QuickConnectName", + "traits": { + "smithy.api#documentation": "

The name of the quick connect.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.connect#QuickConnectDescription", + "traits": { + "smithy.api#documentation": "

The description of the quick connect.

" + } + }, + "QuickConnectConfig": { + "target": "com.amazonaws.connect#QuickConnectConfig", + "traits": { + "smithy.api#documentation": "

Configuration settings for the quick connect.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" + } + } + } + }, + "com.amazonaws.connect#CreateQuickConnectResponse": { + "type": "structure", + "members": { + "QuickConnectARN": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the quick connect.

" + } + }, + "QuickConnectId": { + "target": "com.amazonaws.connect#QuickConnectId", + "traits": { + "smithy.api#documentation": "

The identifier for the quick connect.

" + } + } + } + }, + "com.amazonaws.connect#CreateRoutingProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CreateRoutingProfileRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateRoutingProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new routing profile.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/routing-profiles/{InstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#CreateRoutingProfileRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#RoutingProfileName", + "traits": { + "smithy.api#documentation": "

The name of the routing profile. Must not be more than 127 characters.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.connect#RoutingProfileDescription", + "traits": { + "smithy.api#documentation": "

Description of the routing profile. Must not be more than 250 characters.

", + "smithy.api#required": {} + } + }, + "DefaultOutboundQueueId": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The default outbound queue for the routing profile.

", + "smithy.api#required": {} + } + }, + "QueueConfigs": { + "target": "com.amazonaws.connect#RoutingProfileQueueConfigList", + "traits": { + "smithy.api#documentation": "

The inbound queues associated with the routing profile. If no queue is added, the agent can\n make only outbound calls.

" + } + }, + "MediaConcurrencies": { + "target": "com.amazonaws.connect#MediaConcurrencies", + "traits": { + "smithy.api#documentation": "

The channels that agents can handle in the Contact Control Panel (CCP) for this routing\n profile.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" + } + } + } + }, + "com.amazonaws.connect#CreateRoutingProfileResponse": { + "type": "structure", + "members": { + "RoutingProfileArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the routing profile.

" + } + }, + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the routing profile.

" + } + } + } + }, + "com.amazonaws.connect#CreateRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CreateRuleRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateRuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceConflictException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a rule for the specified Amazon Connect instance.

\n

Use the Rules Function language to code conditions for the rule.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/rules/{InstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#CreateRuleRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#RuleName", + "traits": { + "smithy.api#documentation": "

A unique name for the rule.

", + "smithy.api#required": {} + } + }, + "TriggerEventSource": { + "target": "com.amazonaws.connect#RuleTriggerEventSource", + "traits": { + "smithy.api#documentation": "

The event source to trigger the rule.

", + "smithy.api#required": {} + } + }, + "Function": { + "target": "com.amazonaws.connect#RuleFunction", + "traits": { + "smithy.api#documentation": "

The conditions of the rule.

", + "smithy.api#required": {} + } + }, + "Actions": { + "target": "com.amazonaws.connect#RuleActions", + "traits": { + "smithy.api#documentation": "

A list of actions to be run when the rule is triggered.

", + "smithy.api#required": {} + } + }, + "PublishStatus": { + "target": "com.amazonaws.connect#RulePublishStatus", + "traits": { + "smithy.api#documentation": "

The publish status of the rule.

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

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.connect#CreateRuleResponse": { + "type": "structure", + "members": { + "RuleArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule.

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

A unique identifier for the rule.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#CreateSecurityProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CreateSecurityProfileRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateSecurityProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Creates a security profile.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/security-profiles/{InstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#CreateSecurityProfileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + }, + "smithy.api#pattern": "^[ a-zA-Z0-9_@-]+$" + } + }, + "com.amazonaws.connect#CreateSecurityProfileRequest": { + "type": "structure", + "members": { + "SecurityProfileName": { + "target": "com.amazonaws.connect#CreateSecurityProfileName", + "traits": { + "smithy.api#documentation": "

The name of the security profile.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.connect#SecurityProfileDescription", + "traits": { + "smithy.api#documentation": "

The description of the security profile.

" + } + }, + "Permissions": { + "target": "com.amazonaws.connect#PermissionsList", + "traits": { + "smithy.api#documentation": "

Permissions assigned to the security profile. For a list of valid permissions, see List of security\n profile permissions.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" + } + }, + "AllowedAccessControlTags": { + "target": "com.amazonaws.connect#AllowedAccessControlTags", + "traits": { + "smithy.api#documentation": "

The list of tags that a security profile uses to restrict access to resources in Amazon Connect.

" + } + }, + "TagRestrictedResources": { + "target": "com.amazonaws.connect#TagRestrictedResourceList", + "traits": { + "smithy.api#documentation": "

The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following are acceptable ResourceNames: User | SecurityProfile | Queue | \n RoutingProfile\n

" + } + } + } + }, + "com.amazonaws.connect#CreateSecurityProfileResponse": { + "type": "structure", + "members": { + "SecurityProfileId": { + "target": "com.amazonaws.connect#SecurityProfileId", + "traits": { + "smithy.api#documentation": "

The identifier for the security profle.

" + } + }, + "SecurityProfileArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the security profile.

" + } + } + } + }, + "com.amazonaws.connect#CreateTaskTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CreateTaskTemplateRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateTaskTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#PropertyValidationException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new task template in the specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/instance/{InstanceId}/task/template", + "code": 200 + } + } + }, + "com.amazonaws.connect#CreateTaskTemplateRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#TaskTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the task template.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.connect#TaskTemplateDescription", + "traits": { + "smithy.api#documentation": "

The description of the task template.

" + } + }, + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

The identifier of the flow that runs by default when a task is created by referencing this template.

" + } + }, + "Constraints": { + "target": "com.amazonaws.connect#TaskTemplateConstraints", + "traits": { + "smithy.api#documentation": "

Constraints that are applicable to the fields listed.

" + } + }, + "Defaults": { + "target": "com.amazonaws.connect#TaskTemplateDefaults", + "traits": { + "smithy.api#documentation": "

The default values for fields when a task is created by referencing this template.

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

Marks a template as ACTIVE or INACTIVE for a task to refer to it. \nTasks can only be created from ACTIVE templates.\nIf a template is marked as INACTIVE, then a task that refers to this template cannot be created.

" + } + }, + "Fields": { + "target": "com.amazonaws.connect#TaskTemplateFields", + "traits": { + "smithy.api#documentation": "

Fields that are part of the template.

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

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.connect#CreateTaskTemplateResponse": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#TaskTemplateId", + "traits": { + "smithy.api#documentation": "

The identifier of the task template resource.

", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.connect#TaskTemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the task template resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#CreateTrafficDistributionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CreateTrafficDistributionGroupRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateTrafficDistributionGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceConflictException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ResourceNotReadyException" + }, + { + "target": "com.amazonaws.connect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a traffic distribution group given an Amazon Connect instance that has been replicated.

\n

For more information about creating traffic distribution groups, see Set up traffic distribution groups in\n the Amazon Connect Administrator Guide.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/traffic-distribution-group", + "code": 200 + } + } + }, + "com.amazonaws.connect#CreateTrafficDistributionGroupRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#Name128", + "traits": { + "smithy.api#documentation": "

The name for the traffic distribution group.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.connect#Description250", + "traits": { + "smithy.api#documentation": "

A description for the traffic distribution group.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceIdOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance that has been replicated. You can find the\n instanceId in the ARN of the instance.

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

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", + "smithy.api#idempotencyToken": {} + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" + } + } + } + }, + "com.amazonaws.connect#CreateTrafficDistributionGroupResponse": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#TrafficDistributionGroupId", + "traits": { + "smithy.api#documentation": "

The identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#TrafficDistributionGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the traffic distribution group.

" + } + } + } + }, + "com.amazonaws.connect#CreateUseCase": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CreateUseCaseRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateUseCaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a use case for an integration association.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases", + "code": 200 + } + } + }, + "com.amazonaws.connect#CreateUseCaseRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IntegrationAssociationId": { + "target": "com.amazonaws.connect#IntegrationAssociationId", + "traits": { + "smithy.api#documentation": "

The identifier for the integration association.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "UseCaseType": { + "target": "com.amazonaws.connect#UseCaseType", + "traits": { + "smithy.api#documentation": "

The type of use case to associate to the integration association. Each integration\n association can have only one of each use case type.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" + } + } + } + }, + "com.amazonaws.connect#CreateUseCaseResponse": { + "type": "structure", + "members": { + "UseCaseId": { + "target": "com.amazonaws.connect#UseCaseId", + "traits": { + "smithy.api#documentation": "

The identifier of the use case.

" + } + }, + "UseCaseArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the use case.

" + } + } + } + }, + "com.amazonaws.connect#CreateUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CreateUserRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a user account for the specified Amazon Connect instance.

\n

For information about how to create user accounts using the Amazon Connect console, see\n Add\n Users in the Amazon Connect Administrator Guide.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/users/{InstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#CreateUserHierarchyGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CreateUserHierarchyGroupRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateUserHierarchyGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new user hierarchy group.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/user-hierarchy-groups/{InstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#CreateUserHierarchyGroupRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#HierarchyGroupName", + "traits": { + "smithy.api#documentation": "

The name of the user hierarchy group. Must not be more than 100 characters.

", + "smithy.api#required": {} + } + }, + "ParentGroupId": { + "target": "com.amazonaws.connect#HierarchyGroupId", + "traits": { + "smithy.api#documentation": "

The identifier for the parent hierarchy group. The user hierarchy is created at level one if\n the parent group ID is null.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" + } + } + } + }, + "com.amazonaws.connect#CreateUserHierarchyGroupResponse": { + "type": "structure", + "members": { + "HierarchyGroupId": { + "target": "com.amazonaws.connect#HierarchyGroupId", + "traits": { + "smithy.api#documentation": "

The identifier of the hierarchy group.

" + } + }, + "HierarchyGroupArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hierarchy group.

" + } + } + } + }, + "com.amazonaws.connect#CreateUserRequest": { + "type": "structure", + "members": { + "Username": { + "target": "com.amazonaws.connect#AgentUsername", + "traits": { + "smithy.api#documentation": "

The user name for the account. For instances not using SAML for identity management, the\n user name can include up to 20 characters. If you are using SAML for identity management, the\n user name can include up to 64 characters from [a-zA-Z0-9_-.\\@]+.

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

The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.

" + } + }, + "IdentityInfo": { + "target": "com.amazonaws.connect#UserIdentityInfo", + "traits": { + "smithy.api#documentation": "

The information about the identity of the user.

" + } + }, + "PhoneConfig": { + "target": "com.amazonaws.connect#UserPhoneConfig", + "traits": { + "smithy.api#documentation": "

The phone settings for the user.

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

The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users.\n If you include the identifier, we assume that Amazon Connect cannot access the directory.\n Otherwise, the identity information is used to authenticate users from your directory.

\n

This parameter is required if you are using an existing directory for identity management in\n Amazon Connect when Amazon Connect cannot access your directory to authenticate users.\n If you are using SAML for identity management and include this parameter, an error is\n returned.

" + } + }, + "SecurityProfileIds": { + "target": "com.amazonaws.connect#SecurityProfileIds", + "traits": { + "smithy.api#documentation": "

The identifier of the security profile for the user.

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

The identifier of the routing profile for the user.

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

The identifier of the hierarchy group for the user.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" + } + } + } + }, + "com.amazonaws.connect#CreateUserResponse": { + "type": "structure", + "members": { + "UserId": { + "target": "com.amazonaws.connect#UserId", + "traits": { + "smithy.api#documentation": "

The identifier of the user account.

" + } + }, + "UserArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user account.

" + } + } + } + }, + "com.amazonaws.connect#CreateVocabulary": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CreateVocabularyRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateVocabularyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceConflictException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a custom vocabulary associated with your Amazon Connect instance. You can set a\n custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default\n vocabulary in post-call and real-time contact analysis sessions for that language.

", + "smithy.api#http": { + "method": "POST", + "uri": "/vocabulary/{InstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#CreateVocabularyRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs. If a create request is received more than once with same client token,\n subsequent requests return the previous response without creating a vocabulary again.

", + "smithy.api#idempotencyToken": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VocabularyName": { + "target": "com.amazonaws.connect#VocabularyName", + "traits": { + "smithy.api#documentation": "

A unique name of the custom vocabulary.

", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.connect#VocabularyLanguageCode", + "traits": { + "smithy.api#documentation": "

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see \nWhat is Amazon Transcribe?\n

", + "smithy.api#required": {} + } + }, + "Content": { + "target": "com.amazonaws.connect#VocabularyContent", + "traits": { + "smithy.api#documentation": "

The content of the custom vocabulary in plain-text format with a table of values. Each row\n in the table represents a word or a phrase, described with Phrase, IPA,\n SoundsLike, and DisplayAs fields. Separate the fields with TAB\n characters. The size limit is 50KB. For more information, see Create a custom\n vocabulary using a table.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" + } + } + } + }, + "com.amazonaws.connect#CreateVocabularyResponse": { + "type": "structure", + "members": { + "VocabularyArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom vocabulary.

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

The identifier of the custom vocabulary.

", + "smithy.api#required": {} + } + }, + "State": { + "target": "com.amazonaws.connect#VocabularyState", + "traits": { + "smithy.api#documentation": "

The current state of the custom vocabulary.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#Credentials": { + "type": "structure", + "members": { + "AccessToken": { + "target": "com.amazonaws.connect#SecurityToken", + "traits": { + "smithy.api#documentation": "

An access token generated for a federated user to access Amazon Connect.

" + } + }, + "AccessTokenExpiration": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

A token generated with an expiration time for the session a user is logged in to Amazon Connect.

" + } + }, + "RefreshToken": { + "target": "com.amazonaws.connect#SecurityToken", + "traits": { + "smithy.api#documentation": "

Renews a token generated for a user to access the Amazon Connect instance.

" + } + }, + "RefreshTokenExpiration": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

Renews the expiration timer for a generated token.

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

Contains credentials to use for federation.

" + } + }, + "com.amazonaws.connect#CurrentMetric": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#CurrentMetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric.

" + } + }, + "Unit": { + "target": "com.amazonaws.connect#Unit", + "traits": { + "smithy.api#documentation": "

The unit for the metric.

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

Contains information about a real-time metric. For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator\n Guide.

" + } + }, + "com.amazonaws.connect#CurrentMetricData": { + "type": "structure", + "members": { + "Metric": { + "target": "com.amazonaws.connect#CurrentMetric", + "traits": { + "smithy.api#documentation": "

Information about the metric.

" + } + }, + "Value": { + "target": "com.amazonaws.connect#Value", + "traits": { + "smithy.api#documentation": "

The value of the metric.

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

Contains the data for a real-time metric.

" + } + }, + "com.amazonaws.connect#CurrentMetricDataCollections": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#CurrentMetricData" + } + }, + "com.amazonaws.connect#CurrentMetricName": { + "type": "enum", + "members": { + "AGENTS_ONLINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENTS_ONLINE" + } + }, + "AGENTS_AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENTS_AVAILABLE" + } + }, + "AGENTS_ON_CALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENTS_ON_CALL" + } + }, + "AGENTS_NON_PRODUCTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENTS_NON_PRODUCTIVE" + } + }, + "AGENTS_AFTER_CONTACT_WORK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENTS_AFTER_CONTACT_WORK" + } + }, + "AGENTS_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENTS_ERROR" + } + }, + "AGENTS_STAFFED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENTS_STAFFED" + } + }, + "CONTACTS_IN_QUEUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTACTS_IN_QUEUE" + } + }, + "OLDEST_CONTACT_AGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OLDEST_CONTACT_AGE" + } + }, + "CONTACTS_SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTACTS_SCHEDULED" + } + }, + "AGENTS_ON_CONTACT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENTS_ON_CONTACT" + } + }, + "SLOTS_ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SLOTS_ACTIVE" + } + }, + "SLOTS_AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SLOTS_AVAILABLE" + } + } + }, + "traits": { + "smithy.api#documentation": "

The current metric names.

" + } + }, + "com.amazonaws.connect#CurrentMetricResult": { + "type": "structure", + "members": { + "Dimensions": { + "target": "com.amazonaws.connect#Dimensions", + "traits": { + "smithy.api#documentation": "

The dimensions for the metrics.

" + } + }, + "Collections": { + "target": "com.amazonaws.connect#CurrentMetricDataCollections", + "traits": { + "smithy.api#documentation": "

The set of metrics.

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

Contains information about a set of real-time metrics.

" + } + }, + "com.amazonaws.connect#CurrentMetricResults": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#CurrentMetricResult" + } + }, + "com.amazonaws.connect#CurrentMetricSortCriteria": { + "type": "structure", + "members": { + "SortByMetric": { + "target": "com.amazonaws.connect#CurrentMetricName" + }, + "SortOrder": { + "target": "com.amazonaws.connect#SortOrder", + "traits": { + "smithy.api#documentation": "

The way to sort.

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

The way to sort the resulting response based on metrics. By default resources are sorted\n based on AGENTS_ONLINE, DESCENDING. The metric collection is sorted\n based on the input metrics.

" + } + }, + "com.amazonaws.connect#CurrentMetricSortCriteriaMaxOne": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#CurrentMetricSortCriteria" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.connect#CurrentMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#CurrentMetric" + } + }, + "com.amazonaws.connect#DateReference": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#ReferenceKey", + "traits": { + "smithy.api#documentation": "

Identifier of the date reference.

" + } + }, + "Value": { + "target": "com.amazonaws.connect#ReferenceValue", + "traits": { + "smithy.api#documentation": "

A valid date.

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

Information about a reference when the referenceType is DATE.\n Otherwise, null.

" + } + }, + "com.amazonaws.connect#DefaultVocabulary": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.connect#VocabularyLanguageCode", + "traits": { + "smithy.api#documentation": "

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see \nWhat is Amazon Transcribe?\n

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

The identifier of the custom vocabulary.

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

A unique name of the custom vocabulary.

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

Contains information about a default vocabulary.

" + } + }, + "com.amazonaws.connect#DefaultVocabularyList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#DefaultVocabulary" + } + }, + "com.amazonaws.connect#Delay": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 9999 + } + } + }, + "com.amazonaws.connect#DeleteContactFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DeleteContactFlowRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a flow for the specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/contact-flows/{InstanceId}/{ContactFlowId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DeleteContactFlowModule": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DeleteContactFlowModuleRequest" + }, + "output": { + "target": "com.amazonaws.connect#DeleteContactFlowModuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified flow module.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DeleteContactFlowModuleRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactFlowModuleId": { + "target": "com.amazonaws.connect#ContactFlowModuleId", + "traits": { + "smithy.api#documentation": "

The identifier of the flow module.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DeleteContactFlowModuleResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.connect#DeleteContactFlowRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

The identifier of the flow.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DeleteHoursOfOperation": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DeleteHoursOfOperationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Deletes an hours of operation.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DeleteHoursOfOperationRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "HoursOfOperationId": { + "target": "com.amazonaws.connect#HoursOfOperationId", + "traits": { + "smithy.api#documentation": "

The identifier for the hours of operation.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DeleteInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DeleteInstanceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Deletes the Amazon Connect instance.

\n

Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. \nIf you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. \nYou must wait 30 days before you can restart creating and deleting instances in your account.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/instance/{InstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DeleteInstanceRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DeleteIntegrationAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DeleteIntegrationAssociationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Amazon Web Services resource association from an Amazon Connect instance. The\n association must not have any use cases associated with it.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DeleteIntegrationAssociationRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IntegrationAssociationId": { + "target": "com.amazonaws.connect#IntegrationAssociationId", + "traits": { + "smithy.api#documentation": "

The identifier for the integration association.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DeleteQuickConnect": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DeleteQuickConnectRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a quick connect.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/quick-connects/{InstanceId}/{QuickConnectId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DeleteQuickConnectRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QuickConnectId": { + "target": "com.amazonaws.connect#QuickConnectId", + "traits": { + "smithy.api#documentation": "

The identifier for the quick connect.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DeleteRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DeleteRuleRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a rule for the specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/rules/{InstanceId}/{RuleId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DeleteRuleRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RuleId": { + "target": "com.amazonaws.connect#RuleId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the rule.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DeleteSecurityProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DeleteSecurityProfileRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceInUseException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Deletes a security profile.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/security-profiles/{InstanceId}/{SecurityProfileId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DeleteSecurityProfileRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SecurityProfileId": { + "target": "com.amazonaws.connect#SecurityProfileId", + "traits": { + "smithy.api#documentation": "

The identifier for the security profle.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DeleteTaskTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DeleteTaskTemplateRequest" + }, + "output": { + "target": "com.amazonaws.connect#DeleteTaskTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the task template.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/instance/{InstanceId}/task/template/{TaskTemplateId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DeleteTaskTemplateRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TaskTemplateId": { + "target": "com.amazonaws.connect#TaskTemplateId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the task template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DeleteTaskTemplateResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.connect#DeleteTrafficDistributionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DeleteTrafficDistributionGroupRequest" + }, + "output": { + "target": "com.amazonaws.connect#DeleteTrafficDistributionGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceInUseException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is\n created.

\n

For more information about deleting traffic distribution groups, see Delete traffic distribution groups in\n the Amazon Connect Administrator Guide.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/traffic-distribution-group/{TrafficDistributionGroupId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DeleteTrafficDistributionGroupRequest": { + "type": "structure", + "members": { + "TrafficDistributionGroupId": { + "target": "com.amazonaws.connect#TrafficDistributionGroupIdOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DeleteTrafficDistributionGroupResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.connect#DeleteUseCase": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DeleteUseCaseRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a use case from an integration association.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases/{UseCaseId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DeleteUseCaseRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IntegrationAssociationId": { + "target": "com.amazonaws.connect#IntegrationAssociationId", + "traits": { + "smithy.api#documentation": "

The identifier for the integration association.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "UseCaseId": { + "target": "com.amazonaws.connect#UseCaseId", + "traits": { + "smithy.api#documentation": "

The identifier for the use case.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DeleteUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DeleteUserRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a user account from the specified Amazon Connect instance.

\n

For information about what happens to a user's data when their account is deleted, see\n Delete Users from\n Your Amazon Connect Instance in the Amazon Connect Administrator\n Guide.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/users/{InstanceId}/{UserId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DeleteUserHierarchyGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DeleteUserHierarchyGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceInUseException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an existing user hierarchy group. It must not be associated with any agents or have\n any active child groups.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DeleteUserHierarchyGroupRequest": { + "type": "structure", + "members": { + "HierarchyGroupId": { + "target": "com.amazonaws.connect#HierarchyGroupId", + "traits": { + "smithy.api#documentation": "

The identifier of the hierarchy group.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DeleteUserRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "UserId": { + "target": "com.amazonaws.connect#UserId", + "traits": { + "smithy.api#documentation": "

The identifier of the user.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DeleteVocabulary": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DeleteVocabularyRequest" + }, + "output": { + "target": "com.amazonaws.connect#DeleteVocabularyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceInUseException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the vocabulary that has the given identifier.

", + "smithy.api#http": { + "method": "POST", + "uri": "/vocabulary-remove/{InstanceId}/{VocabularyId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DeleteVocabularyRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VocabularyId": { + "target": "com.amazonaws.connect#VocabularyId", + "traits": { + "smithy.api#documentation": "

The identifier of the custom vocabulary.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DeleteVocabularyResponse": { + "type": "structure", + "members": { + "VocabularyArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom vocabulary.

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

The identifier of the custom vocabulary.

", + "smithy.api#required": {} + } + }, + "State": { + "target": "com.amazonaws.connect#VocabularyState", + "traits": { + "smithy.api#documentation": "

The current state of the custom vocabulary.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribeAgentStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeAgentStatusRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeAgentStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Describes an agent status.

", + "smithy.api#http": { + "method": "GET", + "uri": "/agent-status/{InstanceId}/{AgentStatusId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribeAgentStatusRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AgentStatusId": { + "target": "com.amazonaws.connect#AgentStatusId", + "traits": { + "smithy.api#documentation": "

The identifier for the agent status.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribeAgentStatusResponse": { + "type": "structure", + "members": { + "AgentStatus": { + "target": "com.amazonaws.connect#AgentStatus", + "traits": { + "smithy.api#documentation": "

The agent status.

" + } + } + } + }, + "com.amazonaws.connect#DescribeContact": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeContactRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeContactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Describes the specified contact.

\n \n

Contact information remains available in Amazon Connect for 24 months, and then it is\n deleted.

\n

Only data from November 12, 2021, and later is returned by this\n API.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/contacts/{InstanceId}/{ContactId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribeContactFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeContactFlowRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeContactFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#ContactFlowNotPublishedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the specified flow.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

", + "smithy.api#http": { + "method": "GET", + "uri": "/contact-flows/{InstanceId}/{ContactFlowId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribeContactFlowModule": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeContactFlowModuleRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeContactFlowModuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the specified flow module.

", + "smithy.api#http": { + "method": "GET", + "uri": "/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribeContactFlowModuleRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactFlowModuleId": { + "target": "com.amazonaws.connect#ContactFlowModuleId", + "traits": { + "smithy.api#documentation": "

The identifier of the flow module.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribeContactFlowModuleResponse": { + "type": "structure", + "members": { + "ContactFlowModule": { + "target": "com.amazonaws.connect#ContactFlowModule", + "traits": { + "smithy.api#documentation": "

Information about the flow module.

" + } + } + } + }, + "com.amazonaws.connect#DescribeContactFlowRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

The identifier of the flow.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribeContactFlowResponse": { + "type": "structure", + "members": { + "ContactFlow": { + "target": "com.amazonaws.connect#ContactFlow", + "traits": { + "smithy.api#documentation": "

Information about the flow.

" + } + } + } + }, + "com.amazonaws.connect#DescribeContactRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribeContactResponse": { + "type": "structure", + "members": { + "Contact": { + "target": "com.amazonaws.connect#Contact", + "traits": { + "smithy.api#documentation": "

Information about the contact.

" + } + } + } + }, + "com.amazonaws.connect#DescribeHoursOfOperation": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeHoursOfOperationRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeHoursOfOperationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Describes the hours of operation.

", + "smithy.api#http": { + "method": "GET", + "uri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribeHoursOfOperationRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "HoursOfOperationId": { + "target": "com.amazonaws.connect#HoursOfOperationId", + "traits": { + "smithy.api#documentation": "

The identifier for the hours of operation.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribeHoursOfOperationResponse": { + "type": "structure", + "members": { + "HoursOfOperation": { + "target": "com.amazonaws.connect#HoursOfOperation", + "traits": { + "smithy.api#documentation": "

The hours of operation.

" + } + } + } + }, + "com.amazonaws.connect#DescribeInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeInstanceRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Returns the current state of the specified instance identifier. It tracks the instance while\n it is being created and returns an error status, if applicable.

\n

If an instance is not created successfully, the instance status reason field returns details\n relevant to the reason. The instance in a failed state is returned only for 24 hours after the\n CreateInstance API was invoked.

", + "smithy.api#http": { + "method": "GET", + "uri": "/instance/{InstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribeInstanceAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeInstanceAttributeRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeInstanceAttributeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Describes the specified instance attribute.

", + "smithy.api#http": { + "method": "GET", + "uri": "/instance/{InstanceId}/attribute/{AttributeType}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribeInstanceAttributeRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AttributeType": { + "target": "com.amazonaws.connect#InstanceAttributeType", + "traits": { + "smithy.api#documentation": "

The type of attribute.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribeInstanceAttributeResponse": { + "type": "structure", + "members": { + "Attribute": { + "target": "com.amazonaws.connect#Attribute", + "traits": { + "smithy.api#documentation": "

The\n type\n of attribute.

" + } + } + } + }, + "com.amazonaws.connect#DescribeInstanceRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribeInstanceResponse": { + "type": "structure", + "members": { + "Instance": { + "target": "com.amazonaws.connect#Instance", + "traits": { + "smithy.api#documentation": "

The name of the instance.

" + } + } + } + }, + "com.amazonaws.connect#DescribeInstanceStorageConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeInstanceStorageConfigRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeInstanceStorageConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Retrieves the current storage configurations for the specified resource type, association\n ID, and instance ID.

", + "smithy.api#http": { + "method": "GET", + "uri": "/instance/{InstanceId}/storage-config/{AssociationId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribeInstanceStorageConfigRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssociationId": { + "target": "com.amazonaws.connect#AssociationId", + "traits": { + "smithy.api#documentation": "

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.connect#InstanceStorageResourceType", + "traits": { + "smithy.api#documentation": "

A valid resource type.

", + "smithy.api#httpQuery": "resourceType", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribeInstanceStorageConfigResponse": { + "type": "structure", + "members": { + "StorageConfig": { + "target": "com.amazonaws.connect#InstanceStorageConfig", + "traits": { + "smithy.api#documentation": "

A valid storage type.

" + } + } + } + }, + "com.amazonaws.connect#DescribePhoneNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribePhoneNumberRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribePhoneNumberResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets details and status of a phone number thatā€™s claimed to your Amazon Connect instance\n or traffic distribution group.

\n \n

If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region\n where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the\n PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group\n and you are calling this API in the alternate Amazon Web Services Region associated with the\n traffic distribution group, you must provide a full phone number ARN. If a UUID is provided\n in\n this scenario, you will receive a\n ResourceNotFoundException.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/phone-number/{PhoneNumberId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribePhoneNumberRequest": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the phone number.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribePhoneNumberResponse": { + "type": "structure", + "members": { + "ClaimedPhoneNumberSummary": { + "target": "com.amazonaws.connect#ClaimedPhoneNumberSummary", + "traits": { + "smithy.api#documentation": "

Information about a phone number that's been claimed to your Amazon Connect instance or\n traffic distribution group.

" + } + } + } + }, + "com.amazonaws.connect#DescribeQueue": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeQueueRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeQueueResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Describes the specified queue.

", + "smithy.api#http": { + "method": "GET", + "uri": "/queues/{InstanceId}/{QueueId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribeQueueRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QueueId": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier for the queue.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribeQueueResponse": { + "type": "structure", + "members": { + "Queue": { + "target": "com.amazonaws.connect#Queue", + "traits": { + "smithy.api#documentation": "

The name of the queue.

" + } + } + } + }, + "com.amazonaws.connect#DescribeQuickConnect": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeQuickConnectRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeQuickConnectResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the quick connect.

", + "smithy.api#http": { + "method": "GET", + "uri": "/quick-connects/{InstanceId}/{QuickConnectId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribeQuickConnectRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QuickConnectId": { + "target": "com.amazonaws.connect#QuickConnectId", + "traits": { + "smithy.api#documentation": "

The identifier for the quick connect.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribeQuickConnectResponse": { + "type": "structure", + "members": { + "QuickConnect": { + "target": "com.amazonaws.connect#QuickConnect", + "traits": { + "smithy.api#documentation": "

Information about the quick connect.

" + } + } + } + }, + "com.amazonaws.connect#DescribeRoutingProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeRoutingProfileRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeRoutingProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the specified routing profile.

", + "smithy.api#http": { + "method": "GET", + "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribeRoutingProfileRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the routing profile.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribeRoutingProfileResponse": { + "type": "structure", + "members": { + "RoutingProfile": { + "target": "com.amazonaws.connect#RoutingProfile", + "traits": { + "smithy.api#documentation": "

The routing profile.

" + } + } + } + }, + "com.amazonaws.connect#DescribeRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeRuleRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeRuleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a rule for the specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "GET", + "uri": "/rules/{InstanceId}/{RuleId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribeRuleRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RuleId": { + "target": "com.amazonaws.connect#RuleId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the rule.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribeRuleResponse": { + "type": "structure", + "members": { + "Rule": { + "target": "com.amazonaws.connect#Rule", + "traits": { + "smithy.api#documentation": "

Information about the rule.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribeSecurityProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeSecurityProfileRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeSecurityProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Gets basic information about the security profle.

", + "smithy.api#http": { + "method": "GET", + "uri": "/security-profiles/{InstanceId}/{SecurityProfileId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribeSecurityProfileRequest": { + "type": "structure", + "members": { + "SecurityProfileId": { + "target": "com.amazonaws.connect#SecurityProfileId", + "traits": { + "smithy.api#documentation": "

The identifier for the security profle.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribeSecurityProfileResponse": { + "type": "structure", + "members": { + "SecurityProfile": { + "target": "com.amazonaws.connect#SecurityProfile", + "traits": { + "smithy.api#documentation": "

The security profile.

" + } + } + } + }, + "com.amazonaws.connect#DescribeTrafficDistributionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeTrafficDistributionGroupRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeTrafficDistributionGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets details and status of a traffic distribution group.

", + "smithy.api#http": { + "method": "GET", + "uri": "/traffic-distribution-group/{TrafficDistributionGroupId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribeTrafficDistributionGroupRequest": { + "type": "structure", + "members": { + "TrafficDistributionGroupId": { + "target": "com.amazonaws.connect#TrafficDistributionGroupIdOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribeTrafficDistributionGroupResponse": { + "type": "structure", + "members": { + "TrafficDistributionGroup": { + "target": "com.amazonaws.connect#TrafficDistributionGroup", + "traits": { + "smithy.api#documentation": "

Information about the traffic distribution group.

" + } + } + } + }, + "com.amazonaws.connect#DescribeUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeUserRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the specified user account. You can find the instance ID in the console (itā€™s the\n final part of the ARN). The console does not display the user IDs. Instead, list the users and\n note the IDs provided in the output.

", + "smithy.api#http": { + "method": "GET", + "uri": "/users/{InstanceId}/{UserId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribeUserHierarchyGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeUserHierarchyGroupRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeUserHierarchyGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the specified hierarchy group.

", + "smithy.api#http": { + "method": "GET", + "uri": "/user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribeUserHierarchyGroupRequest": { + "type": "structure", + "members": { + "HierarchyGroupId": { + "target": "com.amazonaws.connect#HierarchyGroupId", + "traits": { + "smithy.api#documentation": "

The identifier of the hierarchy group.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribeUserHierarchyGroupResponse": { + "type": "structure", + "members": { + "HierarchyGroup": { + "target": "com.amazonaws.connect#HierarchyGroup", + "traits": { + "smithy.api#documentation": "

Information about the hierarchy group.

" + } + } + } + }, + "com.amazonaws.connect#DescribeUserHierarchyStructure": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeUserHierarchyStructureRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeUserHierarchyStructureResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the hierarchy structure of the specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "GET", + "uri": "/user-hierarchy-structure/{InstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribeUserHierarchyStructureRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribeUserHierarchyStructureResponse": { + "type": "structure", + "members": { + "HierarchyStructure": { + "target": "com.amazonaws.connect#HierarchyStructure", + "traits": { + "smithy.api#documentation": "

Information about the hierarchy structure.

" + } + } + } + }, + "com.amazonaws.connect#DescribeUserRequest": { + "type": "structure", + "members": { + "UserId": { + "target": "com.amazonaws.connect#UserId", + "traits": { + "smithy.api#documentation": "

The identifier of the user account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribeUserResponse": { + "type": "structure", + "members": { + "User": { + "target": "com.amazonaws.connect#User", + "traits": { + "smithy.api#documentation": "

Information about the user account and configuration settings.

" + } + } + } + }, + "com.amazonaws.connect#DescribeVocabulary": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeVocabularyRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeVocabularyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the specified vocabulary.

", + "smithy.api#http": { + "method": "GET", + "uri": "/vocabulary/{InstanceId}/{VocabularyId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribeVocabularyRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VocabularyId": { + "target": "com.amazonaws.connect#VocabularyId", + "traits": { + "smithy.api#documentation": "

The identifier of the custom vocabulary.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribeVocabularyResponse": { + "type": "structure", + "members": { + "Vocabulary": { + "target": "com.amazonaws.connect#Vocabulary", + "traits": { + "smithy.api#documentation": "

A list of specific words that you want Contact Lens for Amazon Connect to recognize in your audio input. They are\n generally domain-specific words and phrases, words that Contact Lens is not recognizing, or proper\n nouns.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + } + } + }, + "com.amazonaws.connect#Description250": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 250 + }, + "smithy.api#pattern": "^(^[\\S].*[\\S]$)|(^[\\S]$)$" + } + }, + "com.amazonaws.connect#DestinationNotAllowedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message", + "traits": { + "smithy.api#documentation": "

The message about the outbound calls.

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

Outbound calls to the destination number are not allowed.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.connect#Dimensions": { + "type": "structure", + "members": { + "Queue": { + "target": "com.amazonaws.connect#QueueReference", + "traits": { + "smithy.api#documentation": "

Information about the queue for which metrics are returned.

" + } + }, + "Channel": { + "target": "com.amazonaws.connect#Channel", + "traits": { + "smithy.api#documentation": "

The channel used for grouping and filters.

" + } + }, + "RoutingProfile": { + "target": "com.amazonaws.connect#RoutingProfileReference" + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the dimensions for a set of metrics.

" + } + }, + "com.amazonaws.connect#DirectoryAlias": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 62 + }, + "smithy.api#pattern": "^(?!d-)([\\da-zA-Z]+)([-]*[\\da-zA-Z])*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.connect#DirectoryId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^d-[0-9a-f]{10}$" + } + }, + "com.amazonaws.connect#DirectoryType": { + "type": "enum", + "members": { + "SAML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAML" + } + }, + "CONNECT_MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECT_MANAGED" + } + }, + "EXISTING_DIRECTORY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXISTING_DIRECTORY" + } + } + } + }, + "com.amazonaws.connect#DirectoryUserId": { + "type": "string" + }, + "com.amazonaws.connect#DisassociateApprovedOrigin": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DisassociateApprovedOriginRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Revokes access to integrated applications from Amazon Connect.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/instance/{InstanceId}/approved-origin", + "code": 200 + } + } + }, + "com.amazonaws.connect#DisassociateApprovedOriginRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Origin": { + "target": "com.amazonaws.connect#Origin", + "traits": { + "smithy.api#documentation": "

The domain URL of the integrated application.

", + "smithy.api#httpQuery": "origin", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DisassociateBot": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DisassociateBotRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2\n bot.

", + "smithy.api#http": { + "method": "POST", + "uri": "/instance/{InstanceId}/bot", + "code": 200 + } + } + }, + "com.amazonaws.connect#DisassociateBotRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LexBot": { + "target": "com.amazonaws.connect#LexBot" + }, + "LexV2Bot": { + "target": "com.amazonaws.connect#LexV2Bot", + "traits": { + "smithy.api#documentation": "

The Amazon Lex V2 bot to disassociate from the instance.

" + } + } + } + }, + "com.amazonaws.connect#DisassociateInstanceStorageConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DisassociateInstanceStorageConfigRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Removes the storage type configurations for the specified resource type and association\n ID.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/instance/{InstanceId}/storage-config/{AssociationId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DisassociateInstanceStorageConfigRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssociationId": { + "target": "com.amazonaws.connect#AssociationId", + "traits": { + "smithy.api#documentation": "

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.connect#InstanceStorageResourceType", + "traits": { + "smithy.api#documentation": "

A valid resource type.

", + "smithy.api#httpQuery": "resourceType", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DisassociateLambdaFunction": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DisassociateLambdaFunctionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Remove the Lambda function from the dropdown options available in the relevant flow\n blocks.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/instance/{InstanceId}/lambda-function", + "code": 200 + } + } + }, + "com.amazonaws.connect#DisassociateLambdaFunctionRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance..

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FunctionArn": { + "target": "com.amazonaws.connect#FunctionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lambda function being disassociated.

", + "smithy.api#httpQuery": "functionArn", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DisassociateLexBot": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DisassociateLexBotRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Revokes authorization from the specified instance to access the specified Amazon Lex bot.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/instance/{InstanceId}/lex-bot", + "code": 200 + } + } + }, + "com.amazonaws.connect#DisassociateLexBotRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BotName": { + "target": "com.amazonaws.connect#BotName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Lex bot. Maximum character limit of 50.

", + "smithy.api#httpQuery": "botName", + "smithy.api#required": {} + } + }, + "LexRegion": { + "target": "com.amazonaws.connect#LexRegion", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region in which the Amazon Lex bot has been created.

", + "smithy.api#httpQuery": "lexRegion", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DisassociatePhoneNumberContactFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DisassociatePhoneNumberContactFlowRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the flow association from a phone number claimed to your Amazon Connect\n instance.

\n \n

If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the\n Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number\n ARN or UUID value for the PhoneNumberId URI request parameter. However, if the\n number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate\n Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN.\n If a UUID is provided in this scenario, you will receive a\n ResourceNotFoundException.

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/phone-number/{PhoneNumberId}/contact-flow", + "code": 200 + } + } + }, + "com.amazonaws.connect#DisassociatePhoneNumberContactFlowRequest": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the phone number.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpQuery": "instanceId", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DisassociateQueueQuickConnects": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DisassociateQueueQuickConnectsRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Disassociates a set of quick connects from a queue.

", + "smithy.api#http": { + "method": "POST", + "uri": "/queues/{InstanceId}/{QueueId}/disassociate-quick-connects", + "code": 200 + } + } + }, + "com.amazonaws.connect#DisassociateQueueQuickConnectsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QueueId": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier for the queue.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QuickConnectIds": { + "target": "com.amazonaws.connect#QuickConnectsList", + "traits": { + "smithy.api#documentation": "

The quick connects to disassociate from the queue.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DisassociateRoutingProfileQueues": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DisassociateRoutingProfileQueuesRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates a set of queues from a routing profile.

", + "smithy.api#http": { + "method": "POST", + "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/disassociate-queues", + "code": 200 + } + } + }, + "com.amazonaws.connect#DisassociateRoutingProfileQueuesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the routing profile.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QueueReferences": { + "target": "com.amazonaws.connect#RoutingProfileQueueReferenceList", + "traits": { + "smithy.api#documentation": "

The queues to disassociate from this routing profile.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DisassociateSecurityKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DisassociateSecurityKeyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Deletes the specified security key.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/instance/{InstanceId}/security-key/{AssociationId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DisassociateSecurityKeyRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssociationId": { + "target": "com.amazonaws.connect#AssociationId", + "traits": { + "smithy.api#documentation": "

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DismissUserContact": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DismissUserContactRequest" + }, + "output": { + "target": "com.amazonaws.connect#DismissUserContactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Dismisses contacts from an agentā€™s CCP and returns the agent to an available state, which\n allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a\n MISSED, ERROR, ENDED, or REJECTED state in\n the Agent\n Event Stream.

", + "smithy.api#http": { + "method": "POST", + "uri": "/users/{InstanceId}/{UserId}/contact", + "code": 200 + } + } + }, + "com.amazonaws.connect#DismissUserContactRequest": { + "type": "structure", + "members": { + "UserId": { + "target": "com.amazonaws.connect#UserId", + "traits": { + "smithy.api#documentation": "

The identifier of the user account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the\n instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DismissUserContactResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.connect#DisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.connect#Distribution": { + "type": "structure", + "members": { + "Region": { + "target": "com.amazonaws.connect#AwsRegion", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region where the traffic is distributed.

", + "smithy.api#required": {} + } + }, + "Percentage": { + "target": "com.amazonaws.connect#Percentage", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The percentage of the traffic that is distributed, in increments of 10.

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

Information about a traffic distribution.

" + } + }, + "com.amazonaws.connect#DistributionList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#Distribution" + } + }, + "com.amazonaws.connect#DuplicateResourceException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message" + } + }, + "traits": { + "smithy.api#documentation": "

A resource with the specified name already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.connect#Email": { + "type": "string" + }, + "com.amazonaws.connect#EmailReference": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#ReferenceKey", + "traits": { + "smithy.api#documentation": "

Identifier of the email reference.

" + } + }, + "Value": { + "target": "com.amazonaws.connect#ReferenceValue", + "traits": { + "smithy.api#documentation": "

A valid email address.

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

Information about a reference when the referenceType is EMAIL.\n Otherwise, null.

" + } + }, + "com.amazonaws.connect#EncryptionConfig": { + "type": "structure", + "members": { + "EncryptionType": { + "target": "com.amazonaws.connect#EncryptionType", + "traits": { + "smithy.api#documentation": "

The type of encryption.

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

The full ARN of the encryption key.

\n \n

Be sure to provide the full ARN of the encryption key, not just the ID.

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

The encryption configuration.

" + } + }, + "com.amazonaws.connect#EncryptionType": { + "type": "enum", + "members": { + "KMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KMS" + } + } + } + }, + "com.amazonaws.connect#EventBridgeActionDefinition": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#EventBridgeActionName", + "traits": { + "smithy.api#documentation": "

The name.

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

The EventBridge action definition.

" + } + }, + "com.amazonaws.connect#EventBridgeActionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.connect#EventSourceName": { + "type": "enum", + "members": { + "OnPostCallAnalysisAvailable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OnPostCallAnalysisAvailable" + } + }, + "OnRealTimeCallAnalysisAvailable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OnRealTimeCallAnalysisAvailable" + } + }, + "OnPostChatAnalysisAvailable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OnPostChatAnalysisAvailable" + } + }, + "OnZendeskTicketCreate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OnZendeskTicketCreate" + } + }, + "OnZendeskTicketStatusUpdate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OnZendeskTicketStatusUpdate" + } + }, + "OnSalesforceCaseCreate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OnSalesforceCaseCreate" + } + } + } + }, + "com.amazonaws.connect#Filters": { + "type": "structure", + "members": { + "Queues": { + "target": "com.amazonaws.connect#Queues", + "traits": { + "smithy.api#documentation": "

The queues to use to filter the metrics. You should specify at least one queue, and can\n specify up to 100 queues per request. The GetCurrentMetricsData API in particular\n requires a queue when you include a Filter in your request.

" + } + }, + "Channels": { + "target": "com.amazonaws.connect#Channels", + "traits": { + "smithy.api#documentation": "

The channel to use to filter the metrics.

" + } + }, + "RoutingProfiles": { + "target": "com.amazonaws.connect#RoutingProfiles", + "traits": { + "smithy.api#documentation": "

A list of up to 100 routing profile IDs or ARNs.

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

Contains the filter to apply when retrieving metrics.

" + } + }, + "com.amazonaws.connect#FunctionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 140 + } + } + }, + "com.amazonaws.connect#FunctionArnsList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#FunctionArn" + } + }, + "com.amazonaws.connect#GetContactAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#GetContactAttributesRequest" + }, + "output": { + "target": "com.amazonaws.connect#GetContactAttributesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the contact attributes for the specified contact.

", + "smithy.api#http": { + "method": "GET", + "uri": "/contact/attributes/{InstanceId}/{InitialContactId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#GetContactAttributesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InitialContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the initial contact.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#GetContactAttributesResponse": { + "type": "structure", + "members": { + "Attributes": { + "target": "com.amazonaws.connect#Attributes", + "traits": { + "smithy.api#documentation": "

Information about the attributes.

" + } + } + } + }, + "com.amazonaws.connect#GetCurrentMetricData": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#GetCurrentMetricDataRequest" + }, + "output": { + "target": "com.amazonaws.connect#GetCurrentMetricDataResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the real-time metric data from the specified Amazon Connect instance.

\n

For a description of each metric, see Real-time Metrics\n Definitions in the Amazon Connect Administrator Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/metrics/current/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#GetCurrentMetricDataRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.connect#Filters", + "traits": { + "smithy.api#documentation": "

The filters to apply to returned metrics. You can filter up to the following limits:

\n \n

Metric data is retrieved only for the resources associated with the queues or routing\n profiles, and by any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource IDs and resource ARNs in the same request.

\n

Currently tagging is only supported on the resources that are passed in the filter.

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

The grouping applied to the metrics returned. For example, when grouped by\n QUEUE, the metrics returned apply to each queue rather than aggregated for all\n queues.

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

The metrics to retrieve. Specify the name and unit for each metric. The following metrics\n are available. For a description of all the metrics, see Real-time Metrics\n Definitions in the Amazon Connect Administrator Guide.

\n
\n
AGENTS_AFTER_CONTACT_WORK
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: ACW\n

\n
\n
AGENTS_AVAILABLE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Available\n

\n
\n
AGENTS_ERROR
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Error\n

\n
\n
AGENTS_NON_PRODUCTIVE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: NPT (Non-Productive Time)\n

\n
\n
AGENTS_ON_CALL
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: On\n contact\n

\n
\n
AGENTS_ON_CONTACT
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: On\n contact\n

\n
\n
AGENTS_ONLINE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Online\n

\n
\n
AGENTS_STAFFED
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Staffed\n

\n
\n
CONTACTS_IN_QUEUE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: In\n queue\n

\n
\n
CONTACTS_SCHEDULED
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Scheduled\n

\n
\n
OLDEST_CONTACT_AGE
\n
\n

Unit: SECONDS

\n

When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.

\n

When you do not use groupings, Unit says SECONDS but the Value is returned in\n MILLISECONDS. For example, if you get a response like this:

\n

\n { \"Metric\": { \"Name\": \"OLDEST_CONTACT_AGE\", \"Unit\": \"SECONDS\" }, \"Value\": 24113.0\n }

\n

The actual OLDEST_CONTACT_AGE is 24 seconds.

\n

Name in real-time metrics report: Oldest\n

\n
\n
SLOTS_ACTIVE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Active\n

\n
\n
SLOTS_AVAILABLE
\n
\n

Unit: COUNT

\n

Name in real-time metrics report: Availability\n

\n
\n
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

\n

The token expires after 5 minutes from the time it is created. Subsequent requests that use\n the token must use the same request parameters as the request that generated the token.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page.

" + } + }, + "SortCriteria": { + "target": "com.amazonaws.connect#CurrentMetricSortCriteriaMaxOne", + "traits": { + "smithy.api#documentation": "

The way to sort the resulting response based on metrics. You can enter one sort criteria. By\n default resources are sorted based on AGENTS_ONLINE, DESCENDING. The\n metric collection is sorted based on the input metrics.

\n

Note the following:

\n " + } + } + } + }, + "com.amazonaws.connect#GetCurrentMetricDataResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

\n

The token expires after 5 minutes from the time it is created. Subsequent requests that use\n the token must use the same request parameters as the request that generated the token.

" + } + }, + "MetricResults": { + "target": "com.amazonaws.connect#CurrentMetricResults", + "traits": { + "smithy.api#documentation": "

Information about the real-time metrics.

" + } + }, + "DataSnapshotTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the metrics were retrieved and cached for pagination.

" + } + }, + "ApproximateTotalCount": { + "target": "com.amazonaws.connect#ApproximateTotalCount", + "traits": { + "smithy.api#documentation": "

The total count of the result, regardless of the current page size.

" + } + } + } + }, + "com.amazonaws.connect#GetCurrentUserData": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#GetCurrentUserDataRequest" + }, + "output": { + "target": "com.amazonaws.connect#GetCurrentUserDataResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the real-time active user data from the specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "POST", + "uri": "/metrics/userdata/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#GetCurrentUserDataRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.connect#UserDataFilters", + "traits": { + "smithy.api#documentation": "

The filters to apply to returned user data. You can filter up to the following limits:

\n \n

The user data is retrieved for only the specified\n values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles,\n agents, and user hierarchy groups.

\n

Currently tagging is only supported on the resources that are passed in the filter.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page.

" + } + } + } + }, + "com.amazonaws.connect#GetCurrentUserDataResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" + } + }, + "UserDataList": { + "target": "com.amazonaws.connect#UserDataList", + "traits": { + "smithy.api#documentation": "

A list of the user data that is returned.

" + } + }, + "ApproximateTotalCount": { + "target": "com.amazonaws.connect#ApproximateTotalCount", + "traits": { + "smithy.api#documentation": "

The total count of the result, regardless of the current page size.

" + } + } + } + }, + "com.amazonaws.connect#GetFederationToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#GetFederationTokenRequest" + }, + "output": { + "target": "com.amazonaws.connect#GetFederationTokenResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#UserNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a token for federation.

\n \n

This API doesn't support root users. If you try to invoke GetFederationToken with root\n credentials, an error message similar to the following one appears:

\n

\n Provided identity: Principal: .... User: .... cannot be used for federation with\n Amazon Connect\n

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/user/federate/{InstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#GetFederationTokenRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#GetFederationTokenResponse": { + "type": "structure", + "members": { + "Credentials": { + "target": "com.amazonaws.connect#Credentials", + "traits": { + "smithy.api#documentation": "

The credentials to use for federation.

" + } + }, + "SignInUrl": { + "target": "com.amazonaws.connect#Url", + "traits": { + "smithy.api#documentation": "

The URL to sign into the user's instance.

" + } + }, + "UserArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user.

" + } + }, + "UserId": { + "target": "com.amazonaws.connect#AgentResourceId", + "traits": { + "smithy.api#documentation": "

The identifier for the user.

" + } + } + } + }, + "com.amazonaws.connect#GetMetricData": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#GetMetricDataRequest" + }, + "output": { + "target": "com.amazonaws.connect#GetMetricDataResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets historical metric data from the specified Amazon Connect instance.

\n

For a description of each historical metric, see Historical Metrics\n Definitions in the Amazon Connect Administrator Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/metrics/historical/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#GetMetricDataRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "StartTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the\n retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes,\n such as 10:05, 10:10, 10:15.

\n

The start time cannot be earlier than 24 hours before the time of the request. Historical\n metrics are available only for 24 hours.

", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the\n retrieval of historical metrics data. The time must be specified using an interval of 5 minutes,\n such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.

\n

The time range between the start and end time must be less than 24 hours.

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

The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is\n retrieved only for the resources associated with the queues or channels included in the filter.\n You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.

\n \n

To filter by Queues, enter the queue\n ID/ARN, not the name of the queue.

\n ", + "smithy.api#required": {} + } + }, + "Groupings": { + "target": "com.amazonaws.connect#Groupings", + "traits": { + "smithy.api#documentation": "

The grouping applied to the metrics returned. For example, when results are grouped by\n queue, the metrics returned are grouped by queue. The values returned apply to the metrics for\n each queue rather than aggregated for all queues.

\n

If no grouping is specified, a summary of metrics for all queues is returned.

" + } + }, + "HistoricalMetrics": { + "target": "com.amazonaws.connect#HistoricalMetrics", + "traits": { + "smithy.api#documentation": "

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The\n following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator\n Guide.

\n \n

This API does not support a contacts\n incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).

\n \n
\n
ABANDON_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
AFTER_CONTACT_WORK_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
API_CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CALLBACK_CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_ABANDONED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_AGENT_HUNG_UP_FIRST
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_CONSULTED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED_INCOMING
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HANDLED_OUTBOUND
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_HOLD_ABANDONS
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_MISSED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_QUEUED
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_IN
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_IN_FROM_QUEUE
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_OUT
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
\n
\n

Unit: COUNT

\n

Statistic: SUM

\n
\n
HANDLE_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
HOLD_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
INTERACTION_AND_HOLD_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
INTERACTION_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
OCCUPANCY
\n
\n

Unit: PERCENT

\n

Statistic: AVG

\n
\n
QUEUE_ANSWER_TIME
\n
\n

Unit: SECONDS

\n

Statistic: AVG

\n
\n
QUEUED_TIME
\n
\n

Unit: SECONDS

\n

Statistic: MAX

\n
\n
SERVICE_LEVEL
\n
\n

You can include up to 20 SERVICE_LEVEL metrics in a request.

\n

Unit: PERCENT

\n

Statistic: AVG

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page.

" + } + } + } + }, + "com.amazonaws.connect#GetMetricDataResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

\n

The token expires after 5 minutes from the time it is created. Subsequent requests that use\n the token must use the same request parameters as the request that generated the token.

" + } + }, + "MetricResults": { + "target": "com.amazonaws.connect#HistoricalMetricResults", + "traits": { + "smithy.api#documentation": "

Information about the historical metrics.

\n

If no grouping is specified, a summary of metric data is returned.

" + } + } + } + }, + "com.amazonaws.connect#GetTaskTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#GetTaskTemplateRequest" + }, + "output": { + "target": "com.amazonaws.connect#GetTaskTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets details about a specific task template in the specified Amazon Connect\n instance.

", + "smithy.api#http": { + "method": "GET", + "uri": "/instance/{InstanceId}/task/template/{TaskTemplateId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#GetTaskTemplateRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TaskTemplateId": { + "target": "com.amazonaws.connect#TaskTemplateId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the task template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SnapshotVersion": { + "target": "com.amazonaws.connect#SnapshotVersion", + "traits": { + "smithy.api#documentation": "

The system generated version of a task template that is associated with a task, when the\n task is created.

", + "smithy.api#httpQuery": "snapshotVersion" + } + } + } + }, + "com.amazonaws.connect#GetTaskTemplateResponse": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

" + } + }, + "Id": { + "target": "com.amazonaws.connect#TaskTemplateId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the task template.

", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.connect#TaskTemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN).

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#TaskTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the task template.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.connect#TaskTemplateDescription", + "traits": { + "smithy.api#documentation": "

The description of the task template.

" + } + }, + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

The identifier of the flow that runs by default when a task is created by referencing this template.

" + } + }, + "Constraints": { + "target": "com.amazonaws.connect#TaskTemplateConstraints", + "traits": { + "smithy.api#documentation": "

Constraints that are applicable to the fields listed.

" + } + }, + "Defaults": { + "target": "com.amazonaws.connect#TaskTemplateDefaults", + "traits": { + "smithy.api#documentation": "

The default values for fields when a task is created by referencing this template.

" + } + }, + "Fields": { + "target": "com.amazonaws.connect#TaskTemplateFields", + "traits": { + "smithy.api#documentation": "

Fields that are part of the template.

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

Marks a template as ACTIVE or INACTIVE for a task to refer to it. \nTasks can only be created from ACTIVE templates.\nIf a template is marked as INACTIVE, then a task that refers to this template cannot be created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the task template was last modified.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the task template was created.

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" + } + } + } + }, + "com.amazonaws.connect#GetTrafficDistribution": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#GetTrafficDistributionRequest" + }, + "output": { + "target": "com.amazonaws.connect#GetTrafficDistributionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the current traffic distribution for a given traffic distribution group.

", + "smithy.api#http": { + "method": "GET", + "uri": "/traffic-distribution/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.connect#GetTrafficDistributionRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#TrafficDistributionGroupIdOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the traffic distribution group.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#GetTrafficDistributionResponse": { + "type": "structure", + "members": { + "TelephonyConfig": { + "target": "com.amazonaws.connect#TelephonyConfig", + "traits": { + "smithy.api#documentation": "

The distribution of traffic between the instance and its replicas.

" + } + }, + "Id": { + "target": "com.amazonaws.connect#TrafficDistributionGroupId", + "traits": { + "smithy.api#documentation": "

The identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#TrafficDistributionGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the traffic distribution group.

" + } + } + } + }, + "com.amazonaws.connect#Grouping": { + "type": "enum", + "members": { + "QUEUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUEUE" + } + }, + "CHANNEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHANNEL" + } + }, + "ROUTING_PROFILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROUTING_PROFILE" + } + } + } + }, + "com.amazonaws.connect#Groupings": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#Grouping" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.connect#HierarchyGroup": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#HierarchyGroupId", + "traits": { + "smithy.api#documentation": "

The identifier of the hierarchy group.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hierarchy group.

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

The name of the hierarchy group.

" + } + }, + "LevelId": { + "target": "com.amazonaws.connect#HierarchyLevelId", + "traits": { + "smithy.api#documentation": "

The identifier of the level in the hierarchy group.

" + } + }, + "HierarchyPath": { + "target": "com.amazonaws.connect#HierarchyPath", + "traits": { + "smithy.api#documentation": "

Information about the levels in the hierarchy group.

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

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

Contains information about a hierarchy group.

" + } + }, + "com.amazonaws.connect#HierarchyGroupCondition": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.connect#String", + "traits": { + "smithy.api#documentation": "

The value in the hierarchy group condition.

" + } + }, + "HierarchyGroupMatchType": { + "target": "com.amazonaws.connect#HierarchyGroupMatchType", + "traits": { + "smithy.api#documentation": "

The type of hierarchy group match.

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

A leaf node condition which can be used to specify a hierarchy group condition.

" + } + }, + "com.amazonaws.connect#HierarchyGroupId": { + "type": "string" + }, + "com.amazonaws.connect#HierarchyGroupMatchType": { + "type": "enum", + "members": { + "EXACT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXACT" + } + }, + "WITH_CHILD_GROUPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WITH_CHILD_GROUPS" + } + } + } + }, + "com.amazonaws.connect#HierarchyGroupName": { + "type": "string" + }, + "com.amazonaws.connect#HierarchyGroupSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#HierarchyGroupId", + "traits": { + "smithy.api#documentation": "

The identifier of the hierarchy group.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hierarchy group.

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

The name of the hierarchy group.

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

Contains summary information about a hierarchy group.

" + } + }, + "com.amazonaws.connect#HierarchyGroupSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#HierarchyGroupSummary" + } + }, + "com.amazonaws.connect#HierarchyGroupSummaryReference": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#HierarchyGroupId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the hierarchy group.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the hierarchy group.

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

Information about the hierarchy group.

" + } + }, + "com.amazonaws.connect#HierarchyLevel": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#HierarchyLevelId", + "traits": { + "smithy.api#documentation": "

The identifier of the hierarchy level.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hierarchy level.

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

The name of the hierarchy level.

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

Contains information about a hierarchy level.

" + } + }, + "com.amazonaws.connect#HierarchyLevelId": { + "type": "string" + }, + "com.amazonaws.connect#HierarchyLevelName": { + "type": "string" + }, + "com.amazonaws.connect#HierarchyLevelUpdate": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#HierarchyLevelName", + "traits": { + "smithy.api#documentation": "

The name of the user hierarchy level. Must not be more than 50 characters.

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

Contains information about the hierarchy level to update.

" + } + }, + "com.amazonaws.connect#HierarchyPath": { + "type": "structure", + "members": { + "LevelOne": { + "target": "com.amazonaws.connect#HierarchyGroupSummary", + "traits": { + "smithy.api#documentation": "

Information about level one.

" + } + }, + "LevelTwo": { + "target": "com.amazonaws.connect#HierarchyGroupSummary", + "traits": { + "smithy.api#documentation": "

Information about level two.

" + } + }, + "LevelThree": { + "target": "com.amazonaws.connect#HierarchyGroupSummary", + "traits": { + "smithy.api#documentation": "

Information about level three.

" + } + }, + "LevelFour": { + "target": "com.amazonaws.connect#HierarchyGroupSummary", + "traits": { + "smithy.api#documentation": "

Information about level four.

" + } + }, + "LevelFive": { + "target": "com.amazonaws.connect#HierarchyGroupSummary", + "traits": { + "smithy.api#documentation": "

Information about level five.

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

Contains information about the levels of a hierarchy group.

" + } + }, + "com.amazonaws.connect#HierarchyPathReference": { + "type": "structure", + "members": { + "LevelOne": { + "target": "com.amazonaws.connect#HierarchyGroupSummaryReference", + "traits": { + "smithy.api#documentation": "

Information about level one.

" + } + }, + "LevelTwo": { + "target": "com.amazonaws.connect#HierarchyGroupSummaryReference", + "traits": { + "smithy.api#documentation": "

Information about level two.

" + } + }, + "LevelThree": { + "target": "com.amazonaws.connect#HierarchyGroupSummaryReference", + "traits": { + "smithy.api#documentation": "

Information about level three.

" + } + }, + "LevelFour": { + "target": "com.amazonaws.connect#HierarchyGroupSummaryReference", + "traits": { + "smithy.api#documentation": "

Information about level four.

" + } + }, + "LevelFive": { + "target": "com.amazonaws.connect#HierarchyGroupSummaryReference", + "traits": { + "smithy.api#documentation": "

Information about level five.

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

Information about the levels in the hierarchy group.

" + } + }, + "com.amazonaws.connect#HierarchyStructure": { + "type": "structure", + "members": { + "LevelOne": { + "target": "com.amazonaws.connect#HierarchyLevel", + "traits": { + "smithy.api#documentation": "

Information about level one.

" + } + }, + "LevelTwo": { + "target": "com.amazonaws.connect#HierarchyLevel", + "traits": { + "smithy.api#documentation": "

Information about level two.

" + } + }, + "LevelThree": { + "target": "com.amazonaws.connect#HierarchyLevel", + "traits": { + "smithy.api#documentation": "

Information about level three.

" + } + }, + "LevelFour": { + "target": "com.amazonaws.connect#HierarchyLevel", + "traits": { + "smithy.api#documentation": "

Information about level four.

" + } + }, + "LevelFive": { + "target": "com.amazonaws.connect#HierarchyLevel", + "traits": { + "smithy.api#documentation": "

Information about level five.

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

Contains information about a hierarchy structure.

" + } + }, + "com.amazonaws.connect#HierarchyStructureUpdate": { + "type": "structure", + "members": { + "LevelOne": { + "target": "com.amazonaws.connect#HierarchyLevelUpdate", + "traits": { + "smithy.api#documentation": "

The\n update\n for level one.

" + } + }, + "LevelTwo": { + "target": "com.amazonaws.connect#HierarchyLevelUpdate", + "traits": { + "smithy.api#documentation": "

The update for level two.

" + } + }, + "LevelThree": { + "target": "com.amazonaws.connect#HierarchyLevelUpdate", + "traits": { + "smithy.api#documentation": "

The update for level three.

" + } + }, + "LevelFour": { + "target": "com.amazonaws.connect#HierarchyLevelUpdate", + "traits": { + "smithy.api#documentation": "

The update for level four.

" + } + }, + "LevelFive": { + "target": "com.amazonaws.connect#HierarchyLevelUpdate", + "traits": { + "smithy.api#documentation": "

The update for level five.

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

Contains information about the level hierarchy to update.

" + } + }, + "com.amazonaws.connect#HistoricalMetric": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#HistoricalMetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric.

" + } + }, + "Threshold": { + "target": "com.amazonaws.connect#Threshold", + "traits": { + "smithy.api#documentation": "

The threshold for the metric, used with service level metrics.

" + } + }, + "Statistic": { + "target": "com.amazonaws.connect#Statistic", + "traits": { + "smithy.api#documentation": "

The statistic for the metric.

" + } + }, + "Unit": { + "target": "com.amazonaws.connect#Unit", + "traits": { + "smithy.api#documentation": "

The unit for the metric.

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

Contains information about a historical metric. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator\n Guide.

" + } + }, + "com.amazonaws.connect#HistoricalMetricData": { + "type": "structure", + "members": { + "Metric": { + "target": "com.amazonaws.connect#HistoricalMetric", + "traits": { + "smithy.api#documentation": "

Information about the metric.

" + } + }, + "Value": { + "target": "com.amazonaws.connect#Value", + "traits": { + "smithy.api#documentation": "

The value of the metric.

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

Contains the data for a historical metric.

" + } + }, + "com.amazonaws.connect#HistoricalMetricDataCollections": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#HistoricalMetricData" + } + }, + "com.amazonaws.connect#HistoricalMetricName": { + "type": "enum", + "members": { + "CONTACTS_QUEUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTACTS_QUEUED" + } + }, + "CONTACTS_HANDLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTACTS_HANDLED" + } + }, + "CONTACTS_ABANDONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTACTS_ABANDONED" + } + }, + "CONTACTS_CONSULTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTACTS_CONSULTED" + } + }, + "CONTACTS_AGENT_HUNG_UP_FIRST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTACTS_AGENT_HUNG_UP_FIRST" + } + }, + "CONTACTS_HANDLED_INCOMING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTACTS_HANDLED_INCOMING" + } + }, + "CONTACTS_HANDLED_OUTBOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTACTS_HANDLED_OUTBOUND" + } + }, + "CONTACTS_HOLD_ABANDONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTACTS_HOLD_ABANDONS" + } + }, + "CONTACTS_TRANSFERRED_IN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTACTS_TRANSFERRED_IN" + } + }, + "CONTACTS_TRANSFERRED_OUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTACTS_TRANSFERRED_OUT" + } + }, + "CONTACTS_TRANSFERRED_IN_FROM_QUEUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTACTS_TRANSFERRED_IN_FROM_QUEUE" + } + }, + "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE" + } + }, + "CONTACTS_MISSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTACTS_MISSED" + } + }, + "CALLBACK_CONTACTS_HANDLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CALLBACK_CONTACTS_HANDLED" + } + }, + "API_CONTACTS_HANDLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "API_CONTACTS_HANDLED" + } + }, + "OCCUPANCY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OCCUPANCY" + } + }, + "HANDLE_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HANDLE_TIME" + } + }, + "AFTER_CONTACT_WORK_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AFTER_CONTACT_WORK_TIME" + } + }, + "QUEUED_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUEUED_TIME" + } + }, + "ABANDON_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABANDON_TIME" + } + }, + "QUEUE_ANSWER_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUEUE_ANSWER_TIME" + } + }, + "HOLD_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOLD_TIME" + } + }, + "INTERACTION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERACTION_TIME" + } + }, + "INTERACTION_AND_HOLD_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERACTION_AND_HOLD_TIME" + } + }, + "SERVICE_LEVEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE_LEVEL" + } + } + }, + "traits": { + "smithy.api#documentation": "

The historical metric names.

" + } + }, + "com.amazonaws.connect#HistoricalMetricResult": { + "type": "structure", + "members": { + "Dimensions": { + "target": "com.amazonaws.connect#Dimensions", + "traits": { + "smithy.api#documentation": "

The dimension for the metrics.

" + } + }, + "Collections": { + "target": "com.amazonaws.connect#HistoricalMetricDataCollections", + "traits": { + "smithy.api#documentation": "

The set of metrics.

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

Contains information about the historical metrics retrieved.

" + } + }, + "com.amazonaws.connect#HistoricalMetricResults": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#HistoricalMetricResult" + } + }, + "com.amazonaws.connect#HistoricalMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#HistoricalMetric" + } + }, + "com.amazonaws.connect#Hours": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 87600 + } + } + }, + "com.amazonaws.connect#Hours24Format": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 23 + } + } + }, + "com.amazonaws.connect#HoursOfOperation": { + "type": "structure", + "members": { + "HoursOfOperationId": { + "target": "com.amazonaws.connect#HoursOfOperationId", + "traits": { + "smithy.api#documentation": "

The identifier for the hours of operation.

" + } + }, + "HoursOfOperationArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the hours of operation.

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

The name for the hours of operation.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#HoursOfOperationDescription", + "traits": { + "smithy.api#documentation": "

The description for the hours of operation.

" + } + }, + "TimeZone": { + "target": "com.amazonaws.connect#TimeZone", + "traits": { + "smithy.api#documentation": "

The time zone for the hours of operation.

" + } + }, + "Config": { + "target": "com.amazonaws.connect#HoursOfOperationConfigList", + "traits": { + "smithy.api#documentation": "

Configuration information for the hours of operation.

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

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

Information about of the hours of operation.

" + } + }, + "com.amazonaws.connect#HoursOfOperationConfig": { + "type": "structure", + "members": { + "Day": { + "target": "com.amazonaws.connect#HoursOfOperationDays", + "traits": { + "smithy.api#documentation": "

The day that the hours of operation applies to.

", + "smithy.api#required": {} + } + }, + "StartTime": { + "target": "com.amazonaws.connect#HoursOfOperationTimeSlice", + "traits": { + "smithy.api#documentation": "

The start time that your contact center opens.

", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "com.amazonaws.connect#HoursOfOperationTimeSlice", + "traits": { + "smithy.api#documentation": "

The end time that your contact center closes.

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

Contains information about the hours of operation.

" + } + }, + "com.amazonaws.connect#HoursOfOperationConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#HoursOfOperationConfig" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.connect#HoursOfOperationDays": { + "type": "enum", + "members": { + "SUNDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUNDAY" + } + }, + "MONDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONDAY" + } + }, + "TUESDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TUESDAY" + } + }, + "WEDNESDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEDNESDAY" + } + }, + "THURSDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THURSDAY" + } + }, + "FRIDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FRIDAY" + } + }, + "SATURDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SATURDAY" + } + } + } + }, + "com.amazonaws.connect#HoursOfOperationDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 250 + } + } + }, + "com.amazonaws.connect#HoursOfOperationId": { + "type": "string" + }, + "com.amazonaws.connect#HoursOfOperationName": { + "type": "string" + }, + "com.amazonaws.connect#HoursOfOperationSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#HoursOfOperationId", + "traits": { + "smithy.api#documentation": "

The identifier of the hours of operation.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hours of operation.

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

The name of the hours of operation.

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

Contains summary information about hours of operation for a contact center.

" + } + }, + "com.amazonaws.connect#HoursOfOperationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#HoursOfOperationSummary" + } + }, + "com.amazonaws.connect#HoursOfOperationTimeSlice": { + "type": "structure", + "members": { + "Hours": { + "target": "com.amazonaws.connect#Hours24Format", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The hours.

", + "smithy.api#required": {} + } + }, + "Minutes": { + "target": "com.amazonaws.connect#MinutesLimit60", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The minutes.

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

The start time or end time for an hours of operation.

" + } + }, + "com.amazonaws.connect#IdempotencyException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message" + } + }, + "traits": { + "smithy.api#documentation": "

An entity with the same name already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.connect#InboundCallsEnabled": { + "type": "boolean" + }, + "com.amazonaws.connect#Instance": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance.

" + } + }, + "IdentityManagementType": { + "target": "com.amazonaws.connect#DirectoryType", + "traits": { + "smithy.api#documentation": "

The identity management type.

" + } + }, + "InstanceAlias": { + "target": "com.amazonaws.connect#DirectoryAlias", + "traits": { + "smithy.api#documentation": "

The alias of instance.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

When the instance was created.

" + } + }, + "ServiceRole": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The service role of the instance.

" + } + }, + "InstanceStatus": { + "target": "com.amazonaws.connect#InstanceStatus", + "traits": { + "smithy.api#documentation": "

The state of the instance.

" + } + }, + "StatusReason": { + "target": "com.amazonaws.connect#InstanceStatusReason", + "traits": { + "smithy.api#documentation": "

Relevant\n details why the instance was not successfully created.

" + } + }, + "InboundCallsEnabled": { + "target": "com.amazonaws.connect#InboundCallsEnabled", + "traits": { + "smithy.api#documentation": "

Whether inbound calls are enabled.

" + } + }, + "OutboundCallsEnabled": { + "target": "com.amazonaws.connect#OutboundCallsEnabled", + "traits": { + "smithy.api#documentation": "

Whether outbound calls are enabled.

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

The Amazon Connect instance.

" + } + }, + "com.amazonaws.connect#InstanceArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9-]{1}:[0-9]{1,20}:instance/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, + "com.amazonaws.connect#InstanceAttributeType": { + "type": "enum", + "members": { + "INBOUND_CALLS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INBOUND_CALLS" + } + }, + "OUTBOUND_CALLS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUTBOUND_CALLS" + } + }, + "CONTACTFLOW_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTACTFLOW_LOGS" + } + }, + "CONTACT_LENS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTACT_LENS" + } + }, + "AUTO_RESOLVE_BEST_VOICES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO_RESOLVE_BEST_VOICES" + } + }, + "USE_CUSTOM_TTS_VOICES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USE_CUSTOM_TTS_VOICES" + } + }, + "EARLY_MEDIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EARLY_MEDIA" + } + }, + "MULTI_PARTY_CONFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MULTI_PARTY_CONFERENCE" + } + }, + "HIGH_VOLUME_OUTBOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH_VOLUME_OUTBOUND" + } + }, + "ENHANCED_CONTACT_MONITORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENHANCED_CONTACT_MONITORING" + } + } + } + }, + "com.amazonaws.connect#InstanceAttributeValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.connect#InstanceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.connect#InstanceIdOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 250 + }, + "smithy.api#pattern": "^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, + "com.amazonaws.connect#InstanceStatus": { + "type": "enum", + "members": { + "CREATION_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_IN_PROGRESS" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "CREATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_FAILED" + } + } + } + }, + "com.amazonaws.connect#InstanceStatusReason": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#String", + "traits": { + "smithy.api#documentation": "

The message.

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

Relevant\n details why the instance was not successfully created.

" + } + }, + "com.amazonaws.connect#InstanceStorageConfig": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.connect#AssociationId", + "traits": { + "smithy.api#documentation": "

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

" + } + }, + "StorageType": { + "target": "com.amazonaws.connect#StorageType", + "traits": { + "smithy.api#documentation": "

A valid storage type.

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

The S3 bucket\n configuration.

" + } + }, + "KinesisVideoStreamConfig": { + "target": "com.amazonaws.connect#KinesisVideoStreamConfig", + "traits": { + "smithy.api#documentation": "

The configuration of the Kinesis video stream.

" + } + }, + "KinesisStreamConfig": { + "target": "com.amazonaws.connect#KinesisStreamConfig", + "traits": { + "smithy.api#documentation": "

The configuration of the Kinesis data stream.

" + } + }, + "KinesisFirehoseConfig": { + "target": "com.amazonaws.connect#KinesisFirehoseConfig", + "traits": { + "smithy.api#documentation": "

The configuration of the Kinesis Firehose delivery stream.

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

The storage configuration for the instance.

" + } + }, + "com.amazonaws.connect#InstanceStorageConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#InstanceStorageConfig" + } + }, + "com.amazonaws.connect#InstanceStorageResourceType": { + "type": "enum", + "members": { + "CHAT_TRANSCRIPTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHAT_TRANSCRIPTS" + } + }, + "CALL_RECORDINGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CALL_RECORDINGS" + } + }, + "SCHEDULED_REPORTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCHEDULED_REPORTS" + } + }, + "MEDIA_STREAMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIA_STREAMS" + } + }, + "CONTACT_TRACE_RECORDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTACT_TRACE_RECORDS" + } + }, + "AGENT_EVENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENT_EVENTS" + } + }, + "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REAL_TIME_CONTACT_ANALYSIS_SEGMENTS" + } + } + } + }, + "com.amazonaws.connect#InstanceSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the instance.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance.

" + } + }, + "IdentityManagementType": { + "target": "com.amazonaws.connect#DirectoryType", + "traits": { + "smithy.api#documentation": "

The identity management type of the instance.

" + } + }, + "InstanceAlias": { + "target": "com.amazonaws.connect#DirectoryAlias", + "traits": { + "smithy.api#documentation": "

The alias of the instance.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

When the instance was created.

" + } + }, + "ServiceRole": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The service role of the instance.

" + } + }, + "InstanceStatus": { + "target": "com.amazonaws.connect#InstanceStatus", + "traits": { + "smithy.api#documentation": "

The state of the instance.

" + } + }, + "InboundCallsEnabled": { + "target": "com.amazonaws.connect#InboundCallsEnabled", + "traits": { + "smithy.api#documentation": "

Whether inbound calls are enabled.

" + } + }, + "OutboundCallsEnabled": { + "target": "com.amazonaws.connect#OutboundCallsEnabled", + "traits": { + "smithy.api#documentation": "

Whether outbound calls are enabled.

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

Information about the instance.

" + } + }, + "com.amazonaws.connect#InstanceSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#InstanceSummary" + } + }, + "com.amazonaws.connect#IntegerCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.connect#IntegrationAssociationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.connect#IntegrationAssociationSummary": { + "type": "structure", + "members": { + "IntegrationAssociationId": { + "target": "com.amazonaws.connect#IntegrationAssociationId", + "traits": { + "smithy.api#documentation": "

The identifier for the AppIntegration association.

" + } + }, + "IntegrationAssociationArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the AppIntegration association.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

" + } + }, + "IntegrationType": { + "target": "com.amazonaws.connect#IntegrationType", + "traits": { + "smithy.api#documentation": "

The integration type.

" + } + }, + "IntegrationArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the AppIntegration.

" + } + }, + "SourceApplicationUrl": { + "target": "com.amazonaws.connect#URI", + "traits": { + "smithy.api#documentation": "

The URL for the external application.

" + } + }, + "SourceApplicationName": { + "target": "com.amazonaws.connect#SourceApplicationName", + "traits": { + "smithy.api#documentation": "

The user-provided, friendly name for the external application.

" + } + }, + "SourceType": { + "target": "com.amazonaws.connect#SourceType", + "traits": { + "smithy.api#documentation": "

The name of the source.

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

Contains summary information about the associated AppIntegrations.

" + } + }, + "com.amazonaws.connect#IntegrationAssociationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#IntegrationAssociationSummary" + } + }, + "com.amazonaws.connect#IntegrationType": { + "type": "enum", + "members": { + "EVENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVENT" + } + }, + "VOICE_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VOICE_ID" + } + }, + "PINPOINT_APP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PINPOINT_APP" + } + }, + "WISDOM_ASSISTANT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WISDOM_ASSISTANT" + } + }, + "WISDOM_KNOWLEDGE_BASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WISDOM_KNOWLEDGE_BASE" + } + }, + "CASES_DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CASES_DOMAIN" + } + } + } + }, + "com.amazonaws.connect#InternalServiceException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message", + "traits": { + "smithy.api#documentation": "

The message.

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

Request processing failed because of an error or failure with the service.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.connect#InvalidContactFlowException": { + "type": "structure", + "members": { + "problems": { + "target": "com.amazonaws.connect#Problems", + "traits": { + "smithy.api#documentation": "

The problems with the flow. Please fix before trying again.

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

The flow is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.connect#InvalidContactFlowModuleException": { + "type": "structure", + "members": { + "Problems": { + "target": "com.amazonaws.connect#Problems" + } + }, + "traits": { + "smithy.api#documentation": "

The problems with the module. Please fix before trying again.

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

The message about the parameters.

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

One or more of the specified parameters are not valid.

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

The message about the request.

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

The request is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.connect#InvisibleFieldInfo": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#TaskTemplateFieldIdentifier", + "traits": { + "smithy.api#documentation": "

Identifier of the invisible field.

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

A field that is invisible to an agent.

" + } + }, + "com.amazonaws.connect#InvisibleTaskTemplateFields": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#InvisibleFieldInfo" + } + }, + "com.amazonaws.connect#KeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.connect#KinesisFirehoseConfig": { + "type": "structure", + "members": { + "FirehoseArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the delivery stream.

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

Configuration information of a Kinesis Data Firehose delivery stream.

" + } + }, + "com.amazonaws.connect#KinesisStreamConfig": { + "type": "structure", + "members": { + "StreamArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data stream.

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

Configuration information of a Kinesis data stream.

" + } + }, + "com.amazonaws.connect#KinesisVideoStreamConfig": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.connect#Prefix", + "traits": { + "smithy.api#documentation": "

The prefix of the video stream.

", + "smithy.api#required": {} + } + }, + "RetentionPeriodHours": { + "target": "com.amazonaws.connect#Hours", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of hours data is retained in the stream. Kinesis Video Streams retains the data\n in a data store that is associated with the stream.

\n

The default value is 0, indicating that the stream does not persist data.

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

The encryption configuration.

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

Configuration information of a Kinesis video stream.

" + } + }, + "com.amazonaws.connect#LargeNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100000 + } + } + }, + "com.amazonaws.connect#LexBot": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#BotName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Lex bot.

" + } + }, + "LexRegion": { + "target": "com.amazonaws.connect#LexRegion", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region where the Amazon Lex bot was created.

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

Configuration information of an Amazon Lex bot.

" + } + }, + "com.amazonaws.connect#LexBotConfig": { + "type": "structure", + "members": { + "LexBot": { + "target": "com.amazonaws.connect#LexBot" + }, + "LexV2Bot": { + "target": "com.amazonaws.connect#LexV2Bot", + "traits": { + "smithy.api#documentation": "

Configuration information of an Amazon Lex V2 bot.

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

Configuration information of an Amazon Lex or Amazon Lex V2 bot.

" + } + }, + "com.amazonaws.connect#LexBotConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#LexBotConfig" + } + }, + "com.amazonaws.connect#LexBotsList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#LexBot" + } + }, + "com.amazonaws.connect#LexRegion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 60 + } + } + }, + "com.amazonaws.connect#LexV2Bot": { + "type": "structure", + "members": { + "AliasArn": { + "target": "com.amazonaws.connect#AliasArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.

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

Configuration information of an Amazon Lex V2 bot.

" + } + }, + "com.amazonaws.connect#LexVersion": { + "type": "enum", + "members": { + "V1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "V1" + } + }, + "V2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "V2" + } + } + } + }, + "com.amazonaws.connect#LimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message", + "traits": { + "smithy.api#documentation": "

The message about the limit.

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

The allowed limit for the resource has been exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.connect#ListAgentStatusRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult1000", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "AgentStatusTypes": { + "target": "com.amazonaws.connect#AgentStatusTypes", + "traits": { + "smithy.api#documentation": "

Available agent status types.

", + "smithy.api#httpQuery": "AgentStatusTypes" + } + } + } + }, + "com.amazonaws.connect#ListAgentStatusResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" + } + }, + "AgentStatusSummaryList": { + "target": "com.amazonaws.connect#AgentStatusSummaryList", + "traits": { + "smithy.api#documentation": "

A summary of agent statuses.

" + } + } + } + }, + "com.amazonaws.connect#ListAgentStatuses": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListAgentStatusRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListAgentStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Lists agent statuses.

", + "smithy.api#http": { + "method": "GET", + "uri": "/agent-status/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AgentStatusSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListApprovedOrigins": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListApprovedOriginsRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListApprovedOriginsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Returns a paginated list of all approved origins associated with the instance.

", + "smithy.api#http": { + "method": "GET", + "uri": "/instance/{InstanceId}/approved-origins", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Origins", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListApprovedOriginsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult25", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.connect#ListApprovedOriginsResponse": { + "type": "structure", + "members": { + "Origins": { + "target": "com.amazonaws.connect#OriginsList", + "traits": { + "smithy.api#documentation": "

The approved origins.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#ListBots": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListBotsRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListBotsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently\n associated with the instance. Use this API to returns both Amazon Lex V1 and V2\n bots.

", + "smithy.api#http": { + "method": "GET", + "uri": "/instance/{InstanceId}/bots", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LexBots", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListBotsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult25", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "LexVersion": { + "target": "com.amazonaws.connect#LexVersion", + "traits": { + "smithy.api#documentation": "

The version of Amazon Lex or Amazon Lex V2.

", + "smithy.api#httpQuery": "lexVersion", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#ListBotsResponse": { + "type": "structure", + "members": { + "LexBots": { + "target": "com.amazonaws.connect#LexBotConfigList", + "traits": { + "smithy.api#documentation": "

The names and Amazon Web Services Regions of the Amazon Lex or Amazon Lex V2 bots associated with the\n specified instance.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#ListContactFlowModules": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListContactFlowModulesRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListContactFlowModulesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides information about the flow modules for the specified Amazon Connect\n instance.

", + "smithy.api#http": { + "method": "GET", + "uri": "/contact-flow-modules-summary/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ContactFlowModulesSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListContactFlowModulesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult1000", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "ContactFlowModuleState": { + "target": "com.amazonaws.connect#ContactFlowModuleState", + "traits": { + "smithy.api#documentation": "

The state of the flow module.

", + "smithy.api#httpQuery": "state" + } + } + } + }, + "com.amazonaws.connect#ListContactFlowModulesResponse": { + "type": "structure", + "members": { + "ContactFlowModulesSummaryList": { + "target": "com.amazonaws.connect#ContactFlowModulesSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the flow module.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#ListContactFlows": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListContactFlowsRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListContactFlowsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides information about the flows for the specified Amazon Connect instance.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

\n

For more information about flows, see Flows in the\n Amazon Connect Administrator Guide.

", + "smithy.api#http": { + "method": "GET", + "uri": "/contact-flows-summary/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ContactFlowSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListContactFlowsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactFlowTypes": { + "target": "com.amazonaws.connect#ContactFlowTypes", + "traits": { + "smithy.api#documentation": "

The type of flow.

", + "smithy.api#httpQuery": "contactFlowTypes" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult1000", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return per page. The default MaxResult size is 100.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.connect#ListContactFlowsResponse": { + "type": "structure", + "members": { + "ContactFlowSummaryList": { + "target": "com.amazonaws.connect#ContactFlowSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the flows.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#ListContactReferences": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListContactReferencesRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListContactReferencesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

For the specified referenceTypes, returns a list of references associated with\n the contact.

", + "smithy.api#http": { + "method": "GET", + "uri": "/contact/references/{InstanceId}/{ContactId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ReferenceSummaryList" + } + } + }, + "com.amazonaws.connect#ListContactReferencesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the initial contact.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ReferenceTypes": { + "target": "com.amazonaws.connect#ReferenceTypes", + "traits": { + "smithy.api#documentation": "

The type of reference.

", + "smithy.api#httpQuery": "referenceTypes", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

\n \n

This is not expected to be set, because the value returned in the previous response is\n always null.

\n ", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.connect#ListContactReferencesResponse": { + "type": "structure", + "members": { + "ReferenceSummaryList": { + "target": "com.amazonaws.connect#ReferenceSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the flows.

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

If there are additional results, this is the token for the next set of results.

\n \n

This is always returned as null in the response.

\n " + } + } + } + }, + "com.amazonaws.connect#ListDefaultVocabularies": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListDefaultVocabulariesRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListDefaultVocabulariesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the default vocabularies for the specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "POST", + "uri": "/default-vocabulary-summary/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DefaultVocabularyList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListDefaultVocabulariesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.connect#VocabularyLanguageCode", + "traits": { + "smithy.api#documentation": "

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see \nWhat is Amazon Transcribe?\n

" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return per page.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#ListDefaultVocabulariesResponse": { + "type": "structure", + "members": { + "DefaultVocabularyList": { + "target": "com.amazonaws.connect#DefaultVocabularyList", + "traits": { + "smithy.api#documentation": "

A list of default vocabularies.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#ListHoursOfOperations": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListHoursOfOperationsRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListHoursOfOperationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides information about the hours of operation for the specified Amazon Connect\n instance.

\n

For more information about hours of operation, see Set the Hours of Operation for a\n Queue in the Amazon Connect Administrator Guide.

", + "smithy.api#http": { + "method": "GET", + "uri": "/hours-of-operations-summary/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "HoursOfOperationSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListHoursOfOperationsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult1000", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return per page. The default MaxResult size is 100.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.connect#ListHoursOfOperationsResponse": { + "type": "structure", + "members": { + "HoursOfOperationSummaryList": { + "target": "com.amazonaws.connect#HoursOfOperationSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the hours of operation.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#ListInstanceAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListInstanceAttributesRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListInstanceAttributesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Returns a paginated list of all attribute types for the given instance.

", + "smithy.api#http": { + "method": "GET", + "uri": "/instance/{InstanceId}/attributes", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Attributes", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListInstanceAttributesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult7", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.connect#ListInstanceAttributesResponse": { + "type": "structure", + "members": { + "Attributes": { + "target": "com.amazonaws.connect#AttributesList", + "traits": { + "smithy.api#documentation": "

The attribute types.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#ListInstanceStorageConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListInstanceStorageConfigsRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListInstanceStorageConfigsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Returns a paginated list of storage configs for the identified instance and resource\n type.

", + "smithy.api#http": { + "method": "GET", + "uri": "/instance/{InstanceId}/storage-configs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "StorageConfigs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListInstanceStorageConfigsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.connect#InstanceStorageResourceType", + "traits": { + "smithy.api#documentation": "

A valid resource type.

", + "smithy.api#httpQuery": "resourceType", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult10", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.connect#ListInstanceStorageConfigsResponse": { + "type": "structure", + "members": { + "StorageConfigs": { + "target": "com.amazonaws.connect#InstanceStorageConfigs", + "traits": { + "smithy.api#documentation": "

A valid storage type.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#ListInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListInstancesRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListInstancesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Return a list of instances which are in active state, creation-in-progress state, and failed\n state. Instances that aren't successfully created (they are in a failed state) are returned only\n for 24 hours after the CreateInstance API was invoked.

", + "smithy.api#http": { + "method": "GET", + "uri": "/instance", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InstanceSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListInstancesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult10", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.connect#ListInstancesResponse": { + "type": "structure", + "members": { + "InstanceSummaryList": { + "target": "com.amazonaws.connect#InstanceSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the instances.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#ListIntegrationAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListIntegrationAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListIntegrationAssociationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides summary information about the Amazon Web Services resource associations for the\n specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "GET", + "uri": "/instance/{InstanceId}/integration-associations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IntegrationAssociationSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListIntegrationAssociationsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IntegrationType": { + "target": "com.amazonaws.connect#IntegrationType", + "traits": { + "smithy.api#documentation": "

The integration type.

", + "smithy.api#httpQuery": "integrationType" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.connect#ListIntegrationAssociationsResponse": { + "type": "structure", + "members": { + "IntegrationAssociationSummaryList": { + "target": "com.amazonaws.connect#IntegrationAssociationSummaryList", + "traits": { + "smithy.api#documentation": "

The associations.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#ListLambdaFunctions": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListLambdaFunctionsRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListLambdaFunctionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Returns a paginated list of all Lambda functions that display in the dropdown options in the\n relevant flow blocks.

", + "smithy.api#http": { + "method": "GET", + "uri": "/instance/{InstanceId}/lambda-functions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LambdaFunctions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListLambdaFunctionsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult25", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.connect#ListLambdaFunctionsResponse": { + "type": "structure", + "members": { + "LambdaFunctions": { + "target": "com.amazonaws.connect#FunctionArnsList", + "traits": { + "smithy.api#documentation": "

The Lambdafunction ARNs associated with the specified instance.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#ListLexBots": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListLexBotsRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListLexBotsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To\n return both Amazon Lex V1 and V2 bots, use the ListBots API.\n

", + "smithy.api#http": { + "method": "GET", + "uri": "/instance/{InstanceId}/lex-bots", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LexBots", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListLexBotsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult25", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page. If no value is specified, the default is 10.\n

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.connect#ListLexBotsResponse": { + "type": "structure", + "members": { + "LexBots": { + "target": "com.amazonaws.connect#LexBotsList", + "traits": { + "smithy.api#documentation": "

The names and Amazon Web Services Regions of the Amazon Lex bots associated with the specified\n instance.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#ListPhoneNumbers": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListPhoneNumbersRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListPhoneNumbersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides information about the phone numbers for the specified Amazon Connect instance.

\n

For more information about phone numbers, see Set Up Phone Numbers for Your\n Contact Center in the Amazon Connect Administrator\n Guide.

\n \n

The phone number Arn value that is returned from each of the items in the\n PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with\n a ResourceNotFoundException. Instead, use the ListPhoneNumbersV2 API.\n It returns the new phone number ARN that can be used to tag phone number resources.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/phone-numbers-summary/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PhoneNumberSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListPhoneNumbersRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PhoneNumberTypes": { + "target": "com.amazonaws.connect#PhoneNumberTypes", + "traits": { + "smithy.api#documentation": "

The type of phone number.

", + "smithy.api#httpQuery": "phoneNumberTypes" + } + }, + "PhoneNumberCountryCodes": { + "target": "com.amazonaws.connect#PhoneNumberCountryCodes", + "traits": { + "smithy.api#documentation": "

The ISO country code.

", + "smithy.api#httpQuery": "phoneNumberCountryCodes" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult1000", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return per page. The default MaxResult size is 100.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.connect#ListPhoneNumbersResponse": { + "type": "structure", + "members": { + "PhoneNumberSummaryList": { + "target": "com.amazonaws.connect#PhoneNumberSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the phone numbers.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#ListPhoneNumbersSummary": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the phone number.

" + } + }, + "PhoneNumberArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the phone number.

" + } + }, + "PhoneNumber": { + "target": "com.amazonaws.connect#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

" + } + }, + "PhoneNumberCountryCode": { + "target": "com.amazonaws.connect#PhoneNumberCountryCode", + "traits": { + "smithy.api#documentation": "

The ISO country code.

" + } + }, + "PhoneNumberType": { + "target": "com.amazonaws.connect#PhoneNumberType", + "traits": { + "smithy.api#documentation": "

The type of phone number.

" + } + }, + "TargetArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

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

Information about phone numbers that have been claimed to your Amazon Connect instance\n or traffic distribution group.

" + } + }, + "com.amazonaws.connect#ListPhoneNumbersSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ListPhoneNumbersSummary" + } + }, + "com.amazonaws.connect#ListPhoneNumbersV2": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListPhoneNumbersV2Request" + }, + "output": { + "target": "com.amazonaws.connect#ListPhoneNumbersV2Response" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided\n TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions\n associated with traffic distribution group.

\n

For more information about phone numbers, see Set Up Phone Numbers for Your\n Contact Center in the Amazon Connect Administrator\n Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/phone-number/list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ListPhoneNumbersSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListPhoneNumbersV2Request": { + "type": "structure", + "members": { + "TargetArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to. If TargetArn input is not provided, this API lists numbers claimed\n to all the Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult1000", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" + } + }, + "PhoneNumberCountryCodes": { + "target": "com.amazonaws.connect#PhoneNumberCountryCodes", + "traits": { + "smithy.api#documentation": "

The ISO country code.

" + } + }, + "PhoneNumberTypes": { + "target": "com.amazonaws.connect#PhoneNumberTypes", + "traits": { + "smithy.api#documentation": "

The type of phone number.

" + } + }, + "PhoneNumberPrefix": { + "target": "com.amazonaws.connect#PhoneNumberPrefix", + "traits": { + "smithy.api#documentation": "

The prefix of the phone number. If provided, it must contain + as part of the country code.

" + } + } + } + }, + "com.amazonaws.connect#ListPhoneNumbersV2Response": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.connect#LargeNextToken", + "traits": { + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" + } + }, + "ListPhoneNumbersSummaryList": { + "target": "com.amazonaws.connect#ListPhoneNumbersSummaryList", + "traits": { + "smithy.api#documentation": "

Information about phone numbers that have been claimed to your Amazon Connect instances\n or traffic distribution groups.

" + } + } + } + }, + "com.amazonaws.connect#ListPrompts": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListPromptsRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListPromptsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides information about the prompts for the specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "GET", + "uri": "/prompts-summary/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PromptSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListPromptsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

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

The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult1000", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page. The default MaxResult size is 100.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.connect#ListPromptsResponse": { + "type": "structure", + "members": { + "PromptSummaryList": { + "target": "com.amazonaws.connect#PromptSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the prompts.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#ListQueueQuickConnects": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListQueueQuickConnectsRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListQueueQuickConnectsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Lists the quick connects associated with a queue.

", + "smithy.api#http": { + "method": "GET", + "uri": "/queues/{InstanceId}/{QueueId}/quick-connects", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "QuickConnectSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListQueueQuickConnectsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QueueId": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier for the queue.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page. The default MaxResult size is 100.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.connect#ListQueueQuickConnectsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" + } + }, + "QuickConnectSummaryList": { + "target": "com.amazonaws.connect#QuickConnectSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the quick connects.

" + } + } + } + }, + "com.amazonaws.connect#ListQueues": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListQueuesRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListQueuesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides information about the queues for the specified Amazon Connect instance.

\n

If you do not specify a QueueTypes\n parameter, both standard and agent queues are returned. This might cause an unexpected truncation\n of results if you have more than 1000 agents and you limit the number of results of the API call\n in code.

\n

For more information about queues, see Queues: Standard and\n Agent in the Amazon Connect Administrator Guide.

", + "smithy.api#http": { + "method": "GET", + "uri": "/queues-summary/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "QueueSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListQueuesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QueueTypes": { + "target": "com.amazonaws.connect#QueueTypes", + "traits": { + "smithy.api#documentation": "

The type of queue.

", + "smithy.api#httpQuery": "queueTypes" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult1000", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return per page. The default MaxResult size is 100.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.connect#ListQueuesResponse": { + "type": "structure", + "members": { + "QueueSummaryList": { + "target": "com.amazonaws.connect#QueueSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the queues.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#ListQuickConnects": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListQuickConnectsRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListQuickConnectsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides information about the quick connects for the specified Amazon Connect instance.\n

", + "smithy.api#http": { + "method": "GET", + "uri": "/quick-connects/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "QuickConnectSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListQuickConnectsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult1000", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page. The default MaxResult size is 100.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "QuickConnectTypes": { + "target": "com.amazonaws.connect#QuickConnectTypes", + "traits": { + "smithy.api#documentation": "

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are\n prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

", + "smithy.api#httpQuery": "QuickConnectTypes" + } + } + } + }, + "com.amazonaws.connect#ListQuickConnectsResponse": { + "type": "structure", + "members": { + "QuickConnectSummaryList": { + "target": "com.amazonaws.connect#QuickConnectSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the quick connects.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#ListRoutingProfileQueues": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListRoutingProfileQueuesRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListRoutingProfileQueuesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the queues associated with a routing profile.

", + "smithy.api#http": { + "method": "GET", + "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/queues", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "RoutingProfileQueueConfigSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListRoutingProfileQueuesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the routing profile.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page. The default MaxResult size is 100.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.connect#ListRoutingProfileQueuesResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" + } + }, + "RoutingProfileQueueConfigSummaryList": { + "target": "com.amazonaws.connect#RoutingProfileQueueConfigSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the routing profiles.

" + } + } + } + }, + "com.amazonaws.connect#ListRoutingProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListRoutingProfilesRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListRoutingProfilesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides summary information about the routing profiles for the specified Amazon Connect\n instance.

\n

For more information about routing profiles, see Routing Profiles and Create a Routing\n Profile in the Amazon Connect Administrator Guide.

", + "smithy.api#http": { + "method": "GET", + "uri": "/routing-profiles-summary/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "RoutingProfileSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListRoutingProfilesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult1000", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page. The default MaxResult size is 100.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.connect#ListRoutingProfilesResponse": { + "type": "structure", + "members": { + "RoutingProfileSummaryList": { + "target": "com.amazonaws.connect#RoutingProfileSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the routing profiles.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#ListRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListRulesRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListRulesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

List all rules for the specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "GET", + "uri": "/rules/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "RuleSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListRulesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PublishStatus": { + "target": "com.amazonaws.connect#RulePublishStatus", + "traits": { + "smithy.api#documentation": "

The publish status of the rule.

", + "smithy.api#httpQuery": "publishStatus" + } + }, + "EventSourceName": { + "target": "com.amazonaws.connect#EventSourceName", + "traits": { + "smithy.api#documentation": "

The name of the event source.

", + "smithy.api#httpQuery": "eventSourceName" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult200", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.connect#ListRulesResponse": { + "type": "structure", + "members": { + "RuleSummaryList": { + "target": "com.amazonaws.connect#RuleSummaryList", + "traits": { + "smithy.api#documentation": "

Summary information about a rule.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#ListSecurityKeys": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListSecurityKeysRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListSecurityKeysResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Returns a paginated list of all security keys associated with the instance.

", + "smithy.api#http": { + "method": "GET", + "uri": "/instance/{InstanceId}/security-keys", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SecurityKeys", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListSecurityKeysRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult2", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.connect#ListSecurityKeysResponse": { + "type": "structure", + "members": { + "SecurityKeys": { + "target": "com.amazonaws.connect#SecurityKeysList", + "traits": { + "smithy.api#documentation": "

The security keys.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#ListSecurityProfilePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListSecurityProfilePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListSecurityProfilePermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Lists the permissions granted to a security profile.

", + "smithy.api#http": { + "method": "GET", + "uri": "/security-profiles-permissions/{InstanceId}/{SecurityProfileId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Permissions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListSecurityProfilePermissionsRequest": { + "type": "structure", + "members": { + "SecurityProfileId": { + "target": "com.amazonaws.connect#SecurityProfileId", + "traits": { + "smithy.api#documentation": "

The identifier for the security profle.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult1000", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.connect#ListSecurityProfilePermissionsResponse": { + "type": "structure", + "members": { + "Permissions": { + "target": "com.amazonaws.connect#PermissionsList", + "traits": { + "smithy.api#documentation": "

The permissions granted to the security profile. For a complete list of valid permissions,\n see List\n of security profile permissions.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#ListSecurityProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListSecurityProfilesRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListSecurityProfilesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides summary information about the security profiles for the specified Amazon Connect instance.

\n

For more information about security profiles, see Security Profiles in the\n Amazon Connect Administrator Guide.

", + "smithy.api#http": { + "method": "GET", + "uri": "/security-profiles-summary/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SecurityProfileSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListSecurityProfilesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult1000", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page. The default MaxResult size is 100.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.connect#ListSecurityProfilesResponse": { + "type": "structure", + "members": { + "SecurityProfileSummaryList": { + "target": "com.amazonaws.connect#SecurityProfileSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the security profiles.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags for the specified resource.

\n

For sample policies that use tags, see Amazon Connect\n Identity-Based Policy Examples in the Amazon Connect Administrator\n Guide.

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

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

Information about the tags.

" + } + } + } + }, + "com.amazonaws.connect#ListTaskTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListTaskTemplatesRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListTaskTemplatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists task templates for the specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "GET", + "uri": "/instance/{InstanceId}/task/template", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TaskTemplates", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListTaskTemplatesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

\n \n

It is not expected that you set this because the value returned in the previous response is\n always null.

\n ", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page.

\n \n

It is not expected that you set this.

\n ", + "smithy.api#httpQuery": "maxResults" + } + }, + "Status": { + "target": "com.amazonaws.connect#TaskTemplateStatus", + "traits": { + "smithy.api#documentation": "

Marks a template as ACTIVE or INACTIVE for a task to refer to it. \nTasks can only be created from ACTIVE templates.\nIf a template is marked as INACTIVE, then a task that refers to this template cannot be created.

", + "smithy.api#httpQuery": "status" + } + }, + "Name": { + "target": "com.amazonaws.connect#TaskTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the task template.

", + "smithy.api#httpQuery": "name" + } + } + } + }, + "com.amazonaws.connect#ListTaskTemplatesResponse": { + "type": "structure", + "members": { + "TaskTemplates": { + "target": "com.amazonaws.connect#TaskTemplateList", + "traits": { + "smithy.api#documentation": "

Provides details about a list of task templates belonging to an instance.

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

If there are additional results, this is the token for the next set of results.

\n \n

This is always returned as a null in the response.

\n " + } + } + } + }, + "com.amazonaws.connect#ListTrafficDistributionGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListTrafficDistributionGroupsRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListTrafficDistributionGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists traffic distribution groups.

", + "smithy.api#http": { + "method": "GET", + "uri": "/traffic-distribution-groups", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrafficDistributionGroupSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListTrafficDistributionGroupsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult10", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceIdOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpQuery": "instanceId" + } + } + } + }, + "com.amazonaws.connect#ListTrafficDistributionGroupsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" + } + }, + "TrafficDistributionGroupSummaryList": { + "target": "com.amazonaws.connect#TrafficDistributionGroupSummaryList", + "traits": { + "smithy.api#documentation": "

A list of traffic distribution groups.

" + } + } + } + }, + "com.amazonaws.connect#ListUseCases": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListUseCasesRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListUseCasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the use cases for the integration association.

", + "smithy.api#http": { + "method": "GET", + "uri": "/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "UseCaseSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListUseCasesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IntegrationAssociationId": { + "target": "com.amazonaws.connect#IntegrationAssociationId", + "traits": { + "smithy.api#documentation": "

The identifier for the integration association.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page.

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

Provides summary information about the use cases for the specified integration\n association.

" + } + }, + "com.amazonaws.connect#ListUseCasesResponse": { + "type": "structure", + "members": { + "UseCaseSummaryList": { + "target": "com.amazonaws.connect#UseCaseSummaryList", + "traits": { + "smithy.api#documentation": "

The use cases.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#ListUserHierarchyGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListUserHierarchyGroupsRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListUserHierarchyGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides summary information about the hierarchy groups for the specified Amazon Connect\n instance.

\n

For more information about agent hierarchies, see Set Up Agent Hierarchies in the\n Amazon Connect Administrator Guide.

", + "smithy.api#http": { + "method": "GET", + "uri": "/user-hierarchy-groups-summary/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "UserHierarchyGroupSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListUserHierarchyGroupsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult1000", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page. The default MaxResult size is 100.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.connect#ListUserHierarchyGroupsResponse": { + "type": "structure", + "members": { + "UserHierarchyGroupSummaryList": { + "target": "com.amazonaws.connect#HierarchyGroupSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the hierarchy groups.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#ListUsers": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListUsersRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListUsersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides summary information about the users for the specified Amazon Connect\n instance.

", + "smithy.api#http": { + "method": "GET", + "uri": "/users-summary/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "UserSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListUsersRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult1000", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page. The default MaxResult size is 100.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.connect#ListUsersResponse": { + "type": "structure", + "members": { + "UserSummaryList": { + "target": "com.amazonaws.connect#UserSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the users.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#Long": { + "type": "long" + }, + "com.amazonaws.connect#MaxResult10": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.connect#MaxResult100": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.connect#MaxResult1000": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.connect#MaxResult2": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.connect#MaxResult200": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.connect#MaxResult25": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.connect#MaxResult7": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 7 + } + } + }, + "com.amazonaws.connect#MediaConcurrencies": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#MediaConcurrency" + } + }, + "com.amazonaws.connect#MediaConcurrency": { + "type": "structure", + "members": { + "Channel": { + "target": "com.amazonaws.connect#Channel", + "traits": { + "smithy.api#documentation": "

The channels that agents can handle in the Contact Control Panel (CCP).

", + "smithy.api#required": {} + } + }, + "Concurrency": { + "target": "com.amazonaws.connect#Concurrency", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of contacts an agent can have on a channel simultaneously.

\n

Valid Range for VOICE: Minimum value of 1. Maximum value of 1.

\n

Valid Range for CHAT: Minimum value of 1. Maximum value of 10.

\n

Valid Range for TASK: Minimum value of 1. Maximum value of 10.

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

Contains information about which channels are supported, and how many contacts an agent can\n have on a channel simultaneously.

" + } + }, + "com.amazonaws.connect#Message": { + "type": "string" + }, + "com.amazonaws.connect#MinutesLimit60": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 59 + } + } + }, + "com.amazonaws.connect#MonitorCapability": { + "type": "enum", + "members": { + "SILENT_MONITOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SILENT_MONITOR" + } + }, + "BARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BARGE" + } + } + } + }, + "com.amazonaws.connect#MonitorContact": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#MonitorContactRequest" + }, + "output": { + "target": "com.amazonaws.connect#MonitorContactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#IdempotencyException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user\n specified by userId will be set to silent monitoring mode on the\n contact.

", + "smithy.api#http": { + "method": "POST", + "uri": "/contact/monitor", + "code": 200 + } + } + }, + "com.amazonaws.connect#MonitorContactRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the\n instance.

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

The identifier of the contact.

", + "smithy.api#required": {} + } + }, + "UserId": { + "target": "com.amazonaws.connect#AgentResourceId", + "traits": { + "smithy.api#documentation": "

The identifier of the user account.

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

Specify which monitoring actions the user is allowed to take. For example, whether the user\n is allowed to escalate from silent monitoring to barge.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.connect#MonitorContactResponse": { + "type": "structure", + "members": { + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact.

" + } + }, + "ContactArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the contact.

" + } + } + } + }, + "com.amazonaws.connect#Name": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + } + } + }, + "com.amazonaws.connect#Name128": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(^[\\S].*[\\S]$)|(^[\\S]$)$" + } + }, + "com.amazonaws.connect#NextToken": { + "type": "string" + }, + "com.amazonaws.connect#NextToken2500": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2500 + } + } + }, + "com.amazonaws.connect#NotificationContentType": { + "type": "enum", + "members": { + "PLAIN_TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLAIN_TEXT" + } + } + } + }, + "com.amazonaws.connect#NotificationDeliveryType": { + "type": "enum", + "members": { + "EMAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL" + } + } + } + }, + "com.amazonaws.connect#NotificationRecipientType": { + "type": "structure", + "members": { + "UserTags": { + "target": "com.amazonaws.connect#UserTagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }. Amazon Connect users with the specified tags will be notified.

" + } + }, + "UserIds": { + "target": "com.amazonaws.connect#UserIdList", + "traits": { + "smithy.api#documentation": "

A list of user IDs.

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

The type of notification recipient.

" + } + }, + "com.amazonaws.connect#NumberReference": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#ReferenceKey", + "traits": { + "smithy.api#documentation": "

Identifier of the number reference.

" + } + }, + "Value": { + "target": "com.amazonaws.connect#ReferenceValue", + "traits": { + "smithy.api#documentation": "

A valid number.

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

Information about a reference when the referenceType is NUMBER.\n Otherwise, null.

" + } + }, + "com.amazonaws.connect#Origin": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 267 + } + } + }, + "com.amazonaws.connect#OriginsList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#Origin" + } + }, + "com.amazonaws.connect#OutboundCallerConfig": { + "type": "structure", + "members": { + "OutboundCallerIdName": { + "target": "com.amazonaws.connect#OutboundCallerIdName", + "traits": { + "smithy.api#documentation": "

The caller ID name.

" + } + }, + "OutboundCallerIdNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

The caller ID number.

" + } + }, + "OutboundFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

The outbound whisper flow to be used during an outbound call.

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

The outbound caller ID name, number, and outbound whisper flow.

" + } + }, + "com.amazonaws.connect#OutboundCallerIdName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.connect#OutboundCallsEnabled": { + "type": "boolean" + }, + "com.amazonaws.connect#OutboundContactNotPermittedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message", + "traits": { + "smithy.api#documentation": "

The message about the contact.

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

The contact is not permitted.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.connect#PEM": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.connect#ParticipantDetails": { + "type": "structure", + "members": { + "DisplayName": { + "target": "com.amazonaws.connect#DisplayName", + "traits": { + "smithy.api#documentation": "

Display name of the participant.

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

The customer's details.

" + } + }, + "com.amazonaws.connect#ParticipantId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.connect#ParticipantTimerAction": { + "type": "enum", + "members": { + "Unset": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unset" + } + } + } + }, + "com.amazonaws.connect#ParticipantTimerConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ParticipantTimerConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6 + } + } + }, + "com.amazonaws.connect#ParticipantTimerConfiguration": { + "type": "structure", + "members": { + "ParticipantRole": { + "target": "com.amazonaws.connect#TimerEligibleParticipantRoles", + "traits": { + "smithy.api#documentation": "

The role of the participant in the chat conversation.

", + "smithy.api#required": {} + } + }, + "TimerType": { + "target": "com.amazonaws.connect#ParticipantTimerType", + "traits": { + "smithy.api#documentation": "

The type of timer. IDLE indicates the timer applies for considering a human chat participant as idle. \n DISCONNECT_NONCUSTOMER indicates the timer applies to automatically disconnecting a chat participant due to\n idleness.

", + "smithy.api#required": {} + } + }, + "TimerValue": { + "target": "com.amazonaws.connect#ParticipantTimerValue", + "traits": { + "smithy.api#documentation": "

The value of the timer. Either the timer action (Unset to delete the timer), or the duration\n of the timer in minutes. Only one value can be set.

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

Configuration information for the timer. After the timer configuration is set, it persists\n for the duration of the chat. It persists across new contacts in the chain, for example, transfer\n contacts.

\n

For more information about how chat timeouts work, see \n Set up chat timeouts for human participants.

" + } + }, + "com.amazonaws.connect#ParticipantTimerDurationInMinutes": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 2, + "max": 480 + } + } + }, + "com.amazonaws.connect#ParticipantTimerType": { + "type": "enum", + "members": { + "IDLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IDLE" + } + }, + "DISCONNECT_NONCUSTOMER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISCONNECT_NONCUSTOMER" + } + } + } + }, + "com.amazonaws.connect#ParticipantTimerValue": { + "type": "union", + "members": { + "ParticipantTimerAction": { + "target": "com.amazonaws.connect#ParticipantTimerAction", + "traits": { + "smithy.api#documentation": "

The timer action. Currently only one value is allowed: Unset. It deletes a timer.

" + } + }, + "ParticipantTimerDurationInMinutes": { + "target": "com.amazonaws.connect#ParticipantTimerDurationInMinutes", + "traits": { + "smithy.api#documentation": "

The duration of a timer, in minutes.

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

The value of the timer. Either the timer action (Unset to delete the timer), or\n the duration of the timer in minutes. Only one value can be set.

\n

For more information about how chat timeouts work, see \n Set up chat timeouts for human participants.

" + } + }, + "com.amazonaws.connect#ParticipantToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.connect#Password": { + "type": "string", + "traits": { + "smithy.api#pattern": "^/^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)[a-zA-Z\\d\\S]{8,64}$/$" + } + }, + "com.amazonaws.connect#Percentage": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.connect#PermissionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#SecurityProfilePermission" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.connect#PhoneNumber": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\\\+[1-9]\\\\d{1,14}$" + } + }, + "com.amazonaws.connect#PhoneNumberCountryCode": { + "type": "enum", + "members": { + "AF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AF" + } + }, + "AL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AL" + } + }, + "DZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DZ" + } + }, + "AS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AS" + } + }, + "AD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AD" + } + }, + "AO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AO" + } + }, + "AI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AI" + } + }, + "AQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AQ" + } + }, + "AG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AG" + } + }, + "AR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AR" + } + }, + "AM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AM" + } + }, + "AW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AW" + } + }, + "AU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AU" + } + }, + "AT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AT" + } + }, + "AZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AZ" + } + }, + "BS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BS" + } + }, + "BH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BH" + } + }, + "BD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BD" + } + }, + "BB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BB" + } + }, + "BY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BY" + } + }, + "BE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BE" + } + }, + "BZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BZ" + } + }, + "BJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BJ" + } + }, + "BM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BM" + } + }, + "BT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BT" + } + }, + "BO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BO" + } + }, + "BA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BA" + } + }, + "BW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BW" + } + }, + "BR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BR" + } + }, + "IO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IO" + } + }, + "VG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VG" + } + }, + "BN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BN" + } + }, + "BG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BG" + } + }, + "BF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BF" + } + }, + "BI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BI" + } + }, + "KH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KH" + } + }, + "CM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CM" + } + }, + "CA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA" + } + }, + "CV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CV" + } + }, + "KY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KY" + } + }, + "CF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CF" + } + }, + "TD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TD" + } + }, + "CL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CL" + } + }, + "CN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CN" + } + }, + "CX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CX" + } + }, + "CC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CC" + } + }, + "CO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CO" + } + }, + "KM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KM" + } + }, + "CK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CK" + } + }, + "CR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CR" + } + }, + "HR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HR" + } + }, + "CU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CU" + } + }, + "CW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CW" + } + }, + "CY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CY" + } + }, + "CZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CZ" + } + }, + "CD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CD" + } + }, + "DK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DK" + } + }, + "DJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DJ" + } + }, + "DM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DM" + } + }, + "DO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DO" + } + }, + "TL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TL" + } + }, + "EC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC" + } + }, + "EG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EG" + } + }, + "SV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SV" + } + }, + "GQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GQ" + } + }, + "ER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ER" + } + }, + "EE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EE" + } + }, + "ET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ET" + } + }, + "FK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FK" + } + }, + "FO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FO" + } + }, + "FJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FJ" + } + }, + "FI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FI" + } + }, + "FR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FR" + } + }, + "PF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PF" + } + }, + "GA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GA" + } + }, + "GM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GM" + } + }, + "GE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GE" + } + }, + "DE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DE" + } + }, + "GH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GH" + } + }, + "GI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GI" + } + }, + "GR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GR" + } + }, + "GL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GL" + } + }, + "GD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GD" + } + }, + "GU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GU" + } + }, + "GT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GT" + } + }, + "GG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GG" + } + }, + "GN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GN" + } + }, + "GW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GW" + } + }, + "GY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GY" + } + }, + "HT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HT" + } + }, + "HN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HN" + } + }, + "HK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HK" + } + }, + "HU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HU" + } + }, + "IS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IS" + } + }, + "IN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN" + } + }, + "ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ID" + } + }, + "IR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IR" + } + }, + "IQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IQ" + } + }, + "IE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IE" + } + }, + "IM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IM" + } + }, + "IL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IL" + } + }, + "IT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IT" + } + }, + "CI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CI" + } + }, + "JM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JM" + } + }, + "JP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JP" + } + }, + "JE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JE" + } + }, + "JO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JO" + } + }, + "KZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KZ" + } + }, + "KE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KE" + } + }, + "KI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KI" + } + }, + "KW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KW" + } + }, + "KG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KG" + } + }, + "LA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LA" + } + }, + "LV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LV" + } + }, + "LB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LB" + } + }, + "LS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LS" + } + }, + "LR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LR" + } + }, + "LY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LY" + } + }, + "LI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LI" + } + }, + "LT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LT" + } + }, + "LU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LU" + } + }, + "MO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MO" + } + }, + "MK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MK" + } + }, + "MG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MG" + } + }, + "MW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MW" + } + }, + "MY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MY" + } + }, + "MV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MV" + } + }, + "ML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ML" + } + }, + "MT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MT" + } + }, + "MH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MH" + } + }, + "MR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MR" + } + }, + "MU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MU" + } + }, + "YT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YT" + } + }, + "MX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MX" + } + }, + "FM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FM" + } + }, + "MD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MD" + } + }, + "MC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MC" + } + }, + "MN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MN" + } + }, + "ME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ME" + } + }, + "MS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MS" + } + }, + "MA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MA" + } + }, + "MZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MZ" + } + }, + "MM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MM" + } + }, + "NA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NA" + } + }, + "NR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NR" + } + }, + "NP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NP" + } + }, + "NL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NL" + } + }, + "AN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AN" + } + }, + "NC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NC" + } + }, + "NZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NZ" + } + }, + "NI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NI" + } + }, + "NE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NE" + } + }, + "NG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NG" + } + }, + "NU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NU" + } + }, + "KP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KP" + } + }, + "MP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MP" + } + }, + "NO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO" + } + }, + "OM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OM" + } + }, + "PK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PK" + } + }, + "PW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PW" + } + }, + "PA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PA" + } + }, + "PG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PG" + } + }, + "PY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PY" + } + }, + "PE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PE" + } + }, + "PH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PH" + } + }, + "PN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PN" + } + }, + "PL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PL" + } + }, + "PT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT" + } + }, + "PR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PR" + } + }, + "QA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QA" + } + }, + "CG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CG" + } + }, + "RE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RE" + } + }, + "RO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RO" + } + }, + "RU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RU" + } + }, + "RW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RW" + } + }, + "BL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BL" + } + }, + "SH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SH" + } + }, + "KN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KN" + } + }, + "LC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LC" + } + }, + "MF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MF" + } + }, + "PM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PM" + } + }, + "VC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VC" + } + }, + "WS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WS" + } + }, + "SM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SM" + } + }, + "ST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ST" + } + }, + "SA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SA" + } + }, + "SN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SN" + } + }, + "RS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RS" + } + }, + "SC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SC" + } + }, + "SL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SL" + } + }, + "SG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SG" + } + }, + "SX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SX" + } + }, + "SK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SK" + } + }, + "SI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SI" + } + }, + "SB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SB" + } + }, + "SO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SO" + } + }, + "ZA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZA" + } + }, + "KR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KR" + } + }, + "ES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ES" + } + }, + "LK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LK" + } + }, + "SD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SD" + } + }, + "SR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SR" + } + }, + "SJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SJ" + } + }, + "SZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SZ" + } + }, + "SE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SE" + } + }, + "CH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CH" + } + }, + "SY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SY" + } + }, + "TW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TW" + } + }, + "TJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TJ" + } + }, + "TZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TZ" + } + }, + "TH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TH" + } + }, + "TG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TG" + } + }, + "TK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TK" + } + }, + "TO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TO" + } + }, + "TT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TT" + } + }, + "TN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TN" + } + }, + "TR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TR" + } + }, + "TM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TM" + } + }, + "TC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TC" + } + }, + "TV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TV" + } + }, + "VI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VI" + } + }, + "UG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UG" + } + }, + "UA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UA" + } + }, + "AE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AE" + } + }, + "GB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GB" + } + }, + "US": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US" + } + }, + "UY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UY" + } + }, + "UZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UZ" + } + }, + "VU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VU" + } + }, + "VA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VA" + } + }, + "VE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VE" + } + }, + "VN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VN" + } + }, + "WF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WF" + } + }, + "EH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EH" + } + }, + "YE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YE" + } + }, + "ZM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZM" + } + }, + "ZW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZW" + } + } + } + }, + "com.amazonaws.connect#PhoneNumberCountryCodes": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#PhoneNumberCountryCode" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.connect#PhoneNumberDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + }, + "smithy.api#pattern": "^[\\W\\S_]*$" + } + }, + "com.amazonaws.connect#PhoneNumberId": { + "type": "string" + }, + "com.amazonaws.connect#PhoneNumberPrefix": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\\\+?[0-9]{1,11}$" + } + }, + "com.amazonaws.connect#PhoneNumberQuickConnectConfig": { + "type": "structure", + "members": { + "PhoneNumber": { + "target": "com.amazonaws.connect#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number in E.164 format.

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

Contains information about a phone number for a quick connect.

" + } + }, + "com.amazonaws.connect#PhoneNumberStatus": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.connect#PhoneNumberWorkflowStatus", + "traits": { + "smithy.api#documentation": "

The status.

" + } + }, + "Message": { + "target": "com.amazonaws.connect#PhoneNumberWorkflowMessage", + "traits": { + "smithy.api#documentation": "

The status message.

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

The status of the phone number.

\n " + } + }, + "com.amazonaws.connect#PhoneNumberSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

The identifier of the phone number.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the phone number.

" + } + }, + "PhoneNumber": { + "target": "com.amazonaws.connect#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number.

" + } + }, + "PhoneNumberType": { + "target": "com.amazonaws.connect#PhoneNumberType", + "traits": { + "smithy.api#documentation": "

The type of phone number.

" + } + }, + "PhoneNumberCountryCode": { + "target": "com.amazonaws.connect#PhoneNumberCountryCode", + "traits": { + "smithy.api#documentation": "

The ISO country code.

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

Contains summary information about a phone number for a contact center.

" + } + }, + "com.amazonaws.connect#PhoneNumberSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#PhoneNumberSummary" + } + }, + "com.amazonaws.connect#PhoneNumberType": { + "type": "enum", + "members": { + "TOLL_FREE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOLL_FREE" + } + }, + "DID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DID" + } + } + } + }, + "com.amazonaws.connect#PhoneNumberTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#PhoneNumberType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.connect#PhoneNumberWorkflowMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[\\W\\S_]*$" + } + }, + "com.amazonaws.connect#PhoneNumberWorkflowStatus": { + "type": "enum", + "members": { + "Claimed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLAIMED" + } + }, + "InProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.connect#PhoneType": { + "type": "enum", + "members": { + "SOFT_PHONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOFT_PHONE" + } + }, + "DESK_PHONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESK_PHONE" + } + } + } + }, + "com.amazonaws.connect#Prefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.connect#Priority": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 99 + } + } + }, + "com.amazonaws.connect#ProblemDetail": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.connect#ProblemMessageString", + "traits": { + "smithy.api#documentation": "

The problem detail's message.

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

Information about a problem detail.

" + } + }, + "com.amazonaws.connect#ProblemMessageString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.connect#Problems": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ProblemDetail" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.connect#PromptId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.connect#PromptName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.connect#PromptSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#PromptId", + "traits": { + "smithy.api#documentation": "

The identifier of the prompt.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the prompt.

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

The name of the prompt.

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

Contains information about the prompt.

" + } + }, + "com.amazonaws.connect#PromptSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#PromptSummary" + } + }, + "com.amazonaws.connect#PropertyValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message", + "traits": { + "smithy.api#required": {} + } + }, + "PropertyList": { + "target": "com.amazonaws.connect#PropertyValidationExceptionPropertyList" + } + }, + "traits": { + "smithy.api#documentation": "

The property is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.connect#PropertyValidationExceptionProperty": { + "type": "structure", + "members": { + "PropertyPath": { + "target": "com.amazonaws.connect#String", + "traits": { + "smithy.api#documentation": "

The full property path.

", + "smithy.api#required": {} + } + }, + "Reason": { + "target": "com.amazonaws.connect#PropertyValidationExceptionReason", + "traits": { + "smithy.api#documentation": "

Why the property is not valid.

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

A message describing why the property is not valid.

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

Contains information about why a property is not valid.

" + } + }, + "com.amazonaws.connect#PropertyValidationExceptionPropertyList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#PropertyValidationExceptionProperty" + } + }, + "com.amazonaws.connect#PropertyValidationExceptionReason": { + "type": "enum", + "members": { + "INVALID_FORMAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_FORMAT" + } + }, + "UNIQUE_CONSTRAINT_VIOLATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNIQUE_CONSTRAINT_VIOLATED" + } + }, + "REFERENCED_RESOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REFERENCED_RESOURCE_NOT_FOUND" + } + }, + "RESOURCE_NAME_ALREADY_EXISTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_NAME_ALREADY_EXISTS" + } + }, + "REQUIRED_PROPERTY_MISSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUIRED_PROPERTY_MISSING" + } + }, + "NOT_SUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_SUPPORTED" + } + } + } + }, + "com.amazonaws.connect#PutUserStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#PutUserStatusRequest" + }, + "output": { + "target": "com.amazonaws.connect#PutUserStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Changes the current status of a user or agent in Amazon Connect. If the agent is\n currently handling a contact, this sets the agent's next status.

\n

For more information, see Agent status and Set your next\n status in the Amazon Connect Administrator Guide.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/users/{InstanceId}/{UserId}/status", + "code": 200 + } + } + }, + "com.amazonaws.connect#PutUserStatusRequest": { + "type": "structure", + "members": { + "UserId": { + "target": "com.amazonaws.connect#UserId", + "traits": { + "smithy.api#documentation": "

The identifier of the user.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AgentStatusId": { + "target": "com.amazonaws.connect#AgentStatusId", + "traits": { + "smithy.api#documentation": "

The identifier of the agent status.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#PutUserStatusResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.connect#Queue": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#CommonNameLength127", + "traits": { + "smithy.api#documentation": "

The name of the queue.

" + } + }, + "QueueArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the queue.

" + } + }, + "QueueId": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier for the queue.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#QueueDescription", + "traits": { + "smithy.api#documentation": "

The description of the queue.

" + } + }, + "OutboundCallerConfig": { + "target": "com.amazonaws.connect#OutboundCallerConfig", + "traits": { + "smithy.api#documentation": "

The outbound caller ID name, number, and outbound whisper flow.

" + } + }, + "HoursOfOperationId": { + "target": "com.amazonaws.connect#HoursOfOperationId", + "traits": { + "smithy.api#documentation": "

The identifier for the hours of operation.

" + } + }, + "MaxContacts": { + "target": "com.amazonaws.connect#QueueMaxContacts", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of contacts that can be in the queue before it is considered full.

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

The status of the queue.

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

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

Contains information about a queue.

" + } + }, + "com.amazonaws.connect#QueueDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 250 + } + } + }, + "com.amazonaws.connect#QueueId": { + "type": "string" + }, + "com.amazonaws.connect#QueueInfo": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the queue.

" + } + }, + "EnqueueTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the contact was added to the queue.

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

If this contact was queued, this contains information about the queue.

" + } + }, + "com.amazonaws.connect#QueueMaxContacts": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.connect#QueueName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.connect#QueueQuickConnectConfig": { + "type": "structure", + "members": { + "QueueId": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier for the queue.

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

The identifier of the flow.

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

Contains information about a queue for a quick connect. The flow must be of type Transfer to\n Queue.

" + } + }, + "com.amazonaws.connect#QueueReference": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier of the queue.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the queue.

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

Contains information about a queue resource for which metrics are returned.

" + } + }, + "com.amazonaws.connect#QueueSearchConditionList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#QueueSearchCriteria" + } + }, + "com.amazonaws.connect#QueueSearchCriteria": { + "type": "structure", + "members": { + "OrConditions": { + "target": "com.amazonaws.connect#QueueSearchConditionList", + "traits": { + "smithy.api#documentation": "

A list of conditions which would be applied together with an OR condition.

" + } + }, + "AndConditions": { + "target": "com.amazonaws.connect#QueueSearchConditionList", + "traits": { + "smithy.api#documentation": "

A list of conditions which would be applied together with an AND condition.

" + } + }, + "StringCondition": { + "target": "com.amazonaws.connect#StringCondition" + }, + "QueueTypeCondition": { + "target": "com.amazonaws.connect#SearchableQueueType", + "traits": { + "smithy.api#documentation": "

The type of queue.

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

The search criteria to be used to return queues.

\n \n

The name and description fields support \"contains\" queries with\n a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths\n outside of this range will throw invalid results.

\n " + } + }, + "com.amazonaws.connect#QueueSearchFilter": { + "type": "structure", + "members": { + "TagFilter": { + "target": "com.amazonaws.connect#ControlPlaneTagFilter" + } + }, + "traits": { + "smithy.api#documentation": "

Filters to be applied to search results.

" + } + }, + "com.amazonaws.connect#QueueSearchSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#Queue" + } + }, + "com.amazonaws.connect#QueueStatus": { + "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.connect#QueueSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier of the queue.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the queue.

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

The name of the queue.

" + } + }, + "QueueType": { + "target": "com.amazonaws.connect#QueueType", + "traits": { + "smithy.api#documentation": "

The type of queue.

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

Contains summary information about a queue.

" + } + }, + "com.amazonaws.connect#QueueSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#QueueSummary" + } + }, + "com.amazonaws.connect#QueueType": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + }, + "AGENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENT" + } + } + } + }, + "com.amazonaws.connect#QueueTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#QueueType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.connect#Queues": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#QueueId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.connect#QuickConnect": { + "type": "structure", + "members": { + "QuickConnectARN": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the quick connect.

" + } + }, + "QuickConnectId": { + "target": "com.amazonaws.connect#QuickConnectId", + "traits": { + "smithy.api#documentation": "

The identifier for the quick connect.

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

The name of the quick connect.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#QuickConnectDescription", + "traits": { + "smithy.api#documentation": "

The description.

" + } + }, + "QuickConnectConfig": { + "target": "com.amazonaws.connect#QuickConnectConfig", + "traits": { + "smithy.api#documentation": "

Contains information about the quick connect.

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

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

Contains information about a quick connect.

" + } + }, + "com.amazonaws.connect#QuickConnectConfig": { + "type": "structure", + "members": { + "QuickConnectType": { + "target": "com.amazonaws.connect#QuickConnectType", + "traits": { + "smithy.api#documentation": "

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are\n prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

", + "smithy.api#required": {} + } + }, + "UserConfig": { + "target": "com.amazonaws.connect#UserQuickConnectConfig", + "traits": { + "smithy.api#documentation": "

The user configuration. This is required only if QuickConnectType is USER.

" + } + }, + "QueueConfig": { + "target": "com.amazonaws.connect#QueueQuickConnectConfig", + "traits": { + "smithy.api#documentation": "

The queue configuration. This is required only if QuickConnectType is QUEUE.

" + } + }, + "PhoneConfig": { + "target": "com.amazonaws.connect#PhoneNumberQuickConnectConfig", + "traits": { + "smithy.api#documentation": "

The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.

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

Contains configuration settings for a quick connect.

" + } + }, + "com.amazonaws.connect#QuickConnectDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 250 + } + } + }, + "com.amazonaws.connect#QuickConnectId": { + "type": "string" + }, + "com.amazonaws.connect#QuickConnectName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + } + } + }, + "com.amazonaws.connect#QuickConnectSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#QuickConnectId", + "traits": { + "smithy.api#documentation": "

The identifier for the quick connect.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the quick connect.

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

The name of the quick connect.

" + } + }, + "QuickConnectType": { + "target": "com.amazonaws.connect#QuickConnectType", + "traits": { + "smithy.api#documentation": "

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are\n prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

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

Contains summary information about a quick connect.

" + } + }, + "com.amazonaws.connect#QuickConnectSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#QuickConnectSummary" + } + }, + "com.amazonaws.connect#QuickConnectType": { + "type": "enum", + "members": { + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER" + } + }, + "QUEUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUEUE" + } + }, + "PHONE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PHONE_NUMBER" + } + } + } + }, + "com.amazonaws.connect#QuickConnectTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#QuickConnectType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.connect#QuickConnectsList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#QuickConnectId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.connect#ReadOnlyFieldInfo": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#TaskTemplateFieldIdentifier", + "traits": { + "smithy.api#documentation": "

Identifier of the read-only field.

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

Indicates a field that is read-only to an agent.

" + } + }, + "com.amazonaws.connect#ReadOnlyTaskTemplateFields": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ReadOnlyFieldInfo" + } + }, + "com.amazonaws.connect#Reference": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.connect#ReferenceValue", + "traits": { + "smithy.api#documentation": "

A valid value for the reference. For example, for a URL reference, a formatted URL that is\n displayed to an agent in the Contact Control Panel (CCP).

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.connect#ReferenceType", + "traits": { + "smithy.api#documentation": "

The type of the reference. DATE must be of type Epoch timestamp.\n

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

Well-formed data on a contact, used by agents to complete a contact request. You can have up\n to 4,096 UTF-8 bytes across all references for a contact.

" + } + }, + "com.amazonaws.connect#ReferenceKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "com.amazonaws.connect#ReferenceStatus": { + "type": "enum", + "members": { + "APPROVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPROVED" + } + }, + "REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REJECTED" + } + } + } + }, + "com.amazonaws.connect#ReferenceSummary": { + "type": "union", + "members": { + "Url": { + "target": "com.amazonaws.connect#UrlReference", + "traits": { + "smithy.api#documentation": "

Information about the reference when the referenceType is URL.\n Otherwise, null.

" + } + }, + "Attachment": { + "target": "com.amazonaws.connect#AttachmentReference", + "traits": { + "smithy.api#documentation": "

Information about the reference when the referenceType is\n ATTACHMENT. Otherwise, null.

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

Information about a reference when the referenceType is STRING.\n Otherwise, null.

" + } + }, + "Number": { + "target": "com.amazonaws.connect#NumberReference", + "traits": { + "smithy.api#documentation": "

Information about a reference when the referenceType is NUMBER.\n Otherwise, null.

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

Information about a reference when the referenceType is DATE.\n Otherwise, null.

" + } + }, + "Email": { + "target": "com.amazonaws.connect#EmailReference", + "traits": { + "smithy.api#documentation": "

Information about a reference when the referenceType is EMAIL.\n Otherwise, null.

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

Contains summary information about a reference. ReferenceSummary contains only\n one non null field between the URL and attachment based on the reference type.

" + } + }, + "com.amazonaws.connect#ReferenceSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ReferenceSummary" + } + }, + "com.amazonaws.connect#ReferenceType": { + "type": "enum", + "members": { + "URL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "URL" + } + }, + "ATTACHMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATTACHMENT" + } + }, + "NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUMBER" + } + }, + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING" + } + }, + "DATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE" + } + }, + "EMAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL" + } + } + } + }, + "com.amazonaws.connect#ReferenceTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ReferenceType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 6 + } + } + }, + "com.amazonaws.connect#ReferenceValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + } + } + }, + "com.amazonaws.connect#ReleasePhoneNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ReleasePhoneNumberRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#IdempotencyException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#ResourceInUseException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You\n can call this API only in the Amazon Web Services Region where the number was claimed.

\n \n

To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the\n Amazon Connect console.

\n

After releasing a phone number, the phone number enters into a cooldown period of 30 days.\n It cannot be searched for or claimed again until the period has ended. If you accidentally\n release a phone number, contact Amazon Web Services Support.

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/phone-number/{PhoneNumberId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#ReleasePhoneNumberRequest": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the phone number.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.connect#ReplicateInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ReplicateInstanceRequest" + }, + "output": { + "target": "com.amazonaws.connect#ReplicateInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceConflictException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ResourceNotReadyException" + }, + { + "target": "com.amazonaws.connect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Replicates an Amazon Connect instance in the specified Amazon Web Services Region.

\n

For more information about replicating an Amazon Connect instance, see Create\n a replica of your existing Amazon Connect instance in the Amazon Connect\n Administrator Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/instance/{InstanceId}/replicate", + "code": 200 + } + } + }, + "com.amazonaws.connect#ReplicateInstanceRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceIdOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. You can provide the InstanceId, or the entire ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ReplicaRegion": { + "target": "com.amazonaws.connect#AwsRegion", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region where to replicate the Amazon Connect instance.

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

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", + "smithy.api#idempotencyToken": {} + } + }, + "ReplicaAlias": { + "target": "com.amazonaws.connect#DirectoryAlias", + "traits": { + "smithy.api#documentation": "

The alias for the replicated instance. The ReplicaAlias must be unique.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#ReplicateInstanceResponse": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the replicated instance. You can find the instanceId in the\n ARN of the instance. The replicated instance has the same identifier as the instance it was\n replicated from.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicated instance.

" + } + } + } + }, + "com.amazonaws.connect#RequiredFieldInfo": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#TaskTemplateFieldIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier for the field.

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

Information about a required field.

" + } + }, + "com.amazonaws.connect#RequiredTaskTemplateFields": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RequiredFieldInfo" + } + }, + "com.amazonaws.connect#ResourceConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message" + } + }, + "traits": { + "smithy.api#documentation": "

A resource already has that name.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.connect#ResourceInUseException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message" + }, + "ResourceType": { + "target": "com.amazonaws.connect#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of resource.

" + } + }, + "ResourceId": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The identifier for the resource.

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

That resource is already in use. Please try another.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.connect#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message", + "traits": { + "smithy.api#documentation": "

The message about the resource.

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

The specified resource was not found.

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

The resource is not ready.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.connect#ResourceType": { + "type": "enum", + "members": { + "CONTACT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTACT" + } + }, + "CONTACT_FLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTACT_FLOW" + } + }, + "INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE" + } + }, + "PARTICIPANT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARTICIPANT" + } + }, + "HIERARCHY_LEVEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIERARCHY_LEVEL" + } + }, + "HIERARCHY_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIERARCHY_GROUP" + } + }, + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER" + } + } + } + }, + "com.amazonaws.connect#ResumeContactRecording": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ResumeContactRecordingRequest" + }, + "output": { + "target": "com.amazonaws.connect#ResumeContactRecordingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

When a contact is being recorded, and the recording has been suspended using\n SuspendContactRecording, this API resumes recording the call.

\n

Only voice recordings are supported at this time.

", + "smithy.api#http": { + "method": "POST", + "uri": "/contact/resume-recording", + "code": 200 + } + } + }, + "com.amazonaws.connect#ResumeContactRecordingRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The identifier of the contact.

", + "smithy.api#required": {} + } + }, + "InitialContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact. This is the identifier of the contact associated with the\n first interaction with the contact center.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#ResumeContactRecordingResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.connect#RoutingProfile": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The name of the routing profile.

" + } + }, + "RoutingProfileArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the routing profile.

" + } + }, + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the routing profile.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#RoutingProfileDescription", + "traits": { + "smithy.api#documentation": "

The description of the routing profile.

" + } + }, + "MediaConcurrencies": { + "target": "com.amazonaws.connect#MediaConcurrencies", + "traits": { + "smithy.api#documentation": "

The channels agents can handle in the Contact Control Panel (CCP) for this routing\n profile.

" + } + }, + "DefaultOutboundQueueId": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier of the default outbound queue for this routing profile.

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

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

The number of associated queues in routing profile.

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

The number of associated users in routing profile.

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

Contains information about a routing profile.

" + } + }, + "com.amazonaws.connect#RoutingProfileDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 250 + } + } + }, + "com.amazonaws.connect#RoutingProfileId": { + "type": "string" + }, + "com.amazonaws.connect#RoutingProfileList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RoutingProfile" + } + }, + "com.amazonaws.connect#RoutingProfileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + } + } + }, + "com.amazonaws.connect#RoutingProfileQueueConfig": { + "type": "structure", + "members": { + "QueueReference": { + "target": "com.amazonaws.connect#RoutingProfileQueueReference", + "traits": { + "smithy.api#documentation": "

Contains information about a queue resource.

", + "smithy.api#required": {} + } + }, + "Priority": { + "target": "com.amazonaws.connect#Priority", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The order in which contacts are to be handled for the queue. For more information, see\n Queues: priority and\n delay.

", + "smithy.api#required": {} + } + }, + "Delay": { + "target": "com.amazonaws.connect#Delay", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The delay, in seconds, a contact should be in the queue before they are routed to an\n available agent. For more information, see Queues: priority and\n delay in the Amazon Connect Administrator Guide.

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

Contains information about the queue and channel for which priority and delay can be\n set.

" + } + }, + "com.amazonaws.connect#RoutingProfileQueueConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RoutingProfileQueueConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.connect#RoutingProfileQueueConfigSummary": { + "type": "structure", + "members": { + "QueueId": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier for the queue.

", + "smithy.api#required": {} + } + }, + "QueueArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the queue.

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

The name of the queue.

", + "smithy.api#required": {} + } + }, + "Priority": { + "target": "com.amazonaws.connect#Priority", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The order in which contacts are to be handled for the queue. For more information, see\n Queues: priority and\n delay.

", + "smithy.api#required": {} + } + }, + "Delay": { + "target": "com.amazonaws.connect#Delay", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The delay, in seconds, that a contact should be in the queue before they are routed to an\n available agent. For more information, see Queues: priority and\n delay in the Amazon Connect Administrator Guide.

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

The channels this queue supports.

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

Contains summary information about a routing profile queue.

" + } + }, + "com.amazonaws.connect#RoutingProfileQueueConfigSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RoutingProfileQueueConfigSummary" + } + }, + "com.amazonaws.connect#RoutingProfileQueueReference": { + "type": "structure", + "members": { + "QueueId": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier for the queue.

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

The channels agents can handle in the Contact Control Panel (CCP) for this routing\n profile.

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

Contains the channel and queue identifier for a routing profile.

" + } + }, + "com.amazonaws.connect#RoutingProfileQueueReferenceList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RoutingProfileQueueReference" + } + }, + "com.amazonaws.connect#RoutingProfileReference": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the routing profile.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the routing profile.

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

Information about the routing profile assigned to the user.

" + } + }, + "com.amazonaws.connect#RoutingProfileSearchConditionList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RoutingProfileSearchCriteria" + } + }, + "com.amazonaws.connect#RoutingProfileSearchCriteria": { + "type": "structure", + "members": { + "OrConditions": { + "target": "com.amazonaws.connect#RoutingProfileSearchConditionList", + "traits": { + "smithy.api#documentation": "

A list of conditions which would be applied together with an OR condition.

" + } + }, + "AndConditions": { + "target": "com.amazonaws.connect#RoutingProfileSearchConditionList", + "traits": { + "smithy.api#documentation": "

A list of conditions which would be applied together with an AND condition.

" + } + }, + "StringCondition": { + "target": "com.amazonaws.connect#StringCondition" + } + }, + "traits": { + "smithy.api#documentation": "

The search criteria to be used to return routing profiles.

\n \n

The name and description fields support \"contains\" queries with\n a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths\n outside of this range will throw invalid results.

\n " + } + }, + "com.amazonaws.connect#RoutingProfileSearchFilter": { + "type": "structure", + "members": { + "TagFilter": { + "target": "com.amazonaws.connect#ControlPlaneTagFilter" + } + }, + "traits": { + "smithy.api#documentation": "

Filters to be applied to search results.

" + } + }, + "com.amazonaws.connect#RoutingProfileSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the routing profile.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the routing profile.

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

The name of the routing profile.

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

Contains summary information about a routing profile.

" + } + }, + "com.amazonaws.connect#RoutingProfileSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RoutingProfileSummary" + } + }, + "com.amazonaws.connect#RoutingProfiles": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RoutingProfileId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.connect#Rule": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#RuleName", + "traits": { + "smithy.api#documentation": "

The name of the rule.

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

A unique identifier for the rule.

", + "smithy.api#required": {} + } + }, + "RuleArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule.

", + "smithy.api#required": {} + } + }, + "TriggerEventSource": { + "target": "com.amazonaws.connect#RuleTriggerEventSource", + "traits": { + "smithy.api#documentation": "

The event source to trigger the rule.

", + "smithy.api#required": {} + } + }, + "Function": { + "target": "com.amazonaws.connect#RuleFunction", + "traits": { + "smithy.api#documentation": "

The conditions of the rule.

", + "smithy.api#required": {} + } + }, + "Actions": { + "target": "com.amazonaws.connect#RuleActions", + "traits": { + "smithy.api#documentation": "

A list of actions to be run when the rule is triggered.

", + "smithy.api#required": {} + } + }, + "PublishStatus": { + "target": "com.amazonaws.connect#RulePublishStatus", + "traits": { + "smithy.api#documentation": "

The publish status of the rule.

", + "smithy.api#required": {} + } + }, + "CreatedTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp for when the rule was created.

", + "smithy.api#required": {} + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp for the when the rule was last updated.

", + "smithy.api#required": {} + } + }, + "LastUpdatedBy": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who last updated the rule.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

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

Information about a rule.

" + } + }, + "com.amazonaws.connect#RuleAction": { + "type": "structure", + "members": { + "ActionType": { + "target": "com.amazonaws.connect#ActionType", + "traits": { + "smithy.api#documentation": "

The type of action that creates a rule.

", + "smithy.api#required": {} + } + }, + "TaskAction": { + "target": "com.amazonaws.connect#TaskActionDefinition", + "traits": { + "smithy.api#documentation": "

Information about the task action. This field is required if TriggerEventSource\n is one of the following values: OnZendeskTicketCreate |\n OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate\n

" + } + }, + "EventBridgeAction": { + "target": "com.amazonaws.connect#EventBridgeActionDefinition", + "traits": { + "smithy.api#documentation": "

Information about the EventBridge action.

" + } + }, + "AssignContactCategoryAction": { + "target": "com.amazonaws.connect#AssignContactCategoryActionDefinition", + "traits": { + "smithy.api#documentation": "

Information about the contact category action.

" + } + }, + "SendNotificationAction": { + "target": "com.amazonaws.connect#SendNotificationActionDefinition", + "traits": { + "smithy.api#documentation": "

Information about the send notification action.

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

Information about the action to be performed when a rule is triggered.

" + } + }, + "com.amazonaws.connect#RuleActions": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RuleAction" + } + }, + "com.amazonaws.connect#RuleFunction": { + "type": "string" + }, + "com.amazonaws.connect#RuleId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.connect#RuleName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[0-9a-zA-Z._-]+$" + } + }, + "com.amazonaws.connect#RulePublishStatus": { + "type": "enum", + "members": { + "DRAFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DRAFT" + } + }, + "PUBLISHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUBLISHED" + } + } + } + }, + "com.amazonaws.connect#RuleSummary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#RuleName", + "traits": { + "smithy.api#documentation": "

The name of the rule.

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

A unique identifier for the rule.

", + "smithy.api#required": {} + } + }, + "RuleArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule.

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

The name of the event source.

", + "smithy.api#required": {} + } + }, + "PublishStatus": { + "target": "com.amazonaws.connect#RulePublishStatus", + "traits": { + "smithy.api#documentation": "

The publish status of the rule.

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

A list of ActionTypes associated with a rule.

", + "smithy.api#required": {} + } + }, + "CreatedTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp for when the rule was created.

", + "smithy.api#required": {} + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp for when the rule was last updated.

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

A list of ActionTypes associated with a rule.

" + } + }, + "com.amazonaws.connect#RuleSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RuleSummary" + } + }, + "com.amazonaws.connect#RuleTriggerEventSource": { + "type": "structure", + "members": { + "EventSourceName": { + "target": "com.amazonaws.connect#EventSourceName", + "traits": { + "smithy.api#documentation": "

The name of the event source.

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

The identifier for the integration association.

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

The name of the event source. This field is required if TriggerEventSource is one of the\n following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate |\n OnSalesforceCaseCreate\n

" + } + }, + "com.amazonaws.connect#S3Config": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.connect#BucketName", + "traits": { + "smithy.api#documentation": "

The S3 bucket name.

", + "smithy.api#required": {} + } + }, + "BucketPrefix": { + "target": "com.amazonaws.connect#Prefix", + "traits": { + "smithy.api#documentation": "

The S3 bucket prefix.

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

The Amazon S3 encryption configuration.

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

Information about the Amazon Simple Storage Service (Amazon S3) storage type.

" + } + }, + "com.amazonaws.connect#SearchAvailablePhoneNumbers": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#SearchAvailablePhoneNumbersRequest" + }, + "output": { + "target": "com.amazonaws.connect#SearchAvailablePhoneNumbersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Searches for available phone numbers that you can claim to your Amazon Connect instance\n or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both\n Amazon Web Services Regions associated with the traffic distribution group.

", + "smithy.api#http": { + "method": "POST", + "uri": "/phone-number/search-available", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AvailableNumbersList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#SearchAvailablePhoneNumbersRequest": { + "type": "structure", + "members": { + "TargetArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

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

The ISO country code.

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

The type of phone number.

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

The prefix of the phone number. If provided, it must contain + as part of the country code.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult10", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#SearchAvailablePhoneNumbersResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.connect#LargeNextToken", + "traits": { + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" + } + }, + "AvailableNumbersList": { + "target": "com.amazonaws.connect#AvailableNumbersList", + "traits": { + "smithy.api#documentation": "

A list of available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.

" + } + } + } + }, + "com.amazonaws.connect#SearchQueues": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#SearchQueuesRequest" + }, + "output": { + "target": "com.amazonaws.connect#SearchQueuesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Searches queues in an Amazon Connect instance, with optional filtering.

", + "smithy.api#http": { + "method": "POST", + "uri": "/search-queues", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Queues", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#SearchQueuesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page.

" + } + }, + "SearchFilter": { + "target": "com.amazonaws.connect#QueueSearchFilter", + "traits": { + "smithy.api#documentation": "

Filters to be applied to search results.

" + } + }, + "SearchCriteria": { + "target": "com.amazonaws.connect#QueueSearchCriteria", + "traits": { + "smithy.api#documentation": "

The search criteria to be used to return queues.

\n \n

The name and description fields support \"contains\" queries with\n a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths\n outside of this range will throw invalid results.

\n " + } + } + } + }, + "com.amazonaws.connect#SearchQueuesResponse": { + "type": "structure", + "members": { + "Queues": { + "target": "com.amazonaws.connect#QueueSearchSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the queues.

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

If there are additional results, this is the token for the next set of results.

" + } + }, + "ApproximateTotalCount": { + "target": "com.amazonaws.connect#ApproximateTotalCount", + "traits": { + "smithy.api#documentation": "

The total number of queues which matched your search query.

" + } + } + } + }, + "com.amazonaws.connect#SearchRoutingProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#SearchRoutingProfilesRequest" + }, + "output": { + "target": "com.amazonaws.connect#SearchRoutingProfilesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Searches routing profiles in an Amazon Connect instance, with optional filtering.

", + "smithy.api#http": { + "method": "POST", + "uri": "/search-routing-profiles", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "RoutingProfiles", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#SearchRoutingProfilesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page.

" + } + }, + "SearchFilter": { + "target": "com.amazonaws.connect#RoutingProfileSearchFilter", + "traits": { + "smithy.api#documentation": "

Filters to be applied to search results.

" + } + }, + "SearchCriteria": { + "target": "com.amazonaws.connect#RoutingProfileSearchCriteria", + "traits": { + "smithy.api#documentation": "

The search criteria to be used to return routing profiles.

\n \n

The name and description fields support \"contains\" queries with\n a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths\n outside of this range will throw invalid results.

\n " + } + } + } + }, + "com.amazonaws.connect#SearchRoutingProfilesResponse": { + "type": "structure", + "members": { + "RoutingProfiles": { + "target": "com.amazonaws.connect#RoutingProfileList", + "traits": { + "smithy.api#documentation": "

Information about the routing profiles.

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

If there are additional results, this is the token for the next set of results.

" + } + }, + "ApproximateTotalCount": { + "target": "com.amazonaws.connect#ApproximateTotalCount", + "traits": { + "smithy.api#documentation": "

The total number of routing profiles which matched your search query.

" + } + } + } + }, + "com.amazonaws.connect#SearchSecurityProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#SearchSecurityProfilesRequest" + }, + "output": { + "target": "com.amazonaws.connect#SearchSecurityProfilesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Searches security profiles in an Amazon Connect instance, with optional\n filtering.

", + "smithy.api#http": { + "method": "POST", + "uri": "/search-security-profiles", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SecurityProfiles", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#SearchSecurityProfilesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page.

" + } + }, + "SearchCriteria": { + "target": "com.amazonaws.connect#SecurityProfileSearchCriteria", + "traits": { + "smithy.api#documentation": "

The search criteria to be used to return security profiles.

\n \n

The name field support \"contains\" queries with a minimum of 2 characters and\n maximum of 25 characters. Any queries with character lengths outside of this range will throw\n invalid results.

\n \n \n

The currently supported value for FieldName: name\n

\n " + } + }, + "SearchFilter": { + "target": "com.amazonaws.connect#SecurityProfilesSearchFilter", + "traits": { + "smithy.api#documentation": "

Filters to be applied to search results.

" + } + } + } + }, + "com.amazonaws.connect#SearchSecurityProfilesResponse": { + "type": "structure", + "members": { + "SecurityProfiles": { + "target": "com.amazonaws.connect#SecurityProfilesSearchSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the security profiles.

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

If there are additional results, this is the token for the next set of results.

" + } + }, + "ApproximateTotalCount": { + "target": "com.amazonaws.connect#ApproximateTotalCount", + "traits": { + "smithy.api#documentation": "

The total number of security profiles which matched your search query.

" + } + } + } + }, + "com.amazonaws.connect#SearchUsers": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#SearchUsersRequest" + }, + "output": { + "target": "com.amazonaws.connect#SearchUsersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Searches users in an Amazon Connect instance, with optional filtering.

\n \n

\n AfterContactWorkTimeLimit is returned in milliseconds.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/search-users", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Users", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#SearchUsersRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return per page.

" + } + }, + "SearchFilter": { + "target": "com.amazonaws.connect#UserSearchFilter", + "traits": { + "smithy.api#documentation": "

Filters to be applied to search results.

" + } + }, + "SearchCriteria": { + "target": "com.amazonaws.connect#UserSearchCriteria" + } + } + }, + "com.amazonaws.connect#SearchUsersResponse": { + "type": "structure", + "members": { + "Users": { + "target": "com.amazonaws.connect#UserSearchSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the users.

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

If there are additional results, this is the token for the next set of results.

" + } + }, + "ApproximateTotalCount": { + "target": "com.amazonaws.connect#ApproximateTotalCount", + "traits": { + "smithy.api#documentation": "

The total number of users who matched your search query.

" + } + } + } + }, + "com.amazonaws.connect#SearchVocabularies": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#SearchVocabulariesRequest" + }, + "output": { + "target": "com.amazonaws.connect#SearchVocabulariesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Searches for vocabularies within a specific Amazon Connect instance using\n State, NameStartsWith, and LanguageCode.

", + "smithy.api#http": { + "method": "POST", + "uri": "/vocabulary-summary/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "VocabularySummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#SearchVocabulariesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of results to return per page.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" + } + }, + "State": { + "target": "com.amazonaws.connect#VocabularyState", + "traits": { + "smithy.api#documentation": "

The current state of the custom vocabulary.

" + } + }, + "NameStartsWith": { + "target": "com.amazonaws.connect#VocabularyName", + "traits": { + "smithy.api#documentation": "

The starting pattern of the name of the vocabulary.

" + } + }, + "LanguageCode": { + "target": "com.amazonaws.connect#VocabularyLanguageCode", + "traits": { + "smithy.api#documentation": "

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see \nWhat is Amazon Transcribe?\n

" + } + } + } + }, + "com.amazonaws.connect#SearchVocabulariesResponse": { + "type": "structure", + "members": { + "VocabularySummaryList": { + "target": "com.amazonaws.connect#VocabularySummaryList", + "traits": { + "smithy.api#documentation": "

The list of the available custom vocabularies.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#SearchableQueueType": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + } + } + }, + "com.amazonaws.connect#SecurityKey": { + "type": "structure", + "members": { + "AssociationId": { + "target": "com.amazonaws.connect#AssociationId", + "traits": { + "smithy.api#documentation": "

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

" + } + }, + "Key": { + "target": "com.amazonaws.connect#PEM", + "traits": { + "smithy.api#documentation": "

The key of the security key.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

When the security key was created.

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

Configuration information of the security key.

" + } + }, + "com.amazonaws.connect#SecurityKeysList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#SecurityKey" + } + }, + "com.amazonaws.connect#SecurityProfile": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#SecurityProfileId", + "traits": { + "smithy.api#documentation": "

The identifier for the security profile.

" + } + }, + "OrganizationResourceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The organization resource identifier for the security profile.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the secruity profile.

" + } + }, + "SecurityProfileName": { + "target": "com.amazonaws.connect#SecurityProfileName", + "traits": { + "smithy.api#documentation": "

The name for the security profile.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#SecurityProfileDescription", + "traits": { + "smithy.api#documentation": "

The description of the security profile.

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" + } + }, + "AllowedAccessControlTags": { + "target": "com.amazonaws.connect#AllowedAccessControlTags", + "traits": { + "smithy.api#documentation": "

The list of tags that a security profile uses to restrict access to resources in Amazon Connect.

" + } + }, + "TagRestrictedResources": { + "target": "com.amazonaws.connect#TagRestrictedResourceList", + "traits": { + "smithy.api#documentation": "

The list of resources that a security profile applies tag restrictions to in Amazon Connect.

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

Contains information about a security profile.

" + } + }, + "com.amazonaws.connect#SecurityProfileDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 250 + } + } + }, + "com.amazonaws.connect#SecurityProfileId": { + "type": "string" + }, + "com.amazonaws.connect#SecurityProfileIds": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#SecurityProfileId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.connect#SecurityProfileName": { + "type": "string" + }, + "com.amazonaws.connect#SecurityProfilePermission": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.connect#SecurityProfilePolicyKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.connect#SecurityProfilePolicyValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.connect#SecurityProfileSearchConditionList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#SecurityProfileSearchCriteria" + } + }, + "com.amazonaws.connect#SecurityProfileSearchCriteria": { + "type": "structure", + "members": { + "OrConditions": { + "target": "com.amazonaws.connect#SecurityProfileSearchConditionList", + "traits": { + "smithy.api#documentation": "

A list of conditions which would be applied together with an OR condition.

" + } + }, + "AndConditions": { + "target": "com.amazonaws.connect#SecurityProfileSearchConditionList", + "traits": { + "smithy.api#documentation": "

A list of conditions which would be applied together with an AND condition.

" + } + }, + "StringCondition": { + "target": "com.amazonaws.connect#StringCondition" + } + }, + "traits": { + "smithy.api#documentation": "

The search criteria to be used to return security profiles.

\n \n

The name field support \"contains\" queries with a minimum of 2 characters and\n maximum of 25 characters. Any queries with character lengths outside of this range will throw\n invalid results.

\n " + } + }, + "com.amazonaws.connect#SecurityProfileSearchSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#SecurityProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the security profile.

" + } + }, + "OrganizationResourceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The organization resource identifier.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the security profile.

" + } + }, + "SecurityProfileName": { + "target": "com.amazonaws.connect#SecurityProfileName", + "traits": { + "smithy.api#documentation": "

The name of the security profile.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#SecurityProfileDescription", + "traits": { + "smithy.api#documentation": "

The description of the security profile.

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

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

Information about the returned security profiles.

" + } + }, + "com.amazonaws.connect#SecurityProfileSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#SecurityProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the security profile.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the security profile.

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

The name of the security profile.

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

Contains information about a security profile.

" + } + }, + "com.amazonaws.connect#SecurityProfileSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#SecurityProfileSummary" + } + }, + "com.amazonaws.connect#SecurityProfilesSearchFilter": { + "type": "structure", + "members": { + "TagFilter": { + "target": "com.amazonaws.connect#ControlPlaneTagFilter" + } + }, + "traits": { + "smithy.api#documentation": "

Filters to be applied to search results.

" + } + }, + "com.amazonaws.connect#SecurityProfilesSearchSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#SecurityProfileSearchSummary" + } + }, + "com.amazonaws.connect#SecurityToken": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.connect#SendNotificationActionDefinition": { + "type": "structure", + "members": { + "DeliveryMethod": { + "target": "com.amazonaws.connect#NotificationDeliveryType", + "traits": { + "smithy.api#documentation": "

Notification delivery method.

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

The subject of the email if the delivery method is EMAIL.\n Supports variable injection. For more information, see \nJSONPath reference \nin the Amazon Connect Administrators Guide.

" + } + }, + "Content": { + "target": "com.amazonaws.connect#Content", + "traits": { + "smithy.api#documentation": "

Notification content. Supports variable injection. For more information, see \nJSONPath reference \nin the Amazon Connect Administrators Guide.

", + "smithy.api#required": {} + } + }, + "ContentType": { + "target": "com.amazonaws.connect#NotificationContentType", + "traits": { + "smithy.api#documentation": "

Content type format.

", + "smithy.api#required": {} + } + }, + "Recipient": { + "target": "com.amazonaws.connect#NotificationRecipientType", + "traits": { + "smithy.api#documentation": "

Notification recipient.

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

Information about the send notification action.

" + } + }, + "com.amazonaws.connect#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message" + } + }, + "traits": { + "smithy.api#documentation": "

The service quota has been exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.connect#SingleSelectOptions": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#TaskTemplateSingleSelectOption" + } + }, + "com.amazonaws.connect#SnapshotVersion": { + "type": "string" + }, + "com.amazonaws.connect#SortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASCENDING" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESCENDING" + } + } + } + }, + "com.amazonaws.connect#SourceApplicationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_ -]+$" + } + }, + "com.amazonaws.connect#SourceType": { + "type": "enum", + "members": { + "SALESFORCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SALESFORCE" + } + }, + "ZENDESK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZENDESK" + } + } + } + }, + "com.amazonaws.connect#StartChatContact": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#StartChatContactRequest" + }, + "output": { + "target": "com.amazonaws.connect#StartChatContactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Initiates a flow to start a new chat for the customer. Response of this API provides a token\n required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.

\n

When a new chat contact is successfully created, clients must subscribe to the participantā€™s\n connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.

\n

A 429 error occurs in the following situations:

\n \n

If you use the ChatDurationInMinutes parameter and receive a 400 error, your\n account may not support the ability to configure custom chat durations. For more information,\n contact Amazon Web Services Support.

\n

For more information about chat, see Chat in the Amazon Connect\n Administrator Guide.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/contact/chat", + "code": 200 + } + } + }, + "com.amazonaws.connect#StartChatContactRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The identifier of the flow for initiating the chat.\n To\n see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go\n to Routing, Contact Flows.\n Choose the flow. On the flow page, under the name of the flow, choose Show\n additional flow information. The ContactFlowId is the last part of the ARN, shown\n here in bold:

\n

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n

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

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes.

\n

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys\n can include only alphanumeric, dash, and underscore characters.

" + } + }, + "ParticipantDetails": { + "target": "com.amazonaws.connect#ParticipantDetails", + "traits": { + "smithy.api#documentation": "

Information identifying the participant.

", + "smithy.api#required": {} + } + }, + "InitialMessage": { + "target": "com.amazonaws.connect#ChatMessage", + "traits": { + "smithy.api#documentation": "

The initial message to be sent to the newly created chat.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", + "smithy.api#idempotencyToken": {} + } + }, + "ChatDurationInMinutes": { + "target": "com.amazonaws.connect#ChatDurationInMinutes", + "traits": { + "smithy.api#documentation": "

The total duration of the newly started chat session. If not specified, the chat session\n duration defaults to 25 hour. The minumum configurable time is 60 minutes. The maximum\n configurable time is 10,080 minutes (7 days).

" + } + }, + "SupportedMessagingContentTypes": { + "target": "com.amazonaws.connect#SupportedMessagingContentTypes", + "traits": { + "smithy.api#documentation": "

The supported chat message content types. Content types must always contain text/plain. You\n can then put any other supported type in the list. For example, all the following lists are valid\n because they contain text/plain: [text/plain, text/markdown, application/json], [text/markdown,\n text/plain], [text/plain, application/json].

" + } + } + } + }, + "com.amazonaws.connect#StartChatContactResponse": { + "type": "structure", + "members": { + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of this contact within the Amazon Connect instance.

" + } + }, + "ParticipantId": { + "target": "com.amazonaws.connect#ParticipantId", + "traits": { + "smithy.api#documentation": "

The identifier for a chat participant. The participantId for a chat participant is the same\n throughout the chat lifecycle.

" + } + }, + "ParticipantToken": { + "target": "com.amazonaws.connect#ParticipantToken", + "traits": { + "smithy.api#documentation": "

The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat\n participant.

" + } + } + } + }, + "com.amazonaws.connect#StartContactRecording": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#StartContactRecordingRequest" + }, + "output": { + "target": "com.amazonaws.connect#StartContactRecordingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts recording the contact:

\n \n

StartContactRecording is a one-time action. For example, if you use StopContactRecording to\n stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios\n where the recording has started and you want to suspend and resume it, such as when collecting\n sensitive information (for example, a credit card number), use SuspendContactRecording and\n ResumeContactRecording.

\n

You can use this API to override the recording behavior configured in the Set recording\n behavior block.

\n

Only voice recordings are supported at this time.

", + "smithy.api#http": { + "method": "POST", + "uri": "/contact/start-recording", + "code": 200 + } + } + }, + "com.amazonaws.connect#StartContactRecordingRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The identifier of the contact.

", + "smithy.api#required": {} + } + }, + "InitialContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact. This is the identifier of the contact associated with the\n first interaction with the contact center.

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

The person being recorded.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#StartContactRecordingResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.connect#StartContactStreaming": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#StartContactStreamingRequest" + }, + "output": { + "target": "com.amazonaws.connect#StartContactStreamingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Initiates real-time message streaming for a new chat contact.

\n

For more information about message streaming, see Enable real-time chat message\n streaming in the Amazon Connect Administrator Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/contact/start-streaming", + "code": 200 + } + } + }, + "com.amazonaws.connect#StartContactStreamingRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The identifier of the contact. This is the identifier of the contact associated with the\n first interaction with the contact center.

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

The streaming configuration, such as the Amazon SNS streaming endpoint.

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

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#StartContactStreamingResponse": { + "type": "structure", + "members": { + "StreamingId": { + "target": "com.amazonaws.connect#StreamingId", + "traits": { + "smithy.api#documentation": "

The identifier of the streaming configuration enabled.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#StartOutboundVoiceContact": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#StartOutboundVoiceContactRequest" + }, + "output": { + "target": "com.amazonaws.connect#StartOutboundVoiceContactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#DestinationNotAllowedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, + { + "target": "com.amazonaws.connect#OutboundContactNotPermittedException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Places an outbound call to a contact, and then initiates the flow. It performs the actions\n in the flow that's specified (in ContactFlowId).

\n

Agents do not initiate the outbound API, which means that they do not dial the contact. If\n the flow places an outbound call to a contact, and then puts the contact in queue, the call is\n then routed to the agent, like any other inbound case.

\n

There is a 60-second dialing timeout for this operation. If the call is not connected after\n 60 seconds, it fails.

\n \n

UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK\n mobile numbers, you must submit a service quota increase request. For more information, see\n Amazon Connect Service Quotas in the Amazon Connect Administrator\n Guide.

\n \n \n

Campaign calls are not allowed by default. Before you can make a call with\n TrafficType = CAMPAIGN, you must submit a service quota increase\n request to the quota Amazon Connect campaigns.

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/contact/outbound-voice", + "code": 200 + } + } + }, + "com.amazonaws.connect#StartOutboundVoiceContactRequest": { + "type": "structure", + "members": { + "DestinationPhoneNumber": { + "target": "com.amazonaws.connect#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number of the customer, in E.164 format.

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

The\n identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect\n console user interface, on the navigation menu go to Routing,\n Contact Flows. Choose the flow. On the flow page, under the\n name of the flow, choose Show additional flow information. The\n ContactFlowId is the last part of the ARN, shown here in bold:

\n

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started,\n the contact ID is returned.\n

", + "smithy.api#idempotencyToken": {} + } + }, + "SourcePhoneNumber": { + "target": "com.amazonaws.connect#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number associated with the Amazon Connect instance, in E.164 format. If you do\n not specify a source phone number, you must specify a queue.

" + } + }, + "QueueId": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The queue for the call. If you specify a queue, the phone displayed for caller ID is the\n phone number specified in the queue. If you do not specify a queue, the queue defined in the flow\n is used. If you do not specify a queue, you must specify a source phone number.

" + } + }, + "Attributes": { + "target": "com.amazonaws.connect#Attributes", + "traits": { + "smithy.api#documentation": "

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

\n

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys\n can include only alphanumeric, dash, and underscore characters.

" + } + }, + "AnswerMachineDetectionConfig": { + "target": "com.amazonaws.connect#AnswerMachineDetectionConfig", + "traits": { + "smithy.api#documentation": "

Configuration of the answering machine detection for this outbound call.

" + } + }, + "CampaignId": { + "target": "com.amazonaws.connect#CampaignId", + "traits": { + "smithy.api#documentation": "

The campaign identifier of the outbound communication.

" + } + }, + "TrafficType": { + "target": "com.amazonaws.connect#TrafficType", + "traits": { + "smithy.api#documentation": "

Denotes the class of traffic. Calls with different traffic types are handled differently by\n Amazon Connect. The default value is GENERAL. Use CAMPAIGN if\n EnableAnswerMachineDetection is set to true. For all other cases, use\n GENERAL.

" + } + } + } + }, + "com.amazonaws.connect#StartOutboundVoiceContactResponse": { + "type": "structure", + "members": { + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of this contact within the Amazon Connect instance.

" + } + } + } + }, + "com.amazonaws.connect#StartTaskContact": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#StartTaskContactRequest" + }, + "output": { + "target": "com.amazonaws.connect#StartTaskContactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Initiates a flow to start a new task.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/contact/task", + "code": 200 + } + } + }, + "com.amazonaws.connect#StartTaskContactRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#required": {} + } + }, + "PreviousContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the previous chat, voice, or task contact.

" + } + }, + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the\n flow page, under the name of the flow, choose Show additional flow\n information. The ContactFlowId is the last part of the ARN, shown here in bold:

\n

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n

" + } + }, + "Attributes": { + "target": "com.amazonaws.connect#Attributes", + "traits": { + "smithy.api#documentation": "

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

\n

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys\n can include only alphanumeric, dash, and underscore characters.

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

The name of a task that is shown to an agent in the Contact Control Panel (CCP).

", + "smithy.api#required": {} + } + }, + "References": { + "target": "com.amazonaws.connect#ContactReferences", + "traits": { + "smithy.api#documentation": "

A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

" + } + }, + "Description": { + "target": "com.amazonaws.connect#Description", + "traits": { + "smithy.api#documentation": "

A description of the task that is shown to an agent in the Contact Control Panel\n (CCP).

" + } + }, + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", + "smithy.api#idempotencyToken": {} + } + }, + "ScheduledTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

" + } + }, + "TaskTemplateId": { + "target": "com.amazonaws.connect#TaskTemplateId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the task template.

" + } + }, + "QuickConnectId": { + "target": "com.amazonaws.connect#QuickConnectId", + "traits": { + "smithy.api#documentation": "

The identifier for the quick connect.

" + } + } + } + }, + "com.amazonaws.connect#StartTaskContactResponse": { + "type": "structure", + "members": { + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of this contact within the Amazon Connect instance.

" + } + } + } + }, + "com.amazonaws.connect#Statistic": { + "type": "enum", + "members": { + "SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUM" + } + }, + "MAX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX" + } + }, + "AVG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVG" + } + } + } + }, + "com.amazonaws.connect#StopContact": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#StopContactRequest" + }, + "output": { + "target": "com.amazonaws.connect#StopContactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#ContactNotFoundException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Ends the specified contact. This call does not work for the following initiation\n methods:

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/contact/stop", + "code": 200 + } + } + }, + "com.amazonaws.connect#StopContactRecording": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#StopContactRecordingRequest" + }, + "output": { + "target": "com.amazonaws.connect#StopContactRecordingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops recording a call when a contact is being recorded. StopContactRecording is a one-time\n action. If you use StopContactRecording to stop recording an ongoing call, you can't use\n StartContactRecording to restart it. For scenarios where the recording has started and you want\n to suspend it for sensitive information (for example, to collect a credit card number), and then\n restart it, use SuspendContactRecording and ResumeContactRecording.

\n

Only voice recordings are supported at this time.

", + "smithy.api#http": { + "method": "POST", + "uri": "/contact/stop-recording", + "code": 200 + } + } + }, + "com.amazonaws.connect#StopContactRecordingRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The identifier of the contact.

", + "smithy.api#required": {} + } + }, + "InitialContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact. This is the identifier of the contact associated with the\n first interaction with the contact center.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#StopContactRecordingResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.connect#StopContactRequest": { + "type": "structure", + "members": { + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The ID of the contact.

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#StopContactResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.connect#StopContactStreaming": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#StopContactStreamingRequest" + }, + "output": { + "target": "com.amazonaws.connect#StopContactStreamingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Ends message streaming on a specified contact. To restart message streaming on that\n contact, call the StartContactStreaming\n API.

", + "smithy.api#http": { + "method": "POST", + "uri": "/contact/stop-streaming", + "code": 200 + } + } + }, + "com.amazonaws.connect#StopContactStreamingRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The identifier of the contact. This is the identifier of the contact that is associated with\n the first interaction with the contact center.

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

The identifier of the streaming configuration enabled.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#StopContactStreamingResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.connect#StorageType": { + "type": "enum", + "members": { + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + }, + "KINESIS_VIDEO_STREAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KINESIS_VIDEO_STREAM" + } + }, + "KINESIS_STREAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KINESIS_STREAM" + } + }, + "KINESIS_FIREHOSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KINESIS_FIREHOSE" + } + } + } + }, + "com.amazonaws.connect#StreamingId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.connect#String": { + "type": "string" + }, + "com.amazonaws.connect#StringComparisonType": { + "type": "enum", + "members": { + "STARTS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTS_WITH" + } + }, + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS" + } + }, + "EXACT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXACT" + } + } + } + }, + "com.amazonaws.connect#StringCondition": { + "type": "structure", + "members": { + "FieldName": { + "target": "com.amazonaws.connect#String", + "traits": { + "smithy.api#documentation": "

The name of the field in the string condition.

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

The value of the string.

" + } + }, + "ComparisonType": { + "target": "com.amazonaws.connect#StringComparisonType", + "traits": { + "smithy.api#documentation": "

The type of comparison to be made when evaluating the string condition.

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

A leaf node condition which can be used to specify a string condition.

\n \n

The currently supported value for FieldName: name\n

\n " + } + }, + "com.amazonaws.connect#StringReference": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#ReferenceKey", + "traits": { + "smithy.api#documentation": "

Identifier of the string reference.

" + } + }, + "Value": { + "target": "com.amazonaws.connect#ReferenceValue", + "traits": { + "smithy.api#documentation": "

A valid string.

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

Information about a reference when the referenceType is STRING.\n Otherwise, null.

" + } + }, + "com.amazonaws.connect#Subject": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.connect#SupportedMessagingContentType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.connect#SupportedMessagingContentTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#SupportedMessagingContentType" + } + }, + "com.amazonaws.connect#SuspendContactRecording": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#SuspendContactRecordingRequest" + }, + "output": { + "target": "com.amazonaws.connect#SuspendContactRecordingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

When a contact is being recorded, this API suspends recording the call. For example, you\n might suspend the call recording while collecting sensitive information, such as a credit card\n number. Then use ResumeContactRecording to restart recording.

\n

The period of time that the recording is suspended is filled with silence in the final\n recording.

\n

Only voice recordings are supported at this time.

", + "smithy.api#http": { + "method": "POST", + "uri": "/contact/suspend-recording", + "code": 200 + } + } + }, + "com.amazonaws.connect#SuspendContactRecordingRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The identifier of the contact.

", + "smithy.api#required": {} + } + }, + "InitialContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact. This is the identifier of the contact associated with the\n first interaction with the contact center.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#SuspendContactRecordingResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.connect#TagAndConditionList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#TagCondition" + } + }, + "com.amazonaws.connect#TagCondition": { + "type": "structure", + "members": { + "TagKey": { + "target": "com.amazonaws.connect#String", + "traits": { + "smithy.api#documentation": "

The tag key in the tag condition.

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

The tag value in the tag condition.

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

A leaf node condition which can be used to specify a tag condition, for example, HAVE\n BPO = 123.

" + } + }, + "com.amazonaws.connect#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" + } + }, + "com.amazonaws.connect#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.connect#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.connect#TagKey" + }, + "value": { + "target": "com.amazonaws.connect#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.connect#TagOrConditionList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#TagAndConditionList" + } + }, + "com.amazonaws.connect#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#TagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds the specified tags to the specified resource.

\n

Some of the supported resource types are agents, routing profiles, queues, quick connects,\n contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task\n templates. For a complete list, see Tagging resources in Amazon Connect.

\n

For sample policies that use tags, see Amazon Connect\n Identity-Based Policy Examples in the Amazon Connect Administrator\n Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.connect#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#TagRestrictedResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#TagRestrictedResourceName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.connect#TagRestrictedResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.connect#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.connect#TaskActionDefinition": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#TaskNameExpression", + "traits": { + "smithy.api#documentation": "

The name. Supports variable injection. For more information, see \nJSONPath reference \nin the Amazon Connect Administrators Guide.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.connect#TaskDescriptionExpression", + "traits": { + "smithy.api#documentation": "

The description. Supports variable injection. For more information, see \nJSONPath reference \nin the Amazon Connect Administrators Guide.

" + } + }, + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

The identifier of the flow.

", + "smithy.api#required": {} + } + }, + "References": { + "target": "com.amazonaws.connect#ContactReferences", + "traits": { + "smithy.api#documentation": "

Information about the reference when the referenceType is URL.\n Otherwise, null. (Supports variable injection in the Value field.)

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

Information about the task action.

" + } + }, + "com.amazonaws.connect#TaskDescriptionExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + } + } + }, + "com.amazonaws.connect#TaskNameExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.connect#TaskTemplateArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.connect#TaskTemplateConstraints": { + "type": "structure", + "members": { + "RequiredFields": { + "target": "com.amazonaws.connect#RequiredTaskTemplateFields", + "traits": { + "smithy.api#documentation": "

Lists the fields that are required to be filled by agents.

" + } + }, + "ReadOnlyFields": { + "target": "com.amazonaws.connect#ReadOnlyTaskTemplateFields", + "traits": { + "smithy.api#documentation": "

Lists the fields that are read-only to agents, and cannot be edited.

" + } + }, + "InvisibleFields": { + "target": "com.amazonaws.connect#InvisibleTaskTemplateFields", + "traits": { + "smithy.api#documentation": "

Lists the fields that are invisible to agents.

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

Describes constraints that apply to the template fields.

" + } + }, + "com.amazonaws.connect#TaskTemplateDefaultFieldValue": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#TaskTemplateFieldIdentifier", + "traits": { + "smithy.api#documentation": "

Identifier of a field.

" + } + }, + "DefaultValue": { + "target": "com.amazonaws.connect#TaskTemplateFieldValue", + "traits": { + "smithy.api#documentation": "

Default value for the field.

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

Describes a default field and its corresponding value.

" + } + }, + "com.amazonaws.connect#TaskTemplateDefaultFieldValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#TaskTemplateDefaultFieldValue" + } + }, + "com.amazonaws.connect#TaskTemplateDefaults": { + "type": "structure", + "members": { + "DefaultFieldValues": { + "target": "com.amazonaws.connect#TaskTemplateDefaultFieldValueList", + "traits": { + "smithy.api#documentation": "

Default value for the field.

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

Describes default values for fields on a template.

" + } + }, + "com.amazonaws.connect#TaskTemplateDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.connect#TaskTemplateField": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#TaskTemplateFieldIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier for the field.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.connect#TaskTemplateFieldDescription", + "traits": { + "smithy.api#documentation": "

The description of the field.

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

Indicates the type of field.

" + } + }, + "SingleSelectOptions": { + "target": "com.amazonaws.connect#SingleSelectOptions", + "traits": { + "smithy.api#documentation": "

A list of options for a single select field.

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

Describes a single task template field.

" + } + }, + "com.amazonaws.connect#TaskTemplateFieldDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.connect#TaskTemplateFieldIdentifier": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#TaskTemplateFieldName", + "traits": { + "smithy.api#documentation": "

The name of the task template field.

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

The identifier of the task template field.

" + } + }, + "com.amazonaws.connect#TaskTemplateFieldName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.connect#TaskTemplateFieldType": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + }, + "DESCRIPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESCRIPTION" + } + }, + "SCHEDULED_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCHEDULED_TIME" + } + }, + "QUICK_CONNECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICK_CONNECT" + } + }, + "URL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "URL" + } + }, + "NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUMBER" + } + }, + "TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT" + } + }, + "TEXT_AREA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT_AREA" + } + }, + "DATE_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE_TIME" + } + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOOLEAN" + } + }, + "SINGLE_SELECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_SELECT" + } + }, + "EMAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL" + } + } + } + }, + "com.amazonaws.connect#TaskTemplateFieldValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + } + } + }, + "com.amazonaws.connect#TaskTemplateFields": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#TaskTemplateField" + } + }, + "com.amazonaws.connect#TaskTemplateId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.connect#TaskTemplateList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#TaskTemplateMetadata" + } + }, + "com.amazonaws.connect#TaskTemplateMetadata": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#TaskTemplateId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the task template.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#TaskTemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task template.

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

The name of the task template.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#TaskTemplateDescription", + "traits": { + "smithy.api#documentation": "

The description of the task template.

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

Marks a template as ACTIVE or INACTIVE for a task to refer to it. \nTasks can only be created from ACTIVE templates.\nIf a template is marked as INACTIVE, then a task that refers to this template cannot be created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the task template was last modified.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the task template was created.

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

Contains summary information about the task template.

" + } + }, + "com.amazonaws.connect#TaskTemplateName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.connect#TaskTemplateSingleSelectOption": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.connect#TaskTemplateStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + } + } + }, + "com.amazonaws.connect#TelephonyConfig": { + "type": "structure", + "members": { + "Distributions": { + "target": "com.amazonaws.connect#DistributionList", + "traits": { + "smithy.api#documentation": "

Information about traffic distributions.

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

The distribution of traffic between the instance and its replicas.

" + } + }, + "com.amazonaws.connect#Threshold": { + "type": "structure", + "members": { + "Comparison": { + "target": "com.amazonaws.connect#Comparison", + "traits": { + "smithy.api#documentation": "

The type of comparison. Only \"less than\" (LT) comparisons are supported.

" + } + }, + "ThresholdValue": { + "target": "com.amazonaws.connect#ThresholdValue", + "traits": { + "smithy.api#documentation": "

The threshold value to compare.

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

Contains information about the threshold for service level metrics.

" + } + }, + "com.amazonaws.connect#ThresholdValue": { + "type": "double" + }, + "com.amazonaws.connect#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ThrottlingException", + "httpResponseCode": 429 + }, + "smithy.api#documentation": "

The throttling limit has been exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.connect#TimeZone": { + "type": "string" + }, + "com.amazonaws.connect#TimerEligibleParticipantRoles": { + "type": "enum", + "members": { + "CUSTOMER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOMER" + } + }, + "AGENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENT" + } + } + } + }, + "com.amazonaws.connect#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.connect#TrafficDistributionGroup": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#TrafficDistributionGroupId", + "traits": { + "smithy.api#documentation": "

The identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#TrafficDistributionGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the traffic distribution group.

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

The name of the traffic distribution group.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#Description250", + "traits": { + "smithy.api#documentation": "

The description of the traffic distribution group.

" + } + }, + "InstanceArn": { + "target": "com.amazonaws.connect#InstanceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN).

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

The status of the traffic distribution group.

\n " + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

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

Information about a traffic distribution group.

" + } + }, + "com.amazonaws.connect#TrafficDistributionGroupArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:traffic-distribution-group/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, + "com.amazonaws.connect#TrafficDistributionGroupId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, + "com.amazonaws.connect#TrafficDistributionGroupIdOrArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z-]+-[0-9]{1}:[0-9]{1,20}:traffic-distribution-group/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, + "com.amazonaws.connect#TrafficDistributionGroupStatus": { + "type": "enum", + "members": { + "CREATION_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_IN_PROGRESS" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "CREATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_FAILED" + } + }, + "PENDING_DELETION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_DELETION" + } + }, + "DELETION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETION_FAILED" + } + }, + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_IN_PROGRESS" + } + } + } + }, + "com.amazonaws.connect#TrafficDistributionGroupSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#TrafficDistributionGroupId", + "traits": { + "smithy.api#documentation": "

The identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#TrafficDistributionGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the traffic distribution group.

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

The name of the traffic distribution group.

" + } + }, + "InstanceArn": { + "target": "com.amazonaws.connect#InstanceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the traffic distribution group.

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

The status of the traffic distribution group.

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

Information about traffic distribution groups.

" + } + }, + "com.amazonaws.connect#TrafficDistributionGroupSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#TrafficDistributionGroupSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.connect#TrafficType": { + "type": "enum", + "members": { + "GENERAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GENERAL" + } + }, + "CAMPAIGN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CAMPAIGN" + } + } + } + }, + "com.amazonaws.connect#TransferContact": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#TransferContactRequest" + }, + "output": { + "target": "com.amazonaws.connect#TransferContactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#IdempotencyException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Transfers contacts from one agent or queue to another agent or queue at any point after a\n contact is created. You can transfer a contact to another queue by providing the flow which\n orchestrates the contact to the destination queue. This gives you more control over contact\n handling and helps you adhere to the service level agreement (SLA) guaranteed to your\n customers.

\n

Note the following requirements:

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/contact/transfer", + "code": 200 + } + } + }, + "com.amazonaws.connect#TransferContactRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The identifier of the contact in this instance of Amazon Connect.

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

The identifier for the queue.

" + } + }, + "UserId": { + "target": "com.amazonaws.connect#AgentResourceId", + "traits": { + "smithy.api#documentation": "

The identifier for the user.

" + } + }, + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

The identifier of the flow.

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

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.connect#TransferContactResponse": { + "type": "structure", + "members": { + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact in this instance of Amazon Connect.

" + } + }, + "ContactArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the contact.

" + } + } + } + }, + "com.amazonaws.connect#URI": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 + } + } + }, + "com.amazonaws.connect#Unit": { + "type": "enum", + "members": { + "SECONDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECONDS" + } + }, + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + }, + "PERCENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENT" + } + } + } + }, + "com.amazonaws.connect#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UntagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified tags from the specified resource.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.connect#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.connect#TagKeyList", + "traits": { + "smithy.api#documentation": "

The tag keys.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#UpdateAgentStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateAgentStatusRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates agent status.

", + "smithy.api#http": { + "method": "POST", + "uri": "/agent-status/{InstanceId}/{AgentStatusId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateAgentStatusDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 250 + } + } + }, + "com.amazonaws.connect#UpdateAgentStatusRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AgentStatusId": { + "target": "com.amazonaws.connect#AgentStatusId", + "traits": { + "smithy.api#documentation": "

The identifier of the agent status.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#AgentStatusName", + "traits": { + "smithy.api#documentation": "

The name of the agent status.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#UpdateAgentStatusDescription", + "traits": { + "smithy.api#documentation": "

The description of the agent status.

" + } + }, + "State": { + "target": "com.amazonaws.connect#AgentStatusState", + "traits": { + "smithy.api#documentation": "

The state of the agent status.

" + } + }, + "DisplayOrder": { + "target": "com.amazonaws.connect#AgentStatusOrderNumber", + "traits": { + "smithy.api#documentation": "

The display order of the agent status.

" + } + }, + "ResetOrderNumber": { + "target": "com.amazonaws.connect#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A number indicating the reset order of the agent status.

" + } + } + } + }, + "com.amazonaws.connect#UpdateContact": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateContactRequest" + }, + "output": { + "target": "com.amazonaws.connect#UpdateContactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Adds or updates user-defined contact information associated with the specified contact. At\n least one field to be updated must be present in the request.

\n \n

You can add or update user-defined contact information for both ongoing and completed\n contacts.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/contacts/{InstanceId}/{ContactId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateContactAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateContactAttributesRequest" + }, + "output": { + "target": "com.amazonaws.connect#UpdateContactAttributesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates\n user-defined contact attributes\n associated with the specified contact.

\n

You can create or update user-defined attributes for both ongoing and completed contacts.\n For example, while the call is active, you can update the customer's name or the reason the\n customer called. You can add notes about steps that the agent took during the call that display\n to the next agent that takes the call. You can also update attributes for a contact using data\n from your CRM application and save the data with the contact in Amazon Connect. You could\n also flag calls for additional analysis, such as legal review or to identify abusive\n callers.

\n

Contact attributes are available in Amazon Connect for 24 months, and are then deleted.\n For information about contact record retention and the maximum size of the contact record\n attributes section, see Feature\n specifications in the Amazon Connect Administrator Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/contact/attributes", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateContactAttributesRequest": { + "type": "structure", + "members": { + "InitialContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact. This is the identifier of the contact associated with the\n first interaction with the contact center.

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The Amazon Connect attributes. These attributes can be accessed in flows just like any\n other contact attributes.

\n

You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys\n can include only alphanumeric, dash, and underscore characters.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#UpdateContactAttributesResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.connect#UpdateContactFlowContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateContactFlowContentRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidContactFlowException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the specified flow.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

", + "smithy.api#http": { + "method": "POST", + "uri": "/contact-flows/{InstanceId}/{ContactFlowId}/content", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateContactFlowContentRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

The identifier of the flow.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Content": { + "target": "com.amazonaws.connect#ContactFlowContent", + "traits": { + "smithy.api#documentation": "

The JSON string that represents flow's content. For an example, see Example contact\n flow in Amazon Connect Flow language.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#UpdateContactFlowMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateContactFlowMetadataRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates metadata about specified flow.

", + "smithy.api#http": { + "method": "POST", + "uri": "/contact-flows/{InstanceId}/{ContactFlowId}/metadata", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateContactFlowMetadataRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

The identifier of the flow.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#ContactFlowName", + "traits": { + "smithy.api#documentation": "

The name of the flow.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#ContactFlowDescription", + "traits": { + "smithy.api#documentation": "

The description of the flow.

" + } + }, + "ContactFlowState": { + "target": "com.amazonaws.connect#ContactFlowState", + "traits": { + "smithy.api#documentation": "

The state of flow.

" + } + } + } + }, + "com.amazonaws.connect#UpdateContactFlowModuleContent": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateContactFlowModuleContentRequest" + }, + "output": { + "target": "com.amazonaws.connect#UpdateContactFlowModuleContentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidContactFlowModuleException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates specified flow module for the specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "POST", + "uri": "/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}/content", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateContactFlowModuleContentRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactFlowModuleId": { + "target": "com.amazonaws.connect#ContactFlowModuleId", + "traits": { + "smithy.api#documentation": "

The identifier of the flow module.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Content": { + "target": "com.amazonaws.connect#ContactFlowModuleContent", + "traits": { + "smithy.api#documentation": "

The content of the flow module.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#UpdateContactFlowModuleContentResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.connect#UpdateContactFlowModuleMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateContactFlowModuleMetadataRequest" + }, + "output": { + "target": "com.amazonaws.connect#UpdateContactFlowModuleMetadataResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates metadata about specified flow module.

", + "smithy.api#http": { + "method": "POST", + "uri": "/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}/metadata", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateContactFlowModuleMetadataRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactFlowModuleId": { + "target": "com.amazonaws.connect#ContactFlowModuleId", + "traits": { + "smithy.api#documentation": "

The identifier of the flow module.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#ContactFlowModuleName", + "traits": { + "smithy.api#documentation": "

The name of the flow module.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#ContactFlowModuleDescription", + "traits": { + "smithy.api#documentation": "

The description of the flow module.

" + } + }, + "State": { + "target": "com.amazonaws.connect#ContactFlowModuleState", + "traits": { + "smithy.api#documentation": "

The state of flow module.

" + } + } + } + }, + "com.amazonaws.connect#UpdateContactFlowModuleMetadataResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.connect#UpdateContactFlowName": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateContactFlowNameRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

The name of the flow.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

", + "smithy.api#http": { + "method": "POST", + "uri": "/contact-flows/{InstanceId}/{ContactFlowId}/name", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateContactFlowNameRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

The identifier of the flow.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#ContactFlowName", + "traits": { + "smithy.api#documentation": "

The name of the flow.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#ContactFlowDescription", + "traits": { + "smithy.api#documentation": "

The description of the flow.

" + } + } + } + }, + "com.amazonaws.connect#UpdateContactRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact. This is the identifier of the contact associated with the\n first interaction with your contact center.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#Name", + "traits": { + "smithy.api#documentation": "

The name of the contact.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#Description", + "traits": { + "smithy.api#documentation": "

The description of the contact.

" + } + }, + "References": { + "target": "com.amazonaws.connect#ContactReferences", + "traits": { + "smithy.api#documentation": "

Well-formed data on contact, shown to agents on Contact Control Panel (CCP).

" + } + } + } + }, + "com.amazonaws.connect#UpdateContactResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.connect#UpdateContactSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateContactScheduleRequest" + }, + "output": { + "target": "com.amazonaws.connect#UpdateContactScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the scheduled time of a task contact that is already scheduled.

", + "smithy.api#http": { + "method": "POST", + "uri": "/contact/schedule", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateContactScheduleRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The identifier of the contact.

", + "smithy.api#required": {} + } + }, + "ScheduledTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#UpdateContactScheduleResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.connect#UpdateHoursOfOperation": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateHoursOfOperationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates the hours of operation.

", + "smithy.api#http": { + "method": "POST", + "uri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateHoursOfOperationDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 250 + } + } + }, + "com.amazonaws.connect#UpdateHoursOfOperationRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "HoursOfOperationId": { + "target": "com.amazonaws.connect#HoursOfOperationId", + "traits": { + "smithy.api#documentation": "

The identifier of the hours of operation.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#CommonNameLength127", + "traits": { + "smithy.api#documentation": "

The name of the hours of operation.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#UpdateHoursOfOperationDescription", + "traits": { + "smithy.api#documentation": "

The description of the hours of operation.

" + } + }, + "TimeZone": { + "target": "com.amazonaws.connect#TimeZone", + "traits": { + "smithy.api#documentation": "

The time zone of the hours of operation.

" + } + }, + "Config": { + "target": "com.amazonaws.connect#HoursOfOperationConfigList", + "traits": { + "smithy.api#documentation": "

Configuration information of the hours of operation.

" + } + } + } + }, + "com.amazonaws.connect#UpdateInstanceAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateInstanceAttributeRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates the value for the specified attribute type.

", + "smithy.api#http": { + "method": "POST", + "uri": "/instance/{InstanceId}/attribute/{AttributeType}", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateInstanceAttributeRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AttributeType": { + "target": "com.amazonaws.connect#InstanceAttributeType", + "traits": { + "smithy.api#documentation": "

The type of attribute.

\n \n

Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature,\n contact Amazon Web Services Support for allowlisting.

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.connect#InstanceAttributeValue", + "traits": { + "smithy.api#documentation": "

The value for the attribute. Maximum character limit is 100.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#UpdateInstanceStorageConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateInstanceStorageConfigRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates an existing configuration for a resource type. This API is idempotent.

", + "smithy.api#http": { + "method": "POST", + "uri": "/instance/{InstanceId}/storage-config/{AssociationId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateInstanceStorageConfigRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssociationId": { + "target": "com.amazonaws.connect#AssociationId", + "traits": { + "smithy.api#documentation": "

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.connect#InstanceStorageResourceType", + "traits": { + "smithy.api#documentation": "

A valid resource type.

", + "smithy.api#httpQuery": "resourceType", + "smithy.api#required": {} + } + }, + "StorageConfig": { + "target": "com.amazonaws.connect#InstanceStorageConfig", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#UpdateParticipantRoleConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateParticipantRoleConfigRequest" + }, + "output": { + "target": "com.amazonaws.connect#UpdateParticipantRoleConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates timeouts for when human chat participants are to be considered idle, and when agents\n are automatically disconnected from a chat due to idleness. You can set four timers:

\n \n

For more information about how chat timeouts work, see \n Set up chat timeouts for human participants.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/contact/participant-role-config/{InstanceId}/{ContactId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateParticipantRoleConfigChannelInfo": { + "type": "union", + "members": { + "Chat": { + "target": "com.amazonaws.connect#ChatParticipantRoleConfig", + "traits": { + "smithy.api#documentation": "

Configuration information for the chat participant role.

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

Configuration information for the chat participant role.

" + } + }, + "com.amazonaws.connect#UpdateParticipantRoleConfigRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact in this instance of Amazon Connect.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChannelConfiguration": { + "target": "com.amazonaws.connect#UpdateParticipantRoleConfigChannelInfo", + "traits": { + "smithy.api#documentation": "

The Amazon Connect channel you want to configure.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#UpdateParticipantRoleConfigResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.connect#UpdatePhoneNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdatePhoneNumberRequest" + }, + "output": { + "target": "com.amazonaws.connect#UpdatePhoneNumberResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#IdempotencyException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#ResourceInUseException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to\n another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.

\n \n

You can call DescribePhoneNumber API\n to verify the status of a previous UpdatePhoneNumber\n operation.

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/phone-number/{PhoneNumberId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdatePhoneNumberRequest": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the phone number.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TargetArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

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

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.connect#UpdatePhoneNumberResponse": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the phone number.

" + } + }, + "PhoneNumberArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the phone number.

" + } + } + } + }, + "com.amazonaws.connect#UpdateQueueHoursOfOperation": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateQueueHoursOfOperationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates the hours of operation for the specified queue.

", + "smithy.api#http": { + "method": "POST", + "uri": "/queues/{InstanceId}/{QueueId}/hours-of-operation", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateQueueHoursOfOperationRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QueueId": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier for the queue.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "HoursOfOperationId": { + "target": "com.amazonaws.connect#HoursOfOperationId", + "traits": { + "smithy.api#documentation": "

The identifier for the hours of operation.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#UpdateQueueMaxContacts": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateQueueMaxContactsRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates the maximum number of contacts allowed in a queue before it is considered\n full.

", + "smithy.api#http": { + "method": "POST", + "uri": "/queues/{InstanceId}/{QueueId}/max-contacts", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateQueueMaxContactsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QueueId": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier for the queue.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxContacts": { + "target": "com.amazonaws.connect#QueueMaxContacts", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of contacts that can be in the queue before it is considered full.

" + } + } + } + }, + "com.amazonaws.connect#UpdateQueueName": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateQueueNameRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates the name and description of a queue. At least Name or Description must be provided.

", + "smithy.api#http": { + "method": "POST", + "uri": "/queues/{InstanceId}/{QueueId}/name", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateQueueNameRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QueueId": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier for the queue.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#CommonNameLength127", + "traits": { + "smithy.api#documentation": "

The name of the queue.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#QueueDescription", + "traits": { + "smithy.api#documentation": "

The description of the queue.

" + } + } + } + }, + "com.amazonaws.connect#UpdateQueueOutboundCallerConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateQueueOutboundCallerConfigRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates the outbound caller ID name, number, and outbound whisper flow for a specified\n queue.

\n \n

If the number being used in the input is claimed to a traffic distribution group, and you are calling this API\n using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use\n either a full phone number ARN or UUID value for the OutboundCallerIdNumberId value\n of the OutboundCallerConfig request body parameter. However, if the number is claimed to a\n traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region\n associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided\n in\n this scenario, you will receive a\n ResourceNotFoundException.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/queues/{InstanceId}/{QueueId}/outbound-caller-config", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateQueueOutboundCallerConfigRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QueueId": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier for the queue.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "OutboundCallerConfig": { + "target": "com.amazonaws.connect#OutboundCallerConfig", + "traits": { + "smithy.api#documentation": "

The outbound caller ID name, number, and outbound whisper flow.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#UpdateQueueStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateQueueStatusRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates the status of the queue.

", + "smithy.api#http": { + "method": "POST", + "uri": "/queues/{InstanceId}/{QueueId}/status", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateQueueStatusRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QueueId": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier for the queue.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.connect#QueueStatus", + "traits": { + "smithy.api#documentation": "

The status of the queue.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#UpdateQuickConnectConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateQuickConnectConfigRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the configuration settings for the specified quick connect.

", + "smithy.api#http": { + "method": "POST", + "uri": "/quick-connects/{InstanceId}/{QuickConnectId}/config", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateQuickConnectConfigRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QuickConnectId": { + "target": "com.amazonaws.connect#QuickConnectId", + "traits": { + "smithy.api#documentation": "

The identifier for the quick connect.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QuickConnectConfig": { + "target": "com.amazonaws.connect#QuickConnectConfig", + "traits": { + "smithy.api#documentation": "

Information about the configuration settings for the quick connect.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#UpdateQuickConnectDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 250 + } + } + }, + "com.amazonaws.connect#UpdateQuickConnectName": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateQuickConnectNameRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided.

", + "smithy.api#http": { + "method": "POST", + "uri": "/quick-connects/{InstanceId}/{QuickConnectId}/name", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateQuickConnectNameRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QuickConnectId": { + "target": "com.amazonaws.connect#QuickConnectId", + "traits": { + "smithy.api#documentation": "

The identifier for the quick connect.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#QuickConnectName", + "traits": { + "smithy.api#documentation": "

The name of the quick connect.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#UpdateQuickConnectDescription", + "traits": { + "smithy.api#documentation": "

The description of the quick connect.

" + } + } + } + }, + "com.amazonaws.connect#UpdateRoutingProfileConcurrency": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateRoutingProfileConcurrencyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing\n profile.

", + "smithy.api#http": { + "method": "POST", + "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/concurrency", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateRoutingProfileConcurrencyRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the routing profile.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MediaConcurrencies": { + "target": "com.amazonaws.connect#MediaConcurrencies", + "traits": { + "smithy.api#documentation": "

The channels that agents can handle in the Contact Control Panel (CCP).

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#UpdateRoutingProfileDefaultOutboundQueue": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateRoutingProfileDefaultOutboundQueueRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the default outbound queue of a routing profile.

", + "smithy.api#http": { + "method": "POST", + "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/default-outbound-queue", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateRoutingProfileDefaultOutboundQueueRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the routing profile.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DefaultOutboundQueueId": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier for the default outbound queue.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#UpdateRoutingProfileName": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateRoutingProfileNameRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the name and description of a routing profile. The request accepts the following data in JSON format.\n At least Name or Description must be provided.

", + "smithy.api#http": { + "method": "POST", + "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/name", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateRoutingProfileNameRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the routing profile.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#RoutingProfileName", + "traits": { + "smithy.api#documentation": "

The name of the routing profile. Must not be more than 127 characters.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#RoutingProfileDescription", + "traits": { + "smithy.api#documentation": "

The description of the routing profile. Must not be more than 250 characters.

" + } + } + } + }, + "com.amazonaws.connect#UpdateRoutingProfileQueues": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateRoutingProfileQueuesRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the properties associated with a set of queues for a routing profile.

", + "smithy.api#http": { + "method": "POST", + "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/queues", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateRoutingProfileQueuesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the routing profile.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QueueConfigs": { + "target": "com.amazonaws.connect#RoutingProfileQueueConfigList", + "traits": { + "smithy.api#documentation": "

The queues to be updated for this routing profile.\n Queues must first be associated to the routing\n profile. You can do this using AssociateRoutingProfileQueues.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#UpdateRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateRuleRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceConflictException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a rule for the specified Amazon Connect instance.

\n

Use the Rules Function language to code conditions for the rule.\n

", + "smithy.api#http": { + "method": "PUT", + "uri": "/rules/{InstanceId}/{RuleId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateRuleRequest": { + "type": "structure", + "members": { + "RuleId": { + "target": "com.amazonaws.connect#RuleId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the rule.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#RuleName", + "traits": { + "smithy.api#documentation": "

The name of the rule. You can change the name only if TriggerEventSource is one\n of the following values: OnZendeskTicketCreate |\n OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate\n

", + "smithy.api#required": {} + } + }, + "Function": { + "target": "com.amazonaws.connect#RuleFunction", + "traits": { + "smithy.api#documentation": "

The conditions of the rule.

", + "smithy.api#required": {} + } + }, + "Actions": { + "target": "com.amazonaws.connect#RuleActions", + "traits": { + "smithy.api#documentation": "

A list of actions to be run when the rule is triggered.

", + "smithy.api#required": {} + } + }, + "PublishStatus": { + "target": "com.amazonaws.connect#RulePublishStatus", + "traits": { + "smithy.api#documentation": "

The publish status of the rule.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#UpdateSecurityProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateSecurityProfileRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates a security profile.

", + "smithy.api#http": { + "method": "POST", + "uri": "/security-profiles/{InstanceId}/{SecurityProfileId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateSecurityProfileRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.connect#SecurityProfileDescription", + "traits": { + "smithy.api#documentation": "

The description of the security profile.

" + } + }, + "Permissions": { + "target": "com.amazonaws.connect#PermissionsList", + "traits": { + "smithy.api#documentation": "

The permissions granted to a security profile. For a list of valid permissions, see List of security\n profile permissions.

" + } + }, + "SecurityProfileId": { + "target": "com.amazonaws.connect#SecurityProfileId", + "traits": { + "smithy.api#documentation": "

The identifier for the security profle.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AllowedAccessControlTags": { + "target": "com.amazonaws.connect#AllowedAccessControlTags", + "traits": { + "smithy.api#documentation": "

The list of tags that a security profile uses to restrict access to resources in Amazon Connect.

" + } + }, + "TagRestrictedResources": { + "target": "com.amazonaws.connect#TagRestrictedResourceList", + "traits": { + "smithy.api#documentation": "

The list of resources that a security profile applies tag restrictions to in Amazon Connect.

" + } + } + } + }, + "com.amazonaws.connect#UpdateTaskTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateTaskTemplateRequest" + }, + "output": { + "target": "com.amazonaws.connect#UpdateTaskTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#PropertyValidationException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates details about a specific task template in the specified Amazon Connect instance.\n This operation does not support partial updates. Instead it does a full update of template\n content.

", + "smithy.api#http": { + "method": "POST", + "uri": "/instance/{InstanceId}/task/template/{TaskTemplateId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateTaskTemplateRequest": { + "type": "structure", + "members": { + "TaskTemplateId": { + "target": "com.amazonaws.connect#TaskTemplateId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the task template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#TaskTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the task template.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#TaskTemplateDescription", + "traits": { + "smithy.api#documentation": "

The description of the task template.

" + } + }, + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

The identifier of the flow that runs by default when a task is created by referencing this template.

" + } + }, + "Constraints": { + "target": "com.amazonaws.connect#TaskTemplateConstraints", + "traits": { + "smithy.api#documentation": "

Constraints that are applicable to the fields listed.

" + } + }, + "Defaults": { + "target": "com.amazonaws.connect#TaskTemplateDefaults", + "traits": { + "smithy.api#documentation": "

The default values for fields when a task is created by referencing this template.

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

Marks a template as ACTIVE or INACTIVE for a task to refer to it. \nTasks can only be created from ACTIVE templates.\nIf a template is marked as INACTIVE, then a task that refers to this template cannot be created.

" + } + }, + "Fields": { + "target": "com.amazonaws.connect#TaskTemplateFields", + "traits": { + "smithy.api#documentation": "

Fields that are part of the template.

" + } + } + } + }, + "com.amazonaws.connect#UpdateTaskTemplateResponse": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

" + } + }, + "Id": { + "target": "com.amazonaws.connect#TaskTemplateId", + "traits": { + "smithy.api#documentation": "

The identifier of the task template resource.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#TaskTemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the task template resource.

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

The name of the task template.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#TaskTemplateDescription", + "traits": { + "smithy.api#documentation": "

The description of the task template.

" + } + }, + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", + "traits": { + "smithy.api#documentation": "

The identifier of the flow that runs by default when a task is created by referencing this template.

" + } + }, + "Constraints": { + "target": "com.amazonaws.connect#TaskTemplateConstraints", + "traits": { + "smithy.api#documentation": "

Constraints that are applicable to the fields listed.

" + } + }, + "Defaults": { + "target": "com.amazonaws.connect#TaskTemplateDefaults", + "traits": { + "smithy.api#documentation": "

The default values for fields when a task is created by referencing this template.

" + } + }, + "Fields": { + "target": "com.amazonaws.connect#TaskTemplateFields", + "traits": { + "smithy.api#documentation": "

Fields that are part of the template.

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

Marks a template as ACTIVE or INACTIVE for a task to refer to it. \nTasks can only be created from ACTIVE templates.\nIf a template is marked as INACTIVE, then a task that refers to this template cannot be created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the task template was last modified.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the task template was created.

" + } + } + } + }, + "com.amazonaws.connect#UpdateTrafficDistribution": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateTrafficDistributionRequest" + }, + "output": { + "target": "com.amazonaws.connect#UpdateTrafficDistributionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceConflictException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the traffic distribution for a given traffic distribution group.

\n

For more information about updating a traffic distribution group, see Update telephony\n traffic distribution across Amazon Web Services Regions\n in the Amazon Connect Administrator Guide.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/traffic-distribution/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateTrafficDistributionRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#TrafficDistributionGroupIdOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TelephonyConfig": { + "target": "com.amazonaws.connect#TelephonyConfig", + "traits": { + "smithy.api#documentation": "

The distribution of traffic between the instance and its replica(s).

" + } + } + } + }, + "com.amazonaws.connect#UpdateTrafficDistributionResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.connect#UpdateUserHierarchy": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateUserHierarchyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Assigns the specified hierarchy group to the specified user.

", + "smithy.api#http": { + "method": "POST", + "uri": "/users/{InstanceId}/{UserId}/hierarchy", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateUserHierarchyGroupName": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateUserHierarchyGroupNameRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the name of the user hierarchy group.

", + "smithy.api#http": { + "method": "POST", + "uri": "/user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}/name", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateUserHierarchyGroupNameRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#HierarchyGroupName", + "traits": { + "smithy.api#documentation": "

The name of the hierarchy group. Must not be more than 100 characters.

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

The identifier of the hierarchy group.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#UpdateUserHierarchyRequest": { + "type": "structure", + "members": { + "HierarchyGroupId": { + "target": "com.amazonaws.connect#HierarchyGroupId", + "traits": { + "smithy.api#documentation": "

The identifier of the hierarchy group.

" + } + }, + "UserId": { + "target": "com.amazonaws.connect#UserId", + "traits": { + "smithy.api#documentation": "

The identifier of the user account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#UpdateUserHierarchyStructure": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateUserHierarchyStructureRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceInUseException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.

", + "smithy.api#http": { + "method": "POST", + "uri": "/user-hierarchy-structure/{InstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateUserHierarchyStructureRequest": { + "type": "structure", + "members": { + "HierarchyStructure": { + "target": "com.amazonaws.connect#HierarchyStructureUpdate", + "traits": { + "smithy.api#documentation": "

The hierarchy levels to update.

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#UpdateUserIdentityInfo": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateUserIdentityInfoRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the identity information for the specified user.

\n \n

We strongly recommend limiting who has the ability to invoke\n UpdateUserIdentityInfo. Someone with that ability can change the login credentials\n of other users by changing their email address. This poses a security risk to your organization.\n They can change the email address of a user to the attacker's email address, and then reset the\n password through email. For more information, see Best Practices for\n Security Profiles in the Amazon Connect Administrator\n Guide.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/users/{InstanceId}/{UserId}/identity-info", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateUserIdentityInfoRequest": { + "type": "structure", + "members": { + "IdentityInfo": { + "target": "com.amazonaws.connect#UserIdentityInfo", + "traits": { + "smithy.api#documentation": "

The identity information for the user.

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

The identifier of the user account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#UpdateUserPhoneConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateUserPhoneConfigRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the phone configuration settings for the specified user.

", + "smithy.api#http": { + "method": "POST", + "uri": "/users/{InstanceId}/{UserId}/phone-config", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateUserPhoneConfigRequest": { + "type": "structure", + "members": { + "PhoneConfig": { + "target": "com.amazonaws.connect#UserPhoneConfig", + "traits": { + "smithy.api#documentation": "

Information about phone configuration settings for the user.

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

The identifier of the user account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#UpdateUserRoutingProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateUserRoutingProfileRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Assigns the specified routing profile to the specified user.

", + "smithy.api#http": { + "method": "POST", + "uri": "/users/{InstanceId}/{UserId}/routing-profile", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateUserRoutingProfileRequest": { + "type": "structure", + "members": { + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the routing profile for the user.

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

The identifier of the user account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#UpdateUserSecurityProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateUserSecurityProfilesRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Assigns the specified security profiles to the specified user.

", + "smithy.api#http": { + "method": "POST", + "uri": "/users/{InstanceId}/{UserId}/security-profiles", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateUserSecurityProfilesRequest": { + "type": "structure", + "members": { + "SecurityProfileIds": { + "target": "com.amazonaws.connect#SecurityProfileIds", + "traits": { + "smithy.api#documentation": "

The identifiers of the security profiles for the user.

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

The identifier of the user account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#Url": { + "type": "string" + }, + "com.amazonaws.connect#UrlReference": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#ReferenceKey", + "traits": { + "smithy.api#documentation": "

Identifier of the URL reference.

" + } + }, + "Value": { + "target": "com.amazonaws.connect#ReferenceValue", + "traits": { + "smithy.api#documentation": "

A valid URL.

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

The URL reference.

" + } + }, + "com.amazonaws.connect#UseCase": { + "type": "structure", + "members": { + "UseCaseId": { + "target": "com.amazonaws.connect#UseCaseId", + "traits": { + "smithy.api#documentation": "

The identifier for the use case.

" + } + }, + "UseCaseArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the use case.

" + } + }, + "UseCaseType": { + "target": "com.amazonaws.connect#UseCaseType", + "traits": { + "smithy.api#documentation": "

The type of use case to associate to the integration association. Each integration\n association can have only one of each use case type.

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

Contains the\n use\n case.

" + } + }, + "com.amazonaws.connect#UseCaseId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.connect#UseCaseSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#UseCase" + } + }, + "com.amazonaws.connect#UseCaseType": { + "type": "enum", + "members": { + "RULES_EVALUATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RULES_EVALUATION" + } + }, + "CONNECT_CAMPAIGNS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECT_CAMPAIGNS" + } + } + } + }, + "com.amazonaws.connect#User": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#UserId", + "traits": { + "smithy.api#documentation": "

The identifier of the user account.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user account.

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

The user name assigned to the user account.

" + } + }, + "IdentityInfo": { + "target": "com.amazonaws.connect#UserIdentityInfo", + "traits": { + "smithy.api#documentation": "

Information about the user identity.

" + } + }, + "PhoneConfig": { + "target": "com.amazonaws.connect#UserPhoneConfig", + "traits": { + "smithy.api#documentation": "

Information about the phone configuration for the user.

" + } + }, + "DirectoryUserId": { + "target": "com.amazonaws.connect#DirectoryUserId", + "traits": { + "smithy.api#documentation": "

The identifier of the user account in the directory used for identity management.

" + } + }, + "SecurityProfileIds": { + "target": "com.amazonaws.connect#SecurityProfileIds", + "traits": { + "smithy.api#documentation": "

The identifiers of the security profiles for the user.

" + } + }, + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the routing profile for the user.

" + } + }, + "HierarchyGroupId": { + "target": "com.amazonaws.connect#HierarchyGroupId", + "traits": { + "smithy.api#documentation": "

The identifier of the hierarchy group for the user.

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The\n tags.

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

Contains information about a user account for an Amazon Connect instance.

" + } + }, + "com.amazonaws.connect#UserData": { + "type": "structure", + "members": { + "User": { + "target": "com.amazonaws.connect#UserReference", + "traits": { + "smithy.api#documentation": "

Information about the user for the data that is returned. It contains the\n resourceId and ARN of the user.

" + } + }, + "RoutingProfile": { + "target": "com.amazonaws.connect#RoutingProfileReference", + "traits": { + "smithy.api#documentation": "

Information about the routing profile that is assigned to the user.

" + } + }, + "HierarchyPath": { + "target": "com.amazonaws.connect#HierarchyPathReference", + "traits": { + "smithy.api#documentation": "

Contains information about the levels of a hierarchy group assigned to a user.

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

The status of the agent that they manually set in their Contact Control Panel (CCP), or that\n the supervisor manually changes in the real-time metrics report.

" + } + }, + "AvailableSlotsByChannel": { + "target": "com.amazonaws.connect#ChannelToCountMap", + "traits": { + "smithy.api#documentation": "

A map of available slots by channel. The key is a channel name. The value is an integer: the\n available number of slots.

" + } + }, + "MaxSlotsByChannel": { + "target": "com.amazonaws.connect#ChannelToCountMap", + "traits": { + "smithy.api#documentation": "

A map of maximum slots by channel. The key is a channel name. The value is an integer: the\n maximum number of slots. This is calculated from MediaConcurrency of the\n RoutingProfile assigned to the agent.

" + } + }, + "ActiveSlotsByChannel": { + "target": "com.amazonaws.connect#ChannelToCountMap", + "traits": { + "smithy.api#documentation": "

A map of active slots by channel. The key is a channel name. The value is an integer: the\n number of active slots.

" + } + }, + "Contacts": { + "target": "com.amazonaws.connect#AgentContactReferenceList", + "traits": { + "smithy.api#documentation": "

A list of contact reference information.

" + } + }, + "NextStatus": { + "target": "com.amazonaws.connect#AgentStatusName", + "traits": { + "smithy.api#documentation": "

The Next status of the agent.

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

Data for a user.

" + } + }, + "com.amazonaws.connect#UserDataFilters": { + "type": "structure", + "members": { + "Queues": { + "target": "com.amazonaws.connect#Queues", + "traits": { + "smithy.api#documentation": "

A list of up to 100 queues or ARNs.

" + } + }, + "ContactFilter": { + "target": "com.amazonaws.connect#ContactFilter", + "traits": { + "smithy.api#documentation": "

A filter for the user data based on the contact information that is associated to the user.\n It contains a list of contact states.

" + } + }, + "RoutingProfiles": { + "target": "com.amazonaws.connect#RoutingProfiles", + "traits": { + "smithy.api#documentation": "

A list of up to 100 routing profile IDs or ARNs.

" + } + }, + "Agents": { + "target": "com.amazonaws.connect#AgentsMinOneMaxHundred", + "traits": { + "smithy.api#documentation": "

A list of up to 100 agent IDs or ARNs.

" + } + }, + "UserHierarchyGroups": { + "target": "com.amazonaws.connect#UserDataHierarchyGroups", + "traits": { + "smithy.api#documentation": "

A UserHierarchyGroup ID or ARN.

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

A filter for the user data.

" + } + }, + "com.amazonaws.connect#UserDataHierarchyGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#HierarchyGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.connect#UserDataList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#UserData" + } + }, + "com.amazonaws.connect#UserId": { + "type": "string" + }, + "com.amazonaws.connect#UserIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#UserId" + } + }, + "com.amazonaws.connect#UserIdentityInfo": { + "type": "structure", + "members": { + "FirstName": { + "target": "com.amazonaws.connect#AgentFirstName", + "traits": { + "smithy.api#documentation": "

The first name. This is required if you are using Amazon Connect or SAML for identity\n management.

" + } + }, + "LastName": { + "target": "com.amazonaws.connect#AgentLastName", + "traits": { + "smithy.api#documentation": "

The last name. This is required if you are using Amazon Connect or SAML for identity\n management.

" + } + }, + "Email": { + "target": "com.amazonaws.connect#Email", + "traits": { + "smithy.api#documentation": "

The email address. If you are using SAML for identity management and include this parameter,\n an error is returned.

" + } + }, + "SecondaryEmail": { + "target": "com.amazonaws.connect#Email", + "traits": { + "smithy.api#documentation": "

The user's secondary email address. If you provide a secondary email, the user receives\n email notifications - other than password reset notifications - to this email address instead of\n to their primary email address.

\n

Pattern: (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,63}\n

" + } + }, + "Mobile": { + "target": "com.amazonaws.connect#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The user's mobile number.

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

Contains information about the identity of a user.

" + } + }, + "com.amazonaws.connect#UserIdentityInfoLite": { + "type": "structure", + "members": { + "FirstName": { + "target": "com.amazonaws.connect#AgentFirstName", + "traits": { + "smithy.api#documentation": "

The user's first name.

" + } + }, + "LastName": { + "target": "com.amazonaws.connect#AgentLastName", + "traits": { + "smithy.api#documentation": "

The user's last name.

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

The user's first name and last name.

" + } + }, + "com.amazonaws.connect#UserNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message" + } + }, + "traits": { + "smithy.api#documentation": "

No user with the specified credentials was found in the Amazon Connect instance.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.connect#UserPhoneConfig": { + "type": "structure", + "members": { + "PhoneType": { + "target": "com.amazonaws.connect#PhoneType", + "traits": { + "smithy.api#documentation": "

The phone type.

", + "smithy.api#required": {} + } + }, + "AutoAccept": { + "target": "com.amazonaws.connect#AutoAccept", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The Auto accept setting.

" + } + }, + "AfterContactWorkTimeLimit": { + "target": "com.amazonaws.connect#AfterContactWorkTimeLimit", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The After Call Work (ACW) timeout setting, in seconds.

\n \n

When returned by a SearchUsers call, AfterContactWorkTimeLimit is\n returned in milliseconds.

\n " + } + }, + "DeskPhoneNumber": { + "target": "com.amazonaws.connect#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number for the user's desk phone.

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

Contains information about the phone configuration settings for a user.

" + } + }, + "com.amazonaws.connect#UserQuickConnectConfig": { + "type": "structure", + "members": { + "UserId": { + "target": "com.amazonaws.connect#UserId", + "traits": { + "smithy.api#documentation": "

The identifier of the user.

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

The identifier of the flow.

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

Contains information about the quick connect configuration settings for a user. The contact\n flow must be of type Transfer to Agent.

" + } + }, + "com.amazonaws.connect#UserReference": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#UserId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the user.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the user.

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

Information about the user.

" + } + }, + "com.amazonaws.connect#UserSearchConditionList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#UserSearchCriteria" + } + }, + "com.amazonaws.connect#UserSearchCriteria": { + "type": "structure", + "members": { + "OrConditions": { + "target": "com.amazonaws.connect#UserSearchConditionList", + "traits": { + "smithy.api#documentation": "

A list of conditions which would be applied together with an OR\n condition.

" + } + }, + "AndConditions": { + "target": "com.amazonaws.connect#UserSearchConditionList", + "traits": { + "smithy.api#documentation": "

A list of conditions which would be applied together with an AND condition.\n

" + } + }, + "StringCondition": { + "target": "com.amazonaws.connect#StringCondition", + "traits": { + "smithy.api#documentation": "

A leaf node condition which can be used to specify a string condition.

" + } + }, + "HierarchyGroupCondition": { + "target": "com.amazonaws.connect#HierarchyGroupCondition", + "traits": { + "smithy.api#documentation": "

A leaf node condition which can be used to specify a hierarchy group condition.

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

The search criteria to be used to return users.

\n \n

The name and description fields support \"contains\" queries with\n a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths\n outside of this range will throw invalid results.

\n " + } + }, + "com.amazonaws.connect#UserSearchFilter": { + "type": "structure", + "members": { + "TagFilter": { + "target": "com.amazonaws.connect#ControlPlaneTagFilter" + } + }, + "traits": { + "smithy.api#documentation": "

Filters to be applied to search results.

" + } + }, + "com.amazonaws.connect#UserSearchSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user.

" + } + }, + "DirectoryUserId": { + "target": "com.amazonaws.connect#DirectoryUserId", + "traits": { + "smithy.api#documentation": "

The directory identifier of the user.

" + } + }, + "HierarchyGroupId": { + "target": "com.amazonaws.connect#HierarchyGroupId", + "traits": { + "smithy.api#documentation": "

The identifier of the user's hierarchy group.

" + } + }, + "Id": { + "target": "com.amazonaws.connect#UserId", + "traits": { + "smithy.api#documentation": "

The identifier of the user's summary.

" + } + }, + "IdentityInfo": { + "target": "com.amazonaws.connect#UserIdentityInfoLite", + "traits": { + "smithy.api#documentation": "

The user's first name and last name.

" + } + }, + "PhoneConfig": { + "target": "com.amazonaws.connect#UserPhoneConfig" + }, + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the user's routing profile.

" + } + }, + "SecurityProfileIds": { + "target": "com.amazonaws.connect#SecurityProfileIds", + "traits": { + "smithy.api#documentation": "

The identifiers of the user's security profiles.

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

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

The name of the user.

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

Information about the returned users.

" + } + }, + "com.amazonaws.connect#UserSearchSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#UserSearchSummary" + } + }, + "com.amazonaws.connect#UserSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#UserId", + "traits": { + "smithy.api#documentation": "

The identifier of the user account.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user account.

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

The Amazon Connect user name of the user account.

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

Contains summary information about a user.

" + } + }, + "com.amazonaws.connect#UserSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#UserSummary" + } + }, + "com.amazonaws.connect#UserTagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.connect#String" + }, + "value": { + "target": "com.amazonaws.connect#String" + } + }, + "com.amazonaws.connect#Value": { + "type": "double" + }, + "com.amazonaws.connect#Vocabulary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#VocabularyName", + "traits": { + "smithy.api#documentation": "

A unique name of the custom vocabulary.

", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.connect#VocabularyId", + "traits": { + "smithy.api#documentation": "

The identifier of the custom vocabulary.

", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom vocabulary.

", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.connect#VocabularyLanguageCode", + "traits": { + "smithy.api#documentation": "

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see \nWhat is Amazon Transcribe?\n

", + "smithy.api#required": {} + } + }, + "State": { + "target": "com.amazonaws.connect#VocabularyState", + "traits": { + "smithy.api#documentation": "

The current state of the custom vocabulary.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.connect#VocabularyLastModifiedTime", + "traits": { + "smithy.api#documentation": "

The timestamp when the custom vocabulary was last modified.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.connect#VocabularyFailureReason", + "traits": { + "smithy.api#documentation": "

The reason why the custom vocabulary was not created.

" + } + }, + "Content": { + "target": "com.amazonaws.connect#VocabularyContent", + "traits": { + "smithy.api#documentation": "

The content of the custom vocabulary in plain-text format with a table of values. Each row\n in the table represents a word or a phrase, described with Phrase, IPA,\n SoundsLike, and DisplayAs fields. Separate the fields with TAB\n characters. For more information, see Create a custom\n vocabulary using a table.

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

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

Contains information about a custom vocabulary.

" + } + }, + "com.amazonaws.connect#VocabularyContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60000 + } + } + }, + "com.amazonaws.connect#VocabularyFailureReason": { + "type": "string" + }, + "com.amazonaws.connect#VocabularyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.connect#VocabularyLanguageCode": { + "type": "enum", + "members": { + "AR_AE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ar-AE" + } + }, + "DE_CH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "de-CH" + } + }, + "DE_DE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "de-DE" + } + }, + "EN_AB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en-AB" + } + }, + "EN_AU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en-AU" + } + }, + "EN_GB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en-GB" + } + }, + "EN_IE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en-IE" + } + }, + "EN_IN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en-IN" + } + }, + "EN_US": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en-US" + } + }, + "EN_WL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en-WL" + } + }, + "ES_ES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "es-ES" + } + }, + "ES_US": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "es-US" + } + }, + "FR_CA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fr-CA" + } + }, + "FR_FR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fr-FR" + } + }, + "HI_IN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hi-IN" + } + }, + "IT_IT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "it-IT" + } + }, + "JA_JP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ja-JP" + } + }, + "KO_KR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ko-KR" + } + }, + "PT_BR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pt-BR" + } + }, + "PT_PT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pt-PT" + } + }, + "ZH_CN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zh-CN" + } + }, + "EN_NZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en-NZ" + } + }, + "EN_ZA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en-ZA" + } + } + } + }, + "com.amazonaws.connect#VocabularyLastModifiedTime": { + "type": "timestamp" + }, + "com.amazonaws.connect#VocabularyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 140 + }, + "smithy.api#pattern": "^[0-9a-zA-Z._-]+$" + } + }, + "com.amazonaws.connect#VocabularyNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 131070 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.connect#VocabularyState": { + "type": "enum", + "members": { + "CREATION_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_IN_PROGRESS" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "CREATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_FAILED" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" + } + } + } + }, + "com.amazonaws.connect#VocabularySummary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#VocabularyName", + "traits": { + "smithy.api#documentation": "

A unique name of the custom vocabulary.

", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.connect#VocabularyId", + "traits": { + "smithy.api#documentation": "

The identifier of the custom vocabulary.

", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom vocabulary.

", + "smithy.api#required": {} + } + }, + "LanguageCode": { + "target": "com.amazonaws.connect#VocabularyLanguageCode", + "traits": { + "smithy.api#documentation": "

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see \nWhat is Amazon Transcribe?\n

", + "smithy.api#required": {} + } + }, + "State": { + "target": "com.amazonaws.connect#VocabularyState", + "traits": { + "smithy.api#documentation": "

The current state of the custom vocabulary.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.connect#VocabularyLastModifiedTime", + "traits": { + "smithy.api#documentation": "

The timestamp when the custom vocabulary was last modified.

", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.connect#VocabularyFailureReason", + "traits": { + "smithy.api#documentation": "

The reason why the custom vocabulary was not created.

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

Contains summary information about the custom vocabulary.

" + } + }, + "com.amazonaws.connect#VocabularySummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#VocabularySummary" + } + }, + "com.amazonaws.connect#VoiceRecordingConfiguration": { + "type": "structure", + "members": { + "VoiceRecordingTrack": { + "target": "com.amazonaws.connect#VoiceRecordingTrack", + "traits": { + "smithy.api#documentation": "

Identifies which track is being recorded.

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

Contains information about the recording configuration settings.

" + } + }, + "com.amazonaws.connect#VoiceRecordingTrack": { + "type": "enum", + "members": { + "FROM_AGENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FROM_AGENT" + } + }, + "TO_AGENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TO_AGENT" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + } + } } - } } - } } diff --git a/codegen/sdk-codegen/aws-models/emr-serverless.json b/codegen/sdk-codegen/aws-models/emr-serverless.json index f8f4a899d143..b20380065210 100644 --- a/codegen/sdk-codegen/aws-models/emr-serverless.json +++ b/codegen/sdk-codegen/aws-models/emr-serverless.json @@ -1,3824 +1,3974 @@ { - "smithy": "2.0", - "shapes": { - "com.amazonaws.emrserverless#Application": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - }, - "name": { - "target": "com.amazonaws.emrserverless#ApplicationName", - "traits": { - "smithy.api#documentation": "

The name of the application.

" - } - }, - "arn": { - "target": "com.amazonaws.emrserverless#ApplicationArn", - "traits": { - "smithy.api#documentation": "

The ARN of the application.

", - "smithy.api#required": {} - } - }, - "releaseLabel": { - "target": "com.amazonaws.emrserverless#ReleaseLabel", - "traits": { - "smithy.api#documentation": "

The EMR release version associated with the application.

", - "smithy.api#required": {} - } - }, - "type": { - "target": "com.amazonaws.emrserverless#EngineType", - "traits": { - "smithy.api#documentation": "

The type of application, such as Spark or Hive.

", - "smithy.api#required": {} - } - }, - "state": { - "target": "com.amazonaws.emrserverless#ApplicationState", - "traits": { - "smithy.api#documentation": "

The state of the application.

", - "smithy.api#required": {} - } - }, - "stateDetails": { - "target": "com.amazonaws.emrserverless#String256", - "traits": { - "smithy.api#documentation": "

The state details of the application.

" - } - }, - "initialCapacity": { - "target": "com.amazonaws.emrserverless#InitialCapacityConfigMap", - "traits": { - "smithy.api#documentation": "

The initial capacity of the application.

" - } - }, - "maximumCapacity": { - "target": "com.amazonaws.emrserverless#MaximumAllowedResources", - "traits": { - "smithy.api#documentation": "

The maximum capacity of the application. This is cumulative across all workers at any\n given point in time during the lifespan of the application is created. No new resources\n will be created once any one of the defined limits is hit.

" - } - }, - "createdAt": { - "target": "com.amazonaws.emrserverless#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the application run was created.

", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.emrserverless#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the application run was last updated.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.emrserverless#TagMap", - "traits": { - "smithy.api#documentation": "

The tags assigned to the application.

" - } - }, - "autoStartConfiguration": { - "target": "com.amazonaws.emrserverless#AutoStartConfig", - "traits": { - "smithy.api#documentation": "

The configuration for an application to automatically start on job submission.

" - } - }, - "autoStopConfiguration": { - "target": "com.amazonaws.emrserverless#AutoStopConfig", - "traits": { - "smithy.api#documentation": "

The configuration for an application to automatically stop after a certain amount of\n time being idle.

" - } - }, - "networkConfiguration": { - "target": "com.amazonaws.emrserverless#NetworkConfiguration", - "traits": { - "smithy.api#documentation": "

The network configuration for customer VPC connectivity for the application.

" - } - }, - "architecture": { - "target": "com.amazonaws.emrserverless#Architecture", - "traits": { - "smithy.api#documentation": "

The CPU architecture of an application.

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

Information about an application. EMR Serverless uses applications to run jobs.

" - } - }, - "com.amazonaws.emrserverless#ApplicationArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 60, - "max": 1024 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-serverless:.+:(\\d{12}):\\/applications\\/[0-9a-zA-Z]+$" - } - }, - "com.amazonaws.emrserverless#ApplicationId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[0-9a-z]+$" - } - }, - "com.amazonaws.emrserverless#ApplicationList": { - "type": "list", - "member": { - "target": "com.amazonaws.emrserverless#ApplicationSummary" - } - }, - "com.amazonaws.emrserverless#ApplicationName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[A-Za-z0-9._/#-]+$" - } - }, - "com.amazonaws.emrserverless#ApplicationResource": { - "type": "resource", - "identifiers": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId" - } - }, - "create": { - "target": "com.amazonaws.emrserverless#CreateApplication" - }, - "read": { - "target": "com.amazonaws.emrserverless#GetApplication" - }, - "update": { - "target": "com.amazonaws.emrserverless#UpdateApplication" - }, - "delete": { - "target": "com.amazonaws.emrserverless#DeleteApplication" - }, - "list": { - "target": "com.amazonaws.emrserverless#ListApplications" - }, - "operations": [ - { - "target": "com.amazonaws.emrserverless#StartApplication" - }, - { - "target": "com.amazonaws.emrserverless#StopApplication" - } - ] - }, - "com.amazonaws.emrserverless#ApplicationState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "CREATED", - "name": "CREATED" - }, - { - "value": "STARTING", - "name": "STARTING" - }, - { - "value": "STARTED", - "name": "STARTED" - }, - { - "value": "STOPPING", - "name": "STOPPING" - }, - { - "value": "STOPPED", - "name": "STOPPED" - }, - { - "value": "TERMINATED", - "name": "TERMINATED" - } - ] - } - }, - "com.amazonaws.emrserverless#ApplicationStateSet": { - "type": "list", - "member": { - "target": "com.amazonaws.emrserverless#ApplicationState" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 7 - }, - "smithy.api#uniqueItems": {} - } - }, - "com.amazonaws.emrserverless#ApplicationSummary": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - }, - "name": { - "target": "com.amazonaws.emrserverless#ApplicationName", - "traits": { - "smithy.api#documentation": "

The name of the application.

" - } - }, - "arn": { - "target": "com.amazonaws.emrserverless#ApplicationArn", - "traits": { - "smithy.api#documentation": "

The ARN of the application.

", - "smithy.api#required": {} - } - }, - "releaseLabel": { - "target": "com.amazonaws.emrserverless#ReleaseLabel", - "traits": { - "smithy.api#documentation": "

The EMR release version associated with the application.

", - "smithy.api#required": {} - } - }, - "type": { - "target": "com.amazonaws.emrserverless#EngineType", - "traits": { - "smithy.api#documentation": "

The type of application, such as Spark or Hive.

", - "smithy.api#required": {} - } - }, - "state": { - "target": "com.amazonaws.emrserverless#ApplicationState", - "traits": { - "smithy.api#documentation": "

The state of the application.

", - "smithy.api#required": {} - } - }, - "stateDetails": { - "target": "com.amazonaws.emrserverless#String256", - "traits": { - "smithy.api#documentation": "

The state details of the application.

" - } - }, - "createdAt": { - "target": "com.amazonaws.emrserverless#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the application was created.

", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.emrserverless#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the application was last updated.

", - "smithy.api#required": {} - } - }, - "architecture": { - "target": "com.amazonaws.emrserverless#Architecture", - "traits": { - "smithy.api#documentation": "

The CPU architecture of an application.

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

The summary of attributes associated with an application.

" - } - }, - "com.amazonaws.emrserverless#Architecture": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ARM64", - "name": "ARM64" - }, - { - "value": "X86_64", - "name": "X86_64" - } - ] - } - }, - "com.amazonaws.emrserverless#AutoStartConfig": { - "type": "structure", - "members": { - "enabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Enables the application to automatically start on job submission. Defaults to\n true.

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

The configuration for an application to automatically start on job submission.

" - } - }, - "com.amazonaws.emrserverless#AutoStopConfig": { - "type": "structure", - "members": { - "enabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Enables the application to automatically stop after a certain amount of time being idle.\n Defaults to true.

" - } - }, - "idleTimeoutMinutes": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The amount of idle time in minutes after which your application will automatically stop.\n Defaults to 15 minutes.

", - "smithy.api#range": { - "min": 1, - "max": 10080 - } - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for an application to automatically stop after a certain amount of\n time being idle.

" - } - }, - "com.amazonaws.emrserverless#AwsToledoWebService": { - "type": "service", - "version": "2021-07-13", - "operations": [ - { - "target": "com.amazonaws.emrserverless#ListTagsForResource" - }, - { - "target": "com.amazonaws.emrserverless#TagResource" - }, - { - "target": "com.amazonaws.emrserverless#UntagResource" - } - ], - "resources": [ - { - "target": "com.amazonaws.emrserverless#ApplicationResource" + "smithy": "2.0", + "shapes": { + "com.amazonaws.emrserverless#Application": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "name": { + "target": "com.amazonaws.emrserverless#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of the application.

" + } + }, + "arn": { + "target": "com.amazonaws.emrserverless#ApplicationArn", + "traits": { + "smithy.api#documentation": "

The ARN of the application.

", + "smithy.api#required": {} + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrserverless#ReleaseLabel", + "traits": { + "smithy.api#documentation": "

The EMR release associated with the application.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.emrserverless#EngineType", + "traits": { + "smithy.api#documentation": "

The type of application, such as Spark or Hive.

", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.emrserverless#ApplicationState", + "traits": { + "smithy.api#documentation": "

The state of the application.

", + "smithy.api#required": {} + } + }, + "stateDetails": { + "target": "com.amazonaws.emrserverless#String256", + "traits": { + "smithy.api#documentation": "

The state details of the application.

" + } + }, + "initialCapacity": { + "target": "com.amazonaws.emrserverless#InitialCapacityConfigMap", + "traits": { + "smithy.api#documentation": "

The initial capacity of the application.

" + } + }, + "maximumCapacity": { + "target": "com.amazonaws.emrserverless#MaximumAllowedResources", + "traits": { + "smithy.api#documentation": "

The maximum capacity of the application. This is cumulative across all workers at any\n given point in time during the lifespan of the application is created. No new resources\n will be created once any one of the defined limits is hit.

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

The date and time when the application run was created.

", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the application run was last updated.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.emrserverless#TagMap", + "traits": { + "smithy.api#documentation": "

The tags assigned to the application.

" + } + }, + "autoStartConfiguration": { + "target": "com.amazonaws.emrserverless#AutoStartConfig", + "traits": { + "smithy.api#documentation": "

The configuration for an application to automatically start on job submission.

" + } + }, + "autoStopConfiguration": { + "target": "com.amazonaws.emrserverless#AutoStopConfig", + "traits": { + "smithy.api#documentation": "

The configuration for an application to automatically stop after a certain amount of\n time being idle.

" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.emrserverless#NetworkConfiguration", + "traits": { + "smithy.api#documentation": "

The network configuration for customer VPC connectivity for the application.

" + } + }, + "architecture": { + "target": "com.amazonaws.emrserverless#Architecture", + "traits": { + "smithy.api#documentation": "

The CPU architecture of an application.

" + } + }, + "imageConfiguration": { + "target": "com.amazonaws.emrserverless#ImageConfiguration", + "traits": { + "smithy.api#documentation": "

The image configuration applied to all worker types.

" + } + }, + "workerTypeSpecifications": { + "target": "com.amazonaws.emrserverless#WorkerTypeSpecificationMap", + "traits": { + "smithy.api#documentation": "

The specification applied to each worker type.

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

Information about an application. EMR Serverless uses applications to run jobs.

" + } }, - { - "target": "com.amazonaws.emrserverless#JobRunResource" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "EMR Serverless", - "arnNamespace": "emr-serverless" - }, - "aws.auth#sigv4": { - "name": "emr-serverless" - }, - "aws.protocols#restJson1": {}, - "smithy.api#cors": { - "additionalAllowedHeaders": [ - "*", - "Authorization", - "Date", - "X-Amz-Date", - "X-Amz-Security-Token", - "X-Amz-Target", - "content-type", - "x-amz-content-sha256", - "x-amz-user-agent", - "x-amzn-platform-id", - "x-amzn-trace-id" - ], - "additionalExposedHeaders": ["x-amzn-errortype", "x-amzn-requestid", "x-amzn-trace-id", "x-amz-apigw-id"] - }, - "smithy.api#documentation": "

Amazon EMR Serverless is a new deployment option for Amazon EMR. EMR Serverless provides\n a serverless runtime environment that simplifies running analytics applications using the\n latest open source frameworks such as Apache Spark and Apache Hive. With EMR Serverless,\n you donā€™t have to configure, optimize, secure, or operate clusters to run applications with\n these frameworks.

\n

The API reference to Amazon EMR Serverless is emr-serverless. The\n emr-serverless prefix is used in the following scenarios:

\n ", - "smithy.api#title": "EMR Serverless", - "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": [ + "com.amazonaws.emrserverless#ApplicationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 60, + "max": 1024 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-serverless:.+:(\\d{12}):\\/applications\\/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.emrserverless#ApplicationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9a-z]+$" + } + }, + "com.amazonaws.emrserverless#ApplicationList": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#ApplicationSummary" + } + }, + "com.amazonaws.emrserverless#ApplicationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9._/#-]+$" + } + }, + "com.amazonaws.emrserverless#ApplicationResource": { + "type": "resource", + "identifiers": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId" + } + }, + "create": { + "target": "com.amazonaws.emrserverless#CreateApplication" + }, + "read": { + "target": "com.amazonaws.emrserverless#GetApplication" + }, + "update": { + "target": "com.amazonaws.emrserverless#UpdateApplication" + }, + "delete": { + "target": "com.amazonaws.emrserverless#DeleteApplication" + }, + "list": { + "target": "com.amazonaws.emrserverless#ListApplications" + }, + "operations": [ { - "fn": "aws.partition", - "argv": [ + "target": "com.amazonaws.emrserverless#StartApplication" + }, + { + "target": "com.amazonaws.emrserverless#StopApplication" + } + ], + "traits": { + "aws.cloudformation#cfnResource": { + "name": "Application" + } + } + }, + "com.amazonaws.emrserverless#ApplicationState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "CREATED", + "name": "CREATED" + }, + { + "value": "STARTING", + "name": "STARTING" + }, + { + "value": "STARTED", + "name": "STARTED" + }, + { + "value": "STOPPING", + "name": "STOPPING" + }, { - "ref": "Region" + "value": "STOPPED", + "name": "STOPPED" + }, + { + "value": "TERMINATED", + "name": "TERMINATED" + } + ] + } + }, + "com.amazonaws.emrserverless#ApplicationStateSet": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#ApplicationState" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 7 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.emrserverless#ApplicationSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "name": { + "target": "com.amazonaws.emrserverless#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of the application.

" + } + }, + "arn": { + "target": "com.amazonaws.emrserverless#ApplicationArn", + "traits": { + "smithy.api#documentation": "

The ARN of the application.

", + "smithy.api#required": {} + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrserverless#ReleaseLabel", + "traits": { + "smithy.api#documentation": "

The EMR release associated with the application.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.emrserverless#EngineType", + "traits": { + "smithy.api#documentation": "

The type of application, such as Spark or Hive.

", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.emrserverless#ApplicationState", + "traits": { + "smithy.api#documentation": "

The state of the application.

", + "smithy.api#required": {} + } + }, + "stateDetails": { + "target": "com.amazonaws.emrserverless#String256", + "traits": { + "smithy.api#documentation": "

The state details of the application.

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

The date and time when the application was created.

", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the application was last updated.

", + "smithy.api#required": {} + } + }, + "architecture": { + "target": "com.amazonaws.emrserverless#Architecture", + "traits": { + "smithy.api#documentation": "

The CPU architecture of an application.

" } - ], - "assign": "PartitionResult" } - ], - "type": "tree", - "rules": [ - { - "conditions": [ + }, + "traits": { + "smithy.api#documentation": "

The summary of attributes associated with an application.

" + } + }, + "com.amazonaws.emrserverless#Architecture": { + "type": "string", + "traits": { + "smithy.api#enum": [ { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] + "value": "ARM64", + "name": "ARM64" }, { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" + "value": "X86_64", + "name": "X86_64" + } + ] + } + }, + "com.amazonaws.emrserverless#AutoStartConfig": { + "type": "structure", + "members": { + "enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Enables the application to automatically start on job submission. Defaults to\n true.

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

The configuration for an application to automatically start on job submission.

" + } + }, + "com.amazonaws.emrserverless#AutoStopConfig": { + "type": "structure", + "members": { + "enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Enables the application to automatically stop after a certain amount of time being idle.\n Defaults to true.

" + } + }, + "idleTimeoutMinutes": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The amount of idle time in minutes after which your application will automatically stop.\n Defaults to 15 minutes.

", + "smithy.api#range": { + "min": 1, + "max": 10080 } - ], - "assign": "url" } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for an application to automatically stop after a certain amount of\n time being idle.

" + } + }, + "com.amazonaws.emrserverless#AwsToledoWebService": { + "type": "service", + "version": "2021-07-13", + "operations": [ + { + "target": "com.amazonaws.emrserverless#ListTagsForResource" + }, + { + "target": "com.amazonaws.emrserverless#TagResource" + }, + { + "target": "com.amazonaws.emrserverless#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.emrserverless#ApplicationResource" + }, + { + "target": "com.amazonaws.emrserverless#JobRunResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "EMR Serverless", + "arnNamespace": "emr-serverless", + "cloudFormationName": "EMRServerless" + }, + "aws.auth#sigv4": { + "name": "emr-serverless" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "*", + "Authorization", + "Date", + "X-Amz-Date", + "X-Amz-Security-Token", + "X-Amz-Target", + "content-type", + "x-amz-content-sha256", + "x-amz-user-agent", + "x-amzn-platform-id", + "x-amzn-trace-id" + ], + "additionalExposedHeaders": [ + "x-amzn-errortype", + "x-amzn-requestid", + "x-amzn-trace-id", + "x-amz-apigw-id" + ] + }, + "smithy.api#documentation": "

Amazon EMR Serverless is a new deployment option for Amazon EMR. EMR Serverless provides\n a serverless runtime environment that simplifies running analytics applications using the\n latest open source frameworks such as Apache Spark and Apache Hive. With EMR Serverless,\n you donā€™t have to configure, optimize, secure, or operate clusters to run applications with\n these frameworks.

\n

The API reference to Amazon EMR Serverless is emr-serverless. The\n emr-serverless prefix is used in the following scenarios:

\n ", + "smithy.api#title": "EMR Serverless", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": true, + "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" } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "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" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://emr-serverless-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": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://emr-serverless-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, { - "ref": "UseDualStack" + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://emr-serverless.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] }, - true - ] + { + "conditions": [], + "endpoint": { + "url": "https://emr-serverless.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ap-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-south-1" } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" }, { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ap-south-1.amazonaws.com" + } }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-south-1" + } + }, { - "ref": "UseFIPS" + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ap-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-south-1" + } }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ { - "ref": "UseDualStack" + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-south-1" + } }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ca-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ca-central-1" } - ] }, { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ca-central-1" } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://emr-serverless-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": [ - { - "fn": "booleanEquals", - "argv": [ + }, { - "ref": "UseFIPS" + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ca-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ca-central-1" + } }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ca-central-1" } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://emr-serverless-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + }, { - "ref": "UseDualStack" + "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.eu-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-central-1" + } }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-central-1" } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://emr-serverless.{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://emr-serverless.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.ap-south-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "ap-south-1", - "UseDualStack": true - } - }, - { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.ap-south-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "ap-south-1", - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.ap-south-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "ap-south-1", - "UseDualStack": true - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.ap-south-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "ap-south-1", - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.ca-central-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "ca-central-1", - "UseDualStack": true - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.ca-central-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "ca-central-1", - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.ca-central-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "ca-central-1", - "UseDualStack": true - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.ca-central-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "ca-central-1", - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.eu-central-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "eu-central-1", - "UseDualStack": true - } - }, - { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.eu-central-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "eu-central-1", - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.eu-central-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "eu-central-1", - "UseDualStack": true - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.eu-central-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "eu-central-1", - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.us-west-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "us-west-1", - "UseDualStack": true - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.us-west-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "us-west-1", - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.us-west-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "us-west-1", - "UseDualStack": true - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.us-west-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "us-west-1", - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.us-west-2.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "us-west-2", - "UseDualStack": true - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "us-west-2", - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.us-west-2.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "us-west-2", - "UseDualStack": true - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.us-west-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "us-west-2", - "UseDualStack": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.eu-north-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "eu-north-1", - "UseDualStack": true - } - }, - { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.eu-north-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "eu-north-1", - "UseDualStack": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.eu-north-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "eu-north-1", - "UseDualStack": true - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.eu-north-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "eu-north-1", - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.eu-west-3.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "eu-west-3", - "UseDualStack": true - } - }, - { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.eu-west-3.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "eu-west-3", - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.eu-west-3.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "eu-west-3", - "UseDualStack": true - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.eu-west-3.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "eu-west-3", - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.eu-west-2.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "eu-west-2", - "UseDualStack": true - } - }, - { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.eu-west-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "eu-west-2", - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.eu-west-2.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "eu-west-2", - "UseDualStack": true - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.eu-west-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "eu-west-2", - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.eu-west-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "eu-west-1", - "UseDualStack": true - } - }, - { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.eu-west-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "eu-west-1", - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.eu-west-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "eu-west-1", - "UseDualStack": true - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.eu-west-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "eu-west-1", - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.ap-northeast-3.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "ap-northeast-3", - "UseDualStack": true - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "ap-northeast-3", - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.ap-northeast-3.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "ap-northeast-3", - "UseDualStack": true - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "ap-northeast-3", - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.ap-northeast-2.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "ap-northeast-2", - "UseDualStack": true - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "ap-northeast-2", - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.ap-northeast-2.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "ap-northeast-2", - "UseDualStack": true - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "ap-northeast-2", - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.ap-northeast-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "ap-northeast-1", - "UseDualStack": true - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "ap-northeast-1", - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.ap-northeast-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "ap-northeast-1", - "UseDualStack": true - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "ap-northeast-1", - "UseDualStack": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.sa-east-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "sa-east-1", - "UseDualStack": true - } - }, - { - "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.sa-east-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "sa-east-1", - "UseDualStack": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.sa-east-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "sa-east-1", - "UseDualStack": true - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.sa-east-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "sa-east-1", - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.ap-southeast-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "ap-southeast-1", - "UseDualStack": true - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "ap-southeast-1", - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.ap-southeast-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "ap-southeast-1", - "UseDualStack": true - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "ap-southeast-1", - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.ap-southeast-2.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "ap-southeast-2", - "UseDualStack": true - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "ap-southeast-2", - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.ap-southeast-2.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "ap-southeast-2", - "UseDualStack": true - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "ap-southeast-2", - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.us-east-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "us-east-1", - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "us-east-1", - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.us-east-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "us-east-1", - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.us-east-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "us-east-1", - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.us-east-2.api.aws" - } - }, - "params": { - "UseFIPS": true, - "Region": "us-east-2", - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.us-east-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "Region": "us-east-2", - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.us-east-2.api.aws" - } - }, - "params": { - "UseFIPS": false, - "Region": "us-east-2", - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.us-east-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "us-east-2", - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "Region": "us-east-1", - "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": { - "UseFIPS": true, - "Region": "us-east-1", - "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": { - "UseFIPS": false, - "Region": "us-east-1", - "UseDualStack": true, - "Endpoint": "https://example.com" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.emrserverless#CancelJobRun": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#CancelJobRunRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#CancelJobRunResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Cancels a job run.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/applications/{applicationId}/jobruns/{jobRunId}" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.emrserverless#CancelJobRunRequest": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application on which the job run will be canceled.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - }, - "jobRunId": { - "target": "com.amazonaws.emrserverless#JobRunId", - "traits": { - "smithy.api#documentation": "

The ID of the job run to cancel.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "jobRunId" - } - } - } - }, - "com.amazonaws.emrserverless#CancelJobRunResponse": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The output contains the application ID on which the job run is cancelled.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - }, - "jobRunId": { - "target": "com.amazonaws.emrserverless#JobRunId", - "traits": { - "smithy.api#documentation": "

The output contains the ID of the cancelled job run.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "jobRunId" - } - } - } - }, - "com.amazonaws.emrserverless#ClientToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[A-Za-z0-9._-]+$" - } - }, - "com.amazonaws.emrserverless#Configuration": { - "type": "structure", - "members": { - "classification": { - "target": "com.amazonaws.emrserverless#String1024", - "traits": { - "smithy.api#documentation": "

The classification within a configuration.

", - "smithy.api#required": {} - } - }, - "properties": { - "target": "com.amazonaws.emrserverless#SensitivePropertiesMap", - "traits": { - "smithy.api#documentation": "

A set of properties specified within a configuration classification.

" - } - }, - "configurations": { - "target": "com.amazonaws.emrserverless#ConfigurationList", - "traits": { - "smithy.api#documentation": "

A list of additional configurations to apply within a configuration object.

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

A configuration specification to be used when provisioning an application. A\n configuration consists of a classification, properties, and optional nested configurations.\n A classification refers to an application-specific configuration file. Properties are the\n settings you want to change in that file.

" - } - }, - "com.amazonaws.emrserverless#ConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.emrserverless#Configuration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.emrserverless#ConfigurationOverrides": { - "type": "structure", - "members": { - "applicationConfiguration": { - "target": "com.amazonaws.emrserverless#ConfigurationList", - "traits": { - "smithy.api#documentation": "

The override configurations for the application.

" - } - }, - "monitoringConfiguration": { - "target": "com.amazonaws.emrserverless#MonitoringConfiguration", - "traits": { - "smithy.api#documentation": "

The override configurations for monitoring.

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

A configuration specification to be used to override existing configurations.

" - } - }, - "com.amazonaws.emrserverless#ConflictException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.emrserverless#String1024", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The request could not be processed because of conflict in the current state of the\n resource.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.emrserverless#CpuSize": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 15 - }, - "smithy.api#pattern": "^[1-9][0-9]*(\\s)?(vCPU|vcpu|VCPU)?$" - } - }, - "com.amazonaws.emrserverless#CreateApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#CreateApplicationRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#CreateApplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#ConflictException" - }, - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an application.

", - "smithy.api#http": { - "method": "POST", - "uri": "/applications" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.emrserverless#CreateApplicationRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.emrserverless#ApplicationName", - "traits": { - "smithy.api#documentation": "

The name of the application.

" - } - }, - "releaseLabel": { - "target": "com.amazonaws.emrserverless#ReleaseLabel", - "traits": { - "smithy.api#documentation": "

The EMR release version associated with the application.

", - "smithy.api#required": {} - } - }, - "type": { - "target": "com.amazonaws.emrserverless#EngineType", - "traits": { - "smithy.api#documentation": "

The type of application you want to start, such as Spark or Hive.

", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.emrserverless#ClientToken", - "traits": { - "smithy.api#documentation": "

The client idempotency token of the application to create. Its value must be unique for\n each request.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "initialCapacity": { - "target": "com.amazonaws.emrserverless#InitialCapacityConfigMap", - "traits": { - "smithy.api#documentation": "

The capacity to initialize when the application is created.

" - } - }, - "maximumCapacity": { - "target": "com.amazonaws.emrserverless#MaximumAllowedResources", - "traits": { - "smithy.api#documentation": "

The maximum capacity to allocate when the application is created. This is cumulative\n across all workers at any given point in time, not just when an application is created. No\n new resources will be created once any one of the defined limits is hit.

" - } - }, - "tags": { - "target": "com.amazonaws.emrserverless#TagMap", - "traits": { - "smithy.api#documentation": "

The tags assigned to the application.

" - } - }, - "autoStartConfiguration": { - "target": "com.amazonaws.emrserverless#AutoStartConfig", - "traits": { - "smithy.api#documentation": "

The configuration for an application to automatically start on job submission.

" - } - }, - "autoStopConfiguration": { - "target": "com.amazonaws.emrserverless#AutoStopConfig", - "traits": { - "smithy.api#documentation": "

The configuration for an application to automatically stop after a certain amount of\n time being idle.

" - } - }, - "networkConfiguration": { - "target": "com.amazonaws.emrserverless#NetworkConfiguration", - "traits": { - "smithy.api#documentation": "

The network configuration for customer VPC connectivity.

" - } - }, - "architecture": { - "target": "com.amazonaws.emrserverless#Architecture", - "traits": { - "smithy.api#documentation": "

The CPU architecture of an application.

" - } - } - } - }, - "com.amazonaws.emrserverless#CreateApplicationResponse": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The output contains the application ID.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - }, - "name": { - "target": "com.amazonaws.emrserverless#ApplicationName", - "traits": { - "smithy.api#documentation": "

The output contains the name of the application.

" - } - }, - "arn": { - "target": "com.amazonaws.emrserverless#ApplicationArn", - "traits": { - "smithy.api#documentation": "

The output contains the ARN of the application.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.emrserverless#Date": { - "type": "timestamp" - }, - "com.amazonaws.emrserverless#DeleteApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#DeleteApplicationRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#DeleteApplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an application. An application has to be in a stopped or created state in order\n to be deleted.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/applications/{applicationId}" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.emrserverless#DeleteApplicationRequest": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application that will be deleted.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - } - } - }, - "com.amazonaws.emrserverless#DeleteApplicationResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.emrserverless#DiskSize": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 15 - }, - "smithy.api#pattern": "^[1-9][0-9]*(\\s)?(GB|gb|gB|Gb)$" - } - }, - "com.amazonaws.emrserverless#Duration": { - "type": "long", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 1000000 - } - } - }, - "com.amazonaws.emrserverless#EncryptionKeyArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):kms:[a-zA-Z0-9\\-]*:(\\d{12})?:key\\/[a-zA-Z0-9-]+$" - } - }, - "com.amazonaws.emrserverless#EngineType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.emrserverless#EntryPointArgument": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10280 - }, - "smithy.api#pattern": ".*\\S.*", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.emrserverless#EntryPointArguments": { - "type": "list", - "member": { - "target": "com.amazonaws.emrserverless#EntryPointArgument" - } - }, - "com.amazonaws.emrserverless#EntryPointPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": ".*\\S.*", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.emrserverless#GetApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#GetApplicationRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#GetApplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Displays detailed information about a specified application.

", - "smithy.api#http": { - "method": "GET", - "uri": "/applications/{applicationId}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.emrserverless#GetApplicationRequest": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application that will be described.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - } - } - }, - "com.amazonaws.emrserverless#GetApplicationResponse": { - "type": "structure", - "members": { - "application": { - "target": "com.amazonaws.emrserverless#Application", - "traits": { - "smithy.api#documentation": "

The output displays information about the specified application.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.emrserverless#GetDashboardForJobRun": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#GetDashboardForJobRunRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#GetDashboardForJobRunResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a URL to access the job run dashboard.

", - "smithy.api#http": { - "method": "GET", - "uri": "/applications/{applicationId}/jobruns/{jobRunId}/dashboard" - } - } - }, - "com.amazonaws.emrserverless#GetDashboardForJobRunRequest": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - }, - "jobRunId": { - "target": "com.amazonaws.emrserverless#JobRunId", - "traits": { - "smithy.api#documentation": "

The ID of the job run.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "jobRunId" - } - } - } - }, - "com.amazonaws.emrserverless#GetDashboardForJobRunResponse": { - "type": "structure", - "members": { - "url": { - "target": "com.amazonaws.emrserverless#Url", - "traits": { - "smithy.api#documentation": "

The URL to view job run's dashboard.

" - } - } - } - }, - "com.amazonaws.emrserverless#GetJobRun": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#GetJobRunRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#GetJobRunResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Displays detailed information about a job run.

", - "smithy.api#http": { - "method": "GET", - "uri": "/applications/{applicationId}/jobruns/{jobRunId}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.emrserverless#GetJobRunRequest": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application on which the job run is submitted.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - }, - "jobRunId": { - "target": "com.amazonaws.emrserverless#JobRunId", - "traits": { - "smithy.api#documentation": "

The ID of the job run.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "jobRunId" - } - } - } - }, - "com.amazonaws.emrserverless#GetJobRunResponse": { - "type": "structure", - "members": { - "jobRun": { - "target": "com.amazonaws.emrserverless#JobRun", - "traits": { - "smithy.api#documentation": "

The output displays information about the job run.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.emrserverless#Hive": { - "type": "structure", - "members": { - "query": { - "target": "com.amazonaws.emrserverless#Query", - "traits": { - "smithy.api#documentation": "

The query for the Hive job run.

", - "smithy.api#required": {} - } - }, - "initQueryFile": { - "target": "com.amazonaws.emrserverless#InitScriptPath", - "traits": { - "smithy.api#documentation": "

The query file for the Hive job run.

" - } - }, - "parameters": { - "target": "com.amazonaws.emrserverless#HiveCliParameters", - "traits": { - "smithy.api#documentation": "

The parameters for the Hive job run.

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

The configurations for the Hive job driver.

" - } - }, - "com.amazonaws.emrserverless#HiveCliParameters": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 102400 - }, - "smithy.api#pattern": ".*\\S.*", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.emrserverless#IAMRoleArn": { - "type": "string", - "traits": { - "aws.api#arnReference": { - "type": "AWS::IAM::Role" - }, - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):iam::(\\d{12})?:(role((\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F))[\\w+=,.@-]+)$" - } - }, - "com.amazonaws.emrserverless#InitScriptPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": ".*\\S.*", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.emrserverless#InitialCapacityConfig": { - "type": "structure", - "members": { - "workerCount": { - "target": "com.amazonaws.emrserverless#WorkerCounts", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of workers in the initial capacity configuration.

", - "smithy.api#required": {} - } - }, - "workerConfiguration": { - "target": "com.amazonaws.emrserverless#WorkerResourceConfig", - "traits": { - "smithy.api#documentation": "

The resource configuration of the initial capacity configuration.

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

The initial capacity configuration per worker.

" - } - }, - "com.amazonaws.emrserverless#InitialCapacityConfigMap": { - "type": "map", - "key": { - "target": "com.amazonaws.emrserverless#WorkerTypeString" - }, - "value": { - "target": "com.amazonaws.emrserverless#InitialCapacityConfig" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.emrserverless#InternalServerException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.emrserverless#String1024", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Request processing failed because of an error or failure with the service.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.emrserverless#JobArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 60, - "max": 1024 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-serverless:.+:(\\d{12}):\\/applications\\/[0-9a-zA-Z]+\\/jobruns\\/[0-9a-zA-Z]+$" - } - }, - "com.amazonaws.emrserverless#JobDriver": { - "type": "union", - "members": { - "sparkSubmit": { - "target": "com.amazonaws.emrserverless#SparkSubmit", - "traits": { - "smithy.api#documentation": "

The job driver parameters specified for Spark.

" - } - }, - "hive": { - "target": "com.amazonaws.emrserverless#Hive", - "traits": { - "smithy.api#documentation": "

The job driver parameters specified for Hive.

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

The driver that the job runs on.

" - } - }, - "com.amazonaws.emrserverless#JobRun": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application the job is running on.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - }, - "jobRunId": { - "target": "com.amazonaws.emrserverless#JobRunId", - "traits": { - "smithy.api#documentation": "

The ID of the job run.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "jobRunId" - } - }, - "name": { - "target": "com.amazonaws.emrserverless#String256", - "traits": { - "smithy.api#documentation": "

The optional job run name. This doesn't have to be unique.

" - } - }, - "arn": { - "target": "com.amazonaws.emrserverless#JobArn", - "traits": { - "smithy.api#documentation": "

The execution role ARN of the job run.

", - "smithy.api#required": {} - } - }, - "createdBy": { - "target": "com.amazonaws.emrserverless#RequestIdentityUserArn", - "traits": { - "smithy.api#documentation": "

The user who created the job run.

", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.emrserverless#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the job run was created.

", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.emrserverless#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the job run was updated.

", - "smithy.api#required": {} - } - }, - "executionRole": { - "target": "com.amazonaws.emrserverless#IAMRoleArn", - "traits": { - "smithy.api#documentation": "

The execution role ARN of the job run.

", - "smithy.api#required": {} - } - }, - "state": { - "target": "com.amazonaws.emrserverless#JobRunState", - "traits": { - "smithy.api#documentation": "

The state of the job run.

", - "smithy.api#required": {} - } - }, - "stateDetails": { - "target": "com.amazonaws.emrserverless#String256", - "traits": { - "smithy.api#documentation": "

The state details of the job run.

", - "smithy.api#required": {} - } - }, - "releaseLabel": { - "target": "com.amazonaws.emrserverless#ReleaseLabel", - "traits": { - "smithy.api#documentation": "

The EMR release version associated with the application your job is running on.

", - "smithy.api#required": {} - } - }, - "configurationOverrides": { - "target": "com.amazonaws.emrserverless#ConfigurationOverrides", - "traits": { - "smithy.api#documentation": "

The configuration settings that are used to override default configuration.

" - } - }, - "jobDriver": { - "target": "com.amazonaws.emrserverless#JobDriver", - "traits": { - "smithy.api#documentation": "

The job driver for the job run.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.emrserverless#TagMap", - "traits": { - "smithy.api#documentation": "

The tags assigned to the job run.

" - } - }, - "totalResourceUtilization": { - "target": "com.amazonaws.emrserverless#TotalResourceUtilization", - "traits": { - "smithy.api#documentation": "

The aggregate vCPU, memory, and storage resources used from the time job start executing\n till the time job is terminated, rounded up to the nearest second.

" - } - }, - "networkConfiguration": { - "target": "com.amazonaws.emrserverless#NetworkConfiguration" - }, - "totalExecutionDurationSeconds": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The job run total execution duration in seconds. This field is only available for job\n runs in a COMPLETED, FAILED, or CANCELLED\n state.

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

Information about a job run. A job run is a unit of work, such as a Spark JAR, Hive\n query, or SparkSQL query, that you submit to an EMR Serverless application.

" - } - }, - "com.amazonaws.emrserverless#JobRunId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[0-9a-z]+$" - } - }, - "com.amazonaws.emrserverless#JobRunResource": { - "type": "resource", - "identifiers": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId" - }, - "jobRunId": { - "target": "com.amazonaws.emrserverless#JobRunId" - } - }, - "create": { - "target": "com.amazonaws.emrserverless#StartJobRun" - }, - "read": { - "target": "com.amazonaws.emrserverless#GetJobRun" - }, - "delete": { - "target": "com.amazonaws.emrserverless#CancelJobRun" - }, - "list": { - "target": "com.amazonaws.emrserverless#ListJobRuns" - }, - "operations": [ - { - "target": "com.amazonaws.emrserverless#GetDashboardForJobRun" - } - ] - }, - "com.amazonaws.emrserverless#JobRunState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SUBMITTED", - "name": "SUBMITTED" - }, - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "SCHEDULED", - "name": "SCHEDULED" - }, - { - "value": "RUNNING", - "name": "RUNNING" - }, - { - "value": "SUCCESS", - "name": "SUCCESS" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "CANCELLING", - "name": "CANCELLING" - }, - { - "value": "CANCELLED", - "name": "CANCELLED" - } - ] - } - }, - "com.amazonaws.emrserverless#JobRunStateSet": { - "type": "list", - "member": { - "target": "com.amazonaws.emrserverless#JobRunState" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 8 - }, - "smithy.api#uniqueItems": {} - } - }, - "com.amazonaws.emrserverless#JobRunSummary": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application the job is running on.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - }, - "id": { - "target": "com.amazonaws.emrserverless#JobRunId", - "traits": { - "smithy.api#documentation": "

The ID of the job run.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "jobRunId" - } - }, - "name": { - "target": "com.amazonaws.emrserverless#String256", - "traits": { - "smithy.api#documentation": "

The optional job run name. This doesn't have to be unique.

" - } - }, - "arn": { - "target": "com.amazonaws.emrserverless#JobArn", - "traits": { - "smithy.api#documentation": "

The ARN of the job run.

", - "smithy.api#required": {} - } - }, - "createdBy": { - "target": "com.amazonaws.emrserverless#RequestIdentityUserArn", - "traits": { - "smithy.api#documentation": "

The user who created the job run.

", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.emrserverless#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the job run was created.

", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.emrserverless#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the job run was last updated.

", - "smithy.api#required": {} - } - }, - "executionRole": { - "target": "com.amazonaws.emrserverless#IAMRoleArn", - "traits": { - "smithy.api#documentation": "

The execution role ARN of the job run.

", - "smithy.api#required": {} - } - }, - "state": { - "target": "com.amazonaws.emrserverless#JobRunState", - "traits": { - "smithy.api#documentation": "

The state of the job run.

", - "smithy.api#required": {} - } - }, - "stateDetails": { - "target": "com.amazonaws.emrserverless#String256", - "traits": { - "smithy.api#documentation": "

The state details of the job run.

", - "smithy.api#required": {} - } - }, - "releaseLabel": { - "target": "com.amazonaws.emrserverless#ReleaseLabel", - "traits": { - "smithy.api#documentation": "

The EMR release version associated with the application your job is running on.

", - "smithy.api#required": {} - } - }, - "type": { - "target": "com.amazonaws.emrserverless#JobRunType", - "traits": { - "smithy.api#documentation": "

The type of job run, such as Spark or Hive.

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

The summary of attributes associated with a job run.

" - } - }, - "com.amazonaws.emrserverless#JobRunType": { - "type": "string" - }, - "com.amazonaws.emrserverless#JobRuns": { - "type": "list", - "member": { - "target": "com.amazonaws.emrserverless#JobRunSummary" - } - }, - "com.amazonaws.emrserverless#ListApplications": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#ListApplicationsRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#ListApplicationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists applications based on a set of parameters.

", - "smithy.api#http": { - "method": "GET", - "uri": "/applications" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "applications" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.emrserverless#ListApplicationsRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.emrserverless#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of application results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of applications that can be listed.

", - "smithy.api#httpQuery": "maxResults", - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "states": { - "target": "com.amazonaws.emrserverless#ApplicationStateSet", - "traits": { - "smithy.api#documentation": "

An optional filter for application states. Note that if this filter contains multiple\n states, the resulting list will be grouped by the state.

", - "smithy.api#httpQuery": "states" - } - } - } - }, - "com.amazonaws.emrserverless#ListApplicationsResponse": { - "type": "structure", - "members": { - "applications": { - "target": "com.amazonaws.emrserverless#ApplicationList", - "traits": { - "smithy.api#documentation": "

The output lists the specified applications.

", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.emrserverless#NextToken", - "traits": { - "smithy.api#documentation": "

The output displays the token for the next set of application results. This is required\n for pagination and is available as a response of the previous request.

" - } - } - } - }, - "com.amazonaws.emrserverless#ListJobRuns": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#ListJobRunsRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#ListJobRunsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists job runs based on a set of parameters.

", - "smithy.api#http": { - "method": "GET", - "uri": "/applications/{applicationId}/jobruns" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "jobRuns" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.emrserverless#ListJobRunsRequest": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application for which to list the job run.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - }, - "nextToken": { - "target": "com.amazonaws.emrserverless#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of job run results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of job runs that can be listed.

", - "smithy.api#httpQuery": "maxResults", - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "createdAtAfter": { - "target": "com.amazonaws.emrserverless#Date", - "traits": { - "smithy.api#documentation": "

The lower bound of the option to filter by creation date and time.

", - "smithy.api#httpQuery": "createdAtAfter" - } - }, - "createdAtBefore": { - "target": "com.amazonaws.emrserverless#Date", - "traits": { - "smithy.api#documentation": "

The upper bound of the option to filter by creation date and time.

", - "smithy.api#httpQuery": "createdAtBefore" - } - }, - "states": { - "target": "com.amazonaws.emrserverless#JobRunStateSet", - "traits": { - "smithy.api#documentation": "

An optional filter for job run states. Note that if this filter contains multiple\n states, the resulting list will be grouped by the state.

", - "smithy.api#httpQuery": "states" - } - } - } - }, - "com.amazonaws.emrserverless#ListJobRunsResponse": { - "type": "structure", - "members": { - "jobRuns": { - "target": "com.amazonaws.emrserverless#JobRuns", - "traits": { - "smithy.api#documentation": "

The output lists information about the specified job runs.

", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.emrserverless#NextToken", - "traits": { - "smithy.api#documentation": "

The output displays the token for the next set of job run results. This is required for\n pagination and is available as a response of the previous request.

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

Lists the tags assigned to the resources.

", - "smithy.api#http": { - "method": "GET", - "uri": "/tags/{resourceArn}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.emrserverless#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.emrserverless#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource to list the tags for.\n Currently, the supported resources are Amazon EMR Serverless applications and job\n runs.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.emrserverless#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.emrserverless#TagMap", - "traits": { - "smithy.api#documentation": "

The tags for the resource.

" - } - } - } - }, - "com.amazonaws.emrserverless#ManagedPersistenceMonitoringConfiguration": { - "type": "structure", - "members": { - "enabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Enables managed logging and defaults to true. If set to false, managed logging will be\n turned off.

" - } - }, - "encryptionKeyArn": { - "target": "com.amazonaws.emrserverless#EncryptionKeyArn", - "traits": { - "smithy.api#documentation": "

The KMS key ARN to encrypt the logs stored in managed log persistence.

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

The managed log persistence configuration for a job run.

" - } - }, - "com.amazonaws.emrserverless#MaximumAllowedResources": { - "type": "structure", - "members": { - "cpu": { - "target": "com.amazonaws.emrserverless#CpuSize", - "traits": { - "smithy.api#documentation": "

The maximum allowed CPU for an application.

", - "smithy.api#required": {} - } - }, - "memory": { - "target": "com.amazonaws.emrserverless#MemorySize", - "traits": { - "smithy.api#documentation": "

The maximum allowed resources for an application.

", - "smithy.api#required": {} - } - }, - "disk": { - "target": "com.amazonaws.emrserverless#DiskSize", - "traits": { - "smithy.api#documentation": "

The maximum allowed disk for an application.

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

The maximum allowed cumulative resources for an application. No new resources will be\n created once the limit is hit.

" - } - }, - "com.amazonaws.emrserverless#MemorySize": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 15 - }, - "smithy.api#pattern": "^[1-9][0-9]*(\\s)?(GB|gb|gB|Gb)?$" - } - }, - "com.amazonaws.emrserverless#MonitoringConfiguration": { - "type": "structure", - "members": { - "s3MonitoringConfiguration": { - "target": "com.amazonaws.emrserverless#S3MonitoringConfiguration", - "traits": { - "smithy.api#documentation": "

The Amazon S3 configuration for monitoring log publishing.

" - } - }, - "managedPersistenceMonitoringConfiguration": { - "target": "com.amazonaws.emrserverless#ManagedPersistenceMonitoringConfiguration", - "traits": { - "smithy.api#documentation": "

The managed log persistence configuration for a job run.

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

The configuration setting for monitoring.

" - } - }, - "com.amazonaws.emrserverless#NetworkConfiguration": { - "type": "structure", - "members": { - "subnetIds": { - "target": "com.amazonaws.emrserverless#SubnetIds", - "traits": { - "smithy.api#documentation": "

The array of subnet Ids for customer VPC connectivity.

" - } - }, - "securityGroupIds": { - "target": "com.amazonaws.emrserverless#SecurityGroupIds", - "traits": { - "smithy.api#documentation": "

The array of security group Ids for customer VPC connectivity.

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

The network configuration for customer VPC connectivity.

" - } - }, - "com.amazonaws.emrserverless#NextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[A-Za-z0-9_=-]+$" - } - }, - "com.amazonaws.emrserverless#Query": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10280 - }, - "smithy.api#pattern": ".*\\S.*", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.emrserverless#ReleaseLabel": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[A-Za-z0-9._/-]+$" - } - }, - "com.amazonaws.emrserverless#RequestIdentityUserArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):(iam|sts)::(\\d{12})?:[\\w/+=,.@-]+$" - } - }, - "com.amazonaws.emrserverless#ResourceArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 60, - "max": 1024 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-serverless:.+:(\\d{12}):\\/applications\\/[0-9a-zA-Z]+(\\/jobruns\\/[0-9a-zA-Z]+)?$" - } - }, - "com.amazonaws.emrserverless#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.emrserverless#String1024", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The specified resource was not found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.emrserverless#S3MonitoringConfiguration": { - "type": "structure", - "members": { - "logUri": { - "target": "com.amazonaws.emrserverless#UriString", - "traits": { - "smithy.api#documentation": "

The Amazon S3 destination URI for log publishing.

" - } - }, - "encryptionKeyArn": { - "target": "com.amazonaws.emrserverless#EncryptionKeyArn", - "traits": { - "smithy.api#documentation": "

The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.

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

The Amazon S3 configuration for monitoring log publishing. You can configure your jobs\n to send log information to Amazon S3.

" - } - }, - "com.amazonaws.emrserverless#SecurityGroupIds": { - "type": "list", - "member": { - "target": "com.amazonaws.emrserverless#SecurityGroupString" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.emrserverless#SecurityGroupString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - }, - "smithy.api#pattern": "^[-0-9a-zA-Z]+" - } - }, - "com.amazonaws.emrserverless#SensitivePropertiesMap": { - "type": "map", - "key": { - "target": "com.amazonaws.emrserverless#String1024" - }, - "value": { - "target": "com.amazonaws.emrserverless#String1024" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.emrserverless#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.emrserverless#String1024", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The maximum number of resources per account has been reached.

", - "smithy.api#error": "client", - "smithy.api#httpError": 402 - } - }, - "com.amazonaws.emrserverless#SparkSubmit": { - "type": "structure", - "members": { - "entryPoint": { - "target": "com.amazonaws.emrserverless#EntryPointPath", - "traits": { - "smithy.api#documentation": "

The entry point for the Spark submit job run.

", - "smithy.api#required": {} - } - }, - "entryPointArguments": { - "target": "com.amazonaws.emrserverless#EntryPointArguments", - "traits": { - "smithy.api#documentation": "

The arguments for the Spark submit job run.

" - } - }, - "sparkSubmitParameters": { - "target": "com.amazonaws.emrserverless#SparkSubmitParameters", - "traits": { - "smithy.api#documentation": "

The parameters for the Spark submit job run.

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

The configurations for the Spark submit job driver.

" - } - }, - "com.amazonaws.emrserverless#SparkSubmitParameters": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 102400 - }, - "smithy.api#pattern": ".*\\S.*", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.emrserverless#StartApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#StartApplicationRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#StartApplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrserverless#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts a specified application and initializes initial capacity if configured.

", - "smithy.api#http": { - "method": "POST", - "uri": "/applications/{applicationId}/start" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.emrserverless#StartApplicationRequest": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application to start.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - } - } - }, - "com.amazonaws.emrserverless#StartApplicationResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.emrserverless#StartJobRun": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#StartJobRunRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#StartJobRunResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#ConflictException" - }, - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts a job run.

", - "smithy.api#http": { - "method": "POST", - "uri": "/applications/{applicationId}/jobruns" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.emrserverless#StartJobRunRequest": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application on which to run the job.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - }, - "clientToken": { - "target": "com.amazonaws.emrserverless#ClientToken", - "traits": { - "smithy.api#documentation": "

The client idempotency token of the job run to start. Its value must be unique for each\n request.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "executionRoleArn": { - "target": "com.amazonaws.emrserverless#IAMRoleArn", - "traits": { - "smithy.api#documentation": "

The execution role ARN for the job run.

", - "smithy.api#required": {} - } - }, - "jobDriver": { - "target": "com.amazonaws.emrserverless#JobDriver", - "traits": { - "smithy.api#documentation": "

The job driver for the job run.

" - } - }, - "configurationOverrides": { - "target": "com.amazonaws.emrserverless#ConfigurationOverrides", - "traits": { - "smithy.api#documentation": "

The configuration overrides for the job run.

" - } - }, - "tags": { - "target": "com.amazonaws.emrserverless#TagMap", - "traits": { - "smithy.api#documentation": "

The tags assigned to the job run.

" - } - }, - "executionTimeoutMinutes": { - "target": "com.amazonaws.emrserverless#Duration", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum duration for the job run to run. If the job run runs beyond this duration,\n it will be automatically cancelled.

" - } - }, - "name": { - "target": "com.amazonaws.emrserverless#String256", - "traits": { - "smithy.api#documentation": "

The optional job run name. This doesn't have to be unique.

" - } - } - } - }, - "com.amazonaws.emrserverless#StartJobRunResponse": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

This output displays the application ID on which the job run was submitted.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - }, - "jobRunId": { - "target": "com.amazonaws.emrserverless#JobRunId", - "traits": { - "smithy.api#documentation": "

The output contains the ID of the started job run.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "jobRunId" - } - }, - "arn": { - "target": "com.amazonaws.emrserverless#JobArn", - "traits": { - "smithy.api#documentation": "

The output lists the execution role ARN of the job run.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.emrserverless#StopApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#StopApplicationRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#StopApplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Stops a specified application and releases initial capacity if configured. All scheduled\n and running jobs must be completed or cancelled before stopping an application.

", - "smithy.api#http": { - "method": "POST", - "uri": "/applications/{applicationId}/stop" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.emrserverless#StopApplicationRequest": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application to stop.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - } - } - }, - "com.amazonaws.emrserverless#StopApplicationResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.emrserverless#String1024": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": ".*\\S.*" - } - }, - "com.amazonaws.emrserverless#String256": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": ".*\\S.*" - } - }, - "com.amazonaws.emrserverless#SubnetIds": { - "type": "list", - "member": { - "target": "com.amazonaws.emrserverless#SubnetString" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 16 - } - } - }, - "com.amazonaws.emrserverless#SubnetString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - }, - "smithy.api#pattern": "^[-0-9a-zA-Z]+" - } - }, - "com.amazonaws.emrserverless#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[A-Za-z0-9 /_.:=+@-]+$" - } - }, - "com.amazonaws.emrserverless#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.emrserverless#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.emrserverless#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.emrserverless#TagKey" - }, - "value": { - "target": "com.amazonaws.emrserverless#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.emrserverless#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Assigns tags to resources. A tag is a label that you assign to an AWS resource. Each tag\n consists of a key and an optional value, both of which you define. Tags enable you to\n categorize your AWS resources by attributes such as purpose, owner, or environment. When\n you have many resources of the same type, you can quickly identify a specific resource\n based on the tags you've assigned to it.

", - "smithy.api#http": { - "method": "POST", - "uri": "/tags/{resourceArn}" - } - } - }, - "com.amazonaws.emrserverless#TagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.emrserverless#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource to list the tags for.\n Currently, the supported resources are Amazon EMR Serverless applications and job\n runs.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.emrserverless#TagMap", - "traits": { - "smithy.api#documentation": "

The tags to add to the resource. A tag is an array of key-value pairs.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.emrserverless#TagResourceResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.emrserverless#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^[A-Za-z0-9 /_.:=+@-]*$" - } - }, - "com.amazonaws.emrserverless#TotalResourceUtilization": { - "type": "structure", - "members": { - "vCPUHour": { - "target": "smithy.api#Double", - "traits": { - "smithy.api#documentation": "

The aggregated vCPU used per hour from the time job start executing till the time job is\n terminated.

" - } - }, - "memoryGBHour": { - "target": "smithy.api#Double", - "traits": { - "smithy.api#documentation": "

The aggregated memory used per hour from the time job start executing till the time job\n is terminated.

" - } - }, - "storageGBHour": { - "target": "smithy.api#Double", - "traits": { - "smithy.api#documentation": "

The aggregated storage used per hour from the time job start executing till the time job\n is terminated.

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

The aggregate vCPU, memory, and storage resources used from the time job start executing\n till the time job is terminated, rounded up to the nearest second.

" - } - }, - "com.amazonaws.emrserverless#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes tags from resources.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/tags/{resourceArn}" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.emrserverless#UntagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.emrserverless#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource to list the tags for.\n Currently, the supported resources are Amazon EMR Serverless applications and job\n runs.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tagKeys": { - "target": "com.amazonaws.emrserverless#TagKeyList", - "traits": { - "smithy.api#documentation": "

The keys of the tags to be removed.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.emrserverless#UntagResourceResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.emrserverless#UpdateApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#UpdateApplicationRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#UpdateApplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a specified application. An application has to be in a stopped or created state\n in order to be updated.

", - "smithy.api#http": { - "method": "PATCH", - "uri": "/applications/{applicationId}" - } - } - }, - "com.amazonaws.emrserverless#UpdateApplicationRequest": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - }, - "clientToken": { - "target": "com.amazonaws.emrserverless#ClientToken", - "traits": { - "smithy.api#documentation": "

The client idempotency token of the application to update. Its value must be unique for\n each request.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "initialCapacity": { - "target": "com.amazonaws.emrserverless#InitialCapacityConfigMap", - "traits": { - "smithy.api#documentation": "

The capacity to initialize when the application is updated.

" - } - }, - "maximumCapacity": { - "target": "com.amazonaws.emrserverless#MaximumAllowedResources", - "traits": { - "smithy.api#documentation": "

The maximum capacity to allocate when the application is updated. This is cumulative\n across all workers at any given point in time during the lifespan of the application. No\n new resources will be created once any one of the defined limits is hit.

" - } - }, - "autoStartConfiguration": { - "target": "com.amazonaws.emrserverless#AutoStartConfig", - "traits": { - "smithy.api#documentation": "

The configuration for an application to automatically start on job submission.

" - } - }, - "autoStopConfiguration": { - "target": "com.amazonaws.emrserverless#AutoStopConfig", - "traits": { - "smithy.api#documentation": "

The configuration for an application to automatically stop after a certain amount of\n time being idle.

" - } - }, - "networkConfiguration": { - "target": "com.amazonaws.emrserverless#NetworkConfiguration" - }, - "architecture": { - "target": "com.amazonaws.emrserverless#Architecture", - "traits": { - "smithy.api#documentation": "

The CPU architecture of an application.

" - } - } - } - }, - "com.amazonaws.emrserverless#UpdateApplicationResponse": { - "type": "structure", - "members": { - "application": { - "target": "com.amazonaws.emrserverless#Application", - "traits": { - "smithy.api#documentation": "

Information about the updated application.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.emrserverless#UriString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10280 - }, - "smithy.api#pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\r\\n\\t]*" - } - }, - "com.amazonaws.emrserverless#Url": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.emrserverless#ValidationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.emrserverless#String1024", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The input fails to satisfy the constraints specified by an AWS service.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.emrserverless#WorkerCounts": { - "type": "long", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 1000000 - } - } - }, - "com.amazonaws.emrserverless#WorkerResourceConfig": { - "type": "structure", - "members": { - "cpu": { - "target": "com.amazonaws.emrserverless#CpuSize", - "traits": { - "smithy.api#documentation": "

The CPU requirements for every worker instance of the worker type.

", - "smithy.api#required": {} - } - }, - "memory": { - "target": "com.amazonaws.emrserverless#MemorySize", - "traits": { - "smithy.api#documentation": "

The memory requirements for every worker instance of the worker type.

", - "smithy.api#required": {} - } - }, - "disk": { - "target": "com.amazonaws.emrserverless#DiskSize", - "traits": { - "smithy.api#documentation": "

The disk requirements for every worker instance of the worker type.

" - } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.eu-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.us-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.us-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.us-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-west-2" + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.eu-north-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.eu-north-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.eu-west-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.eu-west-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.eu-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.eu-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.eu-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.eu-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ap-northeast-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-northeast-3" + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-northeast-3" + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ap-northeast-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-northeast-3" + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-northeast-3" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ap-northeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ap-northeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ap-northeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.sa-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.sa-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ap-southeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.us-east-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.us-east-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.us-east-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-2" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1", + "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": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1", + "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": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.emrserverless#CancelJobRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#CancelJobRunRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#CancelJobRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels a job run.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/applications/{applicationId}/jobruns/{jobRunId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.emrserverless#CancelJobRunRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application on which the job run will be canceled.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "jobRunId": { + "target": "com.amazonaws.emrserverless#JobRunId", + "traits": { + "smithy.api#documentation": "

The ID of the job run to cancel.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "jobRunId" + } + } + } + }, + "com.amazonaws.emrserverless#CancelJobRunResponse": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The output contains the application ID on which the job run is cancelled.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "jobRunId": { + "target": "com.amazonaws.emrserverless#JobRunId", + "traits": { + "smithy.api#documentation": "

The output contains the ID of the cancelled job run.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "jobRunId" + } + } + } + }, + "com.amazonaws.emrserverless#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9._-]+$" + } + }, + "com.amazonaws.emrserverless#Configuration": { + "type": "structure", + "members": { + "classification": { + "target": "com.amazonaws.emrserverless#String1024", + "traits": { + "smithy.api#documentation": "

The classification within a configuration.

", + "smithy.api#required": {} + } + }, + "properties": { + "target": "com.amazonaws.emrserverless#SensitivePropertiesMap", + "traits": { + "smithy.api#documentation": "

A set of properties specified within a configuration classification.

" + } + }, + "configurations": { + "target": "com.amazonaws.emrserverless#ConfigurationList", + "traits": { + "smithy.api#documentation": "

A list of additional configurations to apply within a configuration object.

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

A configuration specification to be used when provisioning an application. A\n configuration consists of a classification, properties, and optional nested configurations.\n A classification refers to an application-specific configuration file. Properties are the\n settings you want to change in that file.

" + } + }, + "com.amazonaws.emrserverless#ConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#Configuration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.emrserverless#ConfigurationOverrides": { + "type": "structure", + "members": { + "applicationConfiguration": { + "target": "com.amazonaws.emrserverless#ConfigurationList", + "traits": { + "smithy.api#documentation": "

The override configurations for the application.

" + } + }, + "monitoringConfiguration": { + "target": "com.amazonaws.emrserverless#MonitoringConfiguration", + "traits": { + "smithy.api#documentation": "

The override configurations for monitoring.

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

A configuration specification to be used to override existing configurations.

" + } + }, + "com.amazonaws.emrserverless#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.emrserverless#String1024", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request could not be processed because of conflict in the current state of the\n resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.emrserverless#CpuSize": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 15 + }, + "smithy.api#pattern": "^[1-9][0-9]*(\\s)?(vCPU|vcpu|VCPU)?$" + } + }, + "com.amazonaws.emrserverless#CreateApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#CreateApplicationRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#CreateApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#ConflictException" + }, + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an application.

", + "smithy.api#http": { + "method": "POST", + "uri": "/applications" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.emrserverless#CreateApplicationRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.emrserverless#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of the application.

" + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrserverless#ReleaseLabel", + "traits": { + "smithy.api#documentation": "

The EMR release associated with the application.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.emrserverless#EngineType", + "traits": { + "smithy.api#documentation": "

The type of application you want to start, such as Spark or Hive.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.emrserverless#ClientToken", + "traits": { + "smithy.api#documentation": "

The client idempotency token of the application to create. Its value must be unique for\n each request.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "initialCapacity": { + "target": "com.amazonaws.emrserverless#InitialCapacityConfigMap", + "traits": { + "smithy.api#documentation": "

The capacity to initialize when the application is created.

" + } + }, + "maximumCapacity": { + "target": "com.amazonaws.emrserverless#MaximumAllowedResources", + "traits": { + "smithy.api#documentation": "

The maximum capacity to allocate when the application is created. This is cumulative\n across all workers at any given point in time, not just when an application is created. No\n new resources will be created once any one of the defined limits is hit.

" + } + }, + "tags": { + "target": "com.amazonaws.emrserverless#TagMap", + "traits": { + "smithy.api#documentation": "

The tags assigned to the application.

" + } + }, + "autoStartConfiguration": { + "target": "com.amazonaws.emrserverless#AutoStartConfig", + "traits": { + "smithy.api#documentation": "

The configuration for an application to automatically start on job submission.

" + } + }, + "autoStopConfiguration": { + "target": "com.amazonaws.emrserverless#AutoStopConfig", + "traits": { + "smithy.api#documentation": "

The configuration for an application to automatically stop after a certain amount of\n time being idle.

" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.emrserverless#NetworkConfiguration", + "traits": { + "smithy.api#documentation": "

The network configuration for customer VPC connectivity.

" + } + }, + "architecture": { + "target": "com.amazonaws.emrserverless#Architecture", + "traits": { + "smithy.api#documentation": "

The CPU architecture of an application.

" + } + }, + "imageConfiguration": { + "target": "com.amazonaws.emrserverless#ImageConfigurationInput", + "traits": { + "smithy.api#documentation": "

The image configuration for all worker types. You can either set this parameter or imageConfiguration \n for each worker type in workerTypeSpecifications.

" + } + }, + "workerTypeSpecifications": { + "target": "com.amazonaws.emrserverless#WorkerTypeSpecificationInputMap", + "traits": { + "smithy.api#documentation": "

The key-value pairs that specify worker type to WorkerTypeSpecificationInput. This parameter must contain all valid \n worker types for a Spark or Hive application. Valid worker types include Driver and Executor for \n Spark applications and HiveDriver and TezTask for Hive applications. You can either set \n image details in this parameter for each worker type, or in imageConfiguration for all worker types.

" + } + } + } + }, + "com.amazonaws.emrserverless#CreateApplicationResponse": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The output contains the application ID.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "name": { + "target": "com.amazonaws.emrserverless#ApplicationName", + "traits": { + "smithy.api#documentation": "

The output contains the name of the application.

" + } + }, + "arn": { + "target": "com.amazonaws.emrserverless#ApplicationArn", + "traits": { + "smithy.api#documentation": "

The output contains the ARN of the application.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emrserverless#Date": { + "type": "timestamp" + }, + "com.amazonaws.emrserverless#DeleteApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#DeleteApplicationRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#DeleteApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an application. An application has to be in a stopped or created state in order\n to be deleted.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/applications/{applicationId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.emrserverless#DeleteApplicationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application that will be deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + } + } + }, + "com.amazonaws.emrserverless#DeleteApplicationResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.emrserverless#DiskSize": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 15 + }, + "smithy.api#pattern": "^[1-9][0-9]*(\\s)?(GB|gb|gB|Gb)$" + } + }, + "com.amazonaws.emrserverless#Duration": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 1000000 + } + } + }, + "com.amazonaws.emrserverless#EncryptionKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):kms:[a-zA-Z0-9\\-]*:(\\d{12})?:key\\/[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.emrserverless#EngineType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.emrserverless#EntryPointArgument": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10280 + }, + "smithy.api#pattern": ".*\\S.*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrserverless#EntryPointArguments": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#EntryPointArgument" + } + }, + "com.amazonaws.emrserverless#EntryPointPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": ".*\\S.*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrserverless#GetApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#GetApplicationRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#GetApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Displays detailed information about a specified application.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.emrserverless#GetApplicationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application that will be described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + } + } + }, + "com.amazonaws.emrserverless#GetApplicationResponse": { + "type": "structure", + "members": { + "application": { + "target": "com.amazonaws.emrserverless#Application", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The output displays information about the specified application.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emrserverless#GetDashboardForJobRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#GetDashboardForJobRunRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#GetDashboardForJobRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a URL to access the job run dashboard.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/jobruns/{jobRunId}/dashboard" + } + } + }, + "com.amazonaws.emrserverless#GetDashboardForJobRunRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "jobRunId": { + "target": "com.amazonaws.emrserverless#JobRunId", + "traits": { + "smithy.api#documentation": "

The ID of the job run.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "jobRunId" + } + } + } + }, + "com.amazonaws.emrserverless#GetDashboardForJobRunResponse": { + "type": "structure", + "members": { + "url": { + "target": "com.amazonaws.emrserverless#Url", + "traits": { + "smithy.api#documentation": "

The URL to view job run's dashboard.

" + } + } + } + }, + "com.amazonaws.emrserverless#GetJobRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#GetJobRunRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#GetJobRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Displays detailed information about a job run.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/jobruns/{jobRunId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.emrserverless#GetJobRunRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application on which the job run is submitted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "jobRunId": { + "target": "com.amazonaws.emrserverless#JobRunId", + "traits": { + "smithy.api#documentation": "

The ID of the job run.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "jobRunId" + } + } + } + }, + "com.amazonaws.emrserverless#GetJobRunResponse": { + "type": "structure", + "members": { + "jobRun": { + "target": "com.amazonaws.emrserverless#JobRun", + "traits": { + "smithy.api#documentation": "

The output displays information about the job run.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emrserverless#Hive": { + "type": "structure", + "members": { + "query": { + "target": "com.amazonaws.emrserverless#Query", + "traits": { + "smithy.api#documentation": "

The query for the Hive job run.

", + "smithy.api#required": {} + } + }, + "initQueryFile": { + "target": "com.amazonaws.emrserverless#InitScriptPath", + "traits": { + "smithy.api#documentation": "

The query file for the Hive job run.

" + } + }, + "parameters": { + "target": "com.amazonaws.emrserverless#HiveCliParameters", + "traits": { + "smithy.api#documentation": "

The parameters for the Hive job run.

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

The configurations for the Hive job driver.

" + } + }, + "com.amazonaws.emrserverless#HiveCliParameters": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 102400 + }, + "smithy.api#pattern": ".*\\S.*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrserverless#IAMRoleArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::IAM::Role" + }, + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):iam::(\\d{12})?:(role((\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F))[\\w+=,.@-]+)$" + } + }, + "com.amazonaws.emrserverless#ImageConfiguration": { + "type": "structure", + "members": { + "imageUri": { + "target": "com.amazonaws.emrserverless#ImageUri", + "traits": { + "smithy.api#documentation": "

The image URI.

", + "smithy.api#required": {} + } + }, + "resolvedImageDigest": { + "target": "com.amazonaws.emrserverless#ImageDigest", + "traits": { + "smithy.api#documentation": "

The SHA256 digest of the image URI. This indicates which specific image \n the application is configured for. The image digest doesn't exist until an application has started.

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

The applied image configuration.

" + } + }, + "com.amazonaws.emrserverless#ImageConfigurationInput": { + "type": "structure", + "members": { + "imageUri": { + "target": "com.amazonaws.emrserverless#ImageUri", + "traits": { + "smithy.api#documentation": "

The URI of an image in the Amazon ECR registry. This field is required when you create a new \n application. If you leave this field blank in an update, Amazon EMR will remove the image configuration.

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

The image configuration.

" + } + }, + "com.amazonaws.emrserverless#ImageDigest": { + "type": "string", + "traits": { + "smithy.api#documentation": "Image Digest", + "smithy.api#pattern": "^sha256:[0-9a-f]{64}$" + } + }, + "com.amazonaws.emrserverless#ImageUri": { + "type": "string", + "traits": { + "smithy.api#documentation": "Image URI", + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^([a-z0-9]+[a-z0-9-.]*)\\/((?:[a-z0-9]+(?:[._-][a-z0-9]+)*\\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)(?:\\:([a-zA-Z0-9_][a-zA-Z0-9-._]{0,299})|@(sha256:[0-9a-f]{64}))$" + } + }, + "com.amazonaws.emrserverless#InitScriptPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": ".*\\S.*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrserverless#InitialCapacityConfig": { + "type": "structure", + "members": { + "workerCount": { + "target": "com.amazonaws.emrserverless#WorkerCounts", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of workers in the initial capacity configuration.

", + "smithy.api#required": {} + } + }, + "workerConfiguration": { + "target": "com.amazonaws.emrserverless#WorkerResourceConfig", + "traits": { + "smithy.api#documentation": "

The resource configuration of the initial capacity configuration.

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

The initial capacity configuration per worker.

" + } + }, + "com.amazonaws.emrserverless#InitialCapacityConfigMap": { + "type": "map", + "key": { + "target": "com.amazonaws.emrserverless#WorkerTypeString" + }, + "value": { + "target": "com.amazonaws.emrserverless#InitialCapacityConfig" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.emrserverless#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.emrserverless#String1024", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Request processing failed because of an error or failure with the service.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.emrserverless#JobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 60, + "max": 1024 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-serverless:.+:(\\d{12}):\\/applications\\/[0-9a-zA-Z]+\\/jobruns\\/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.emrserverless#JobDriver": { + "type": "union", + "members": { + "sparkSubmit": { + "target": "com.amazonaws.emrserverless#SparkSubmit", + "traits": { + "smithy.api#documentation": "

The job driver parameters specified for Spark.

" + } + }, + "hive": { + "target": "com.amazonaws.emrserverless#Hive", + "traits": { + "smithy.api#documentation": "

The job driver parameters specified for Hive.

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

The driver that the job runs on.

" + } + }, + "com.amazonaws.emrserverless#JobRun": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application the job is running on.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "jobRunId": { + "target": "com.amazonaws.emrserverless#JobRunId", + "traits": { + "smithy.api#documentation": "

The ID of the job run.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "jobRunId" + } + }, + "name": { + "target": "com.amazonaws.emrserverless#String256", + "traits": { + "smithy.api#documentation": "

The optional job run name. This doesn't have to be unique.

" + } + }, + "arn": { + "target": "com.amazonaws.emrserverless#JobArn", + "traits": { + "smithy.api#documentation": "

The execution role ARN of the job run.

", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.emrserverless#RequestIdentityUserArn", + "traits": { + "smithy.api#documentation": "

The user who created the job run.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the job run was created.

", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the job run was updated.

", + "smithy.api#required": {} + } + }, + "executionRole": { + "target": "com.amazonaws.emrserverless#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

The execution role ARN of the job run.

", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.emrserverless#JobRunState", + "traits": { + "smithy.api#documentation": "

The state of the job run.

", + "smithy.api#required": {} + } + }, + "stateDetails": { + "target": "com.amazonaws.emrserverless#String256", + "traits": { + "smithy.api#documentation": "

The state details of the job run.

", + "smithy.api#required": {} + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrserverless#ReleaseLabel", + "traits": { + "smithy.api#documentation": "

The EMR release associated with the application your job is running on.

", + "smithy.api#required": {} + } + }, + "configurationOverrides": { + "target": "com.amazonaws.emrserverless#ConfigurationOverrides", + "traits": { + "smithy.api#documentation": "

The configuration settings that are used to override default configuration.

" + } + }, + "jobDriver": { + "target": "com.amazonaws.emrserverless#JobDriver", + "traits": { + "smithy.api#documentation": "

The job driver for the job run.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.emrserverless#TagMap", + "traits": { + "smithy.api#documentation": "

The tags assigned to the job run.

" + } + }, + "totalResourceUtilization": { + "target": "com.amazonaws.emrserverless#TotalResourceUtilization", + "traits": { + "smithy.api#documentation": "

The aggregate vCPU, memory, and storage resources used from the time job start executing\n till the time job is terminated, rounded up to the nearest second.

" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.emrserverless#NetworkConfiguration" + }, + "totalExecutionDurationSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The job run total execution duration in seconds. This field is only available for job\n runs in a COMPLETED, FAILED, or CANCELLED\n state.

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

Information about a job run. A job run is a unit of work, such as a Spark JAR, Hive\n query, or SparkSQL query, that you submit to an EMR Serverless application.

" + } + }, + "com.amazonaws.emrserverless#JobRunId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9a-z]+$" + } + }, + "com.amazonaws.emrserverless#JobRunResource": { + "type": "resource", + "identifiers": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId" + }, + "jobRunId": { + "target": "com.amazonaws.emrserverless#JobRunId" + } + }, + "create": { + "target": "com.amazonaws.emrserverless#StartJobRun" + }, + "read": { + "target": "com.amazonaws.emrserverless#GetJobRun" + }, + "delete": { + "target": "com.amazonaws.emrserverless#CancelJobRun" + }, + "list": { + "target": "com.amazonaws.emrserverless#ListJobRuns" + }, + "operations": [ + { + "target": "com.amazonaws.emrserverless#GetDashboardForJobRun" + } + ] + }, + "com.amazonaws.emrserverless#JobRunState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SUBMITTED", + "name": "SUBMITTED" + }, + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "SCHEDULED", + "name": "SCHEDULED" + }, + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "SUCCESS", + "name": "SUCCESS" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "CANCELLING", + "name": "CANCELLING" + }, + { + "value": "CANCELLED", + "name": "CANCELLED" + } + ] + } + }, + "com.amazonaws.emrserverless#JobRunStateSet": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#JobRunState" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 8 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.emrserverless#JobRunSummary": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application the job is running on.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "id": { + "target": "com.amazonaws.emrserverless#JobRunId", + "traits": { + "smithy.api#documentation": "

The ID of the job run.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "jobRunId" + } + }, + "name": { + "target": "com.amazonaws.emrserverless#String256", + "traits": { + "smithy.api#documentation": "

The optional job run name. This doesn't have to be unique.

" + } + }, + "arn": { + "target": "com.amazonaws.emrserverless#JobArn", + "traits": { + "smithy.api#documentation": "

The ARN of the job run.

", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.emrserverless#RequestIdentityUserArn", + "traits": { + "smithy.api#documentation": "

The user who created the job run.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the job run was created.

", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the job run was last updated.

", + "smithy.api#required": {} + } + }, + "executionRole": { + "target": "com.amazonaws.emrserverless#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

The execution role ARN of the job run.

", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.emrserverless#JobRunState", + "traits": { + "smithy.api#documentation": "

The state of the job run.

", + "smithy.api#required": {} + } + }, + "stateDetails": { + "target": "com.amazonaws.emrserverless#String256", + "traits": { + "smithy.api#documentation": "

The state details of the job run.

", + "smithy.api#required": {} + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrserverless#ReleaseLabel", + "traits": { + "smithy.api#documentation": "

The EMR release associated with the application your job is running on.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.emrserverless#JobRunType", + "traits": { + "smithy.api#documentation": "

The type of job run, such as Spark or Hive.

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

The summary of attributes associated with a job run.

" + } + }, + "com.amazonaws.emrserverless#JobRunType": { + "type": "string" + }, + "com.amazonaws.emrserverless#JobRuns": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#JobRunSummary" + } + }, + "com.amazonaws.emrserverless#ListApplications": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#ListApplicationsRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#ListApplicationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists applications based on a set of parameters.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "applications" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.emrserverless#ListApplicationsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.emrserverless#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of application results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of applications that can be listed.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "states": { + "target": "com.amazonaws.emrserverless#ApplicationStateSet", + "traits": { + "smithy.api#documentation": "

An optional filter for application states. Note that if this filter contains multiple\n states, the resulting list will be grouped by the state.

", + "smithy.api#httpQuery": "states" + } + } + } + }, + "com.amazonaws.emrserverless#ListApplicationsResponse": { + "type": "structure", + "members": { + "applications": { + "target": "com.amazonaws.emrserverless#ApplicationList", + "traits": { + "smithy.api#documentation": "

The output lists the specified applications.

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

The output displays the token for the next set of application results. This is required\n for pagination and is available as a response of the previous request.

" + } + } + } + }, + "com.amazonaws.emrserverless#ListJobRuns": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#ListJobRunsRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#ListJobRunsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists job runs based on a set of parameters.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/jobruns" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "jobRuns" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.emrserverless#ListJobRunsRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application for which to list the job run.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "nextToken": { + "target": "com.amazonaws.emrserverless#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of job run results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of job runs that can be listed.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "createdAtAfter": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "

The lower bound of the option to filter by creation date and time.

", + "smithy.api#httpQuery": "createdAtAfter" + } + }, + "createdAtBefore": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "

The upper bound of the option to filter by creation date and time.

", + "smithy.api#httpQuery": "createdAtBefore" + } + }, + "states": { + "target": "com.amazonaws.emrserverless#JobRunStateSet", + "traits": { + "smithy.api#documentation": "

An optional filter for job run states. Note that if this filter contains multiple\n states, the resulting list will be grouped by the state.

", + "smithy.api#httpQuery": "states" + } + } + } + }, + "com.amazonaws.emrserverless#ListJobRunsResponse": { + "type": "structure", + "members": { + "jobRuns": { + "target": "com.amazonaws.emrserverless#JobRuns", + "traits": { + "smithy.api#documentation": "

The output lists information about the specified job runs.

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

The output displays the token for the next set of job run results. This is required for\n pagination and is available as a response of the previous request.

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

Lists the tags assigned to the resources.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.emrserverless#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.emrserverless#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource to list the tags for.\n Currently, the supported resources are Amazon EMR Serverless applications and job\n runs.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emrserverless#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.emrserverless#TagMap", + "traits": { + "smithy.api#documentation": "

The tags for the resource.

" + } + } + } + }, + "com.amazonaws.emrserverless#ManagedPersistenceMonitoringConfiguration": { + "type": "structure", + "members": { + "enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Enables managed logging and defaults to true. If set to false, managed logging will be\n turned off.

" + } + }, + "encryptionKeyArn": { + "target": "com.amazonaws.emrserverless#EncryptionKeyArn", + "traits": { + "smithy.api#documentation": "

The KMS key ARN to encrypt the logs stored in managed log persistence.

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

The managed log persistence configuration for a job run.

" + } + }, + "com.amazonaws.emrserverless#MaximumAllowedResources": { + "type": "structure", + "members": { + "cpu": { + "target": "com.amazonaws.emrserverless#CpuSize", + "traits": { + "smithy.api#documentation": "

The maximum allowed CPU for an application.

", + "smithy.api#required": {} + } + }, + "memory": { + "target": "com.amazonaws.emrserverless#MemorySize", + "traits": { + "smithy.api#documentation": "

The maximum allowed resources for an application.

", + "smithy.api#required": {} + } + }, + "disk": { + "target": "com.amazonaws.emrserverless#DiskSize", + "traits": { + "smithy.api#documentation": "

The maximum allowed disk for an application.

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

The maximum allowed cumulative resources for an application. No new resources will be\n created once the limit is hit.

" + } + }, + "com.amazonaws.emrserverless#MemorySize": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 15 + }, + "smithy.api#pattern": "^[1-9][0-9]*(\\s)?(GB|gb|gB|Gb)?$" + } + }, + "com.amazonaws.emrserverless#MonitoringConfiguration": { + "type": "structure", + "members": { + "s3MonitoringConfiguration": { + "target": "com.amazonaws.emrserverless#S3MonitoringConfiguration", + "traits": { + "smithy.api#documentation": "

The Amazon S3 configuration for monitoring log publishing.

" + } + }, + "managedPersistenceMonitoringConfiguration": { + "target": "com.amazonaws.emrserverless#ManagedPersistenceMonitoringConfiguration", + "traits": { + "smithy.api#documentation": "

The managed log persistence configuration for a job run.

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

The configuration setting for monitoring.

" + } + }, + "com.amazonaws.emrserverless#NetworkConfiguration": { + "type": "structure", + "members": { + "subnetIds": { + "target": "com.amazonaws.emrserverless#SubnetIds", + "traits": { + "smithy.api#documentation": "

The array of subnet Ids for customer VPC connectivity.

" + } + }, + "securityGroupIds": { + "target": "com.amazonaws.emrserverless#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "

The array of security group Ids for customer VPC connectivity.

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

The network configuration for customer VPC connectivity.

" + } + }, + "com.amazonaws.emrserverless#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[A-Za-z0-9_=-]+$" + } + }, + "com.amazonaws.emrserverless#Query": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10280 + }, + "smithy.api#pattern": ".*\\S.*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrserverless#ReleaseLabel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9._/-]+$" + } + }, + "com.amazonaws.emrserverless#RequestIdentityUserArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):(iam|sts)::(\\d{12})?:[\\w/+=,.@-]+$" + } + }, + "com.amazonaws.emrserverless#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 60, + "max": 1024 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-serverless:.+:(\\d{12}):\\/applications\\/[0-9a-zA-Z]+(\\/jobruns\\/[0-9a-zA-Z]+)?$" + } + }, + "com.amazonaws.emrserverless#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.emrserverless#String1024", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified resource was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.emrserverless#S3MonitoringConfiguration": { + "type": "structure", + "members": { + "logUri": { + "target": "com.amazonaws.emrserverless#UriString", + "traits": { + "smithy.api#documentation": "

The Amazon S3 destination URI for log publishing.

" + } + }, + "encryptionKeyArn": { + "target": "com.amazonaws.emrserverless#EncryptionKeyArn", + "traits": { + "smithy.api#documentation": "

The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.

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

The Amazon S3 configuration for monitoring log publishing. You can configure your jobs\n to send log information to Amazon S3.

" + } + }, + "com.amazonaws.emrserverless#SecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#SecurityGroupString" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.emrserverless#SecurityGroupString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+" + } + }, + "com.amazonaws.emrserverless#SensitivePropertiesMap": { + "type": "map", + "key": { + "target": "com.amazonaws.emrserverless#String1024" + }, + "value": { + "target": "com.amazonaws.emrserverless#String1024" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrserverless#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.emrserverless#String1024", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The maximum number of resources per account has been reached.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.emrserverless#SparkSubmit": { + "type": "structure", + "members": { + "entryPoint": { + "target": "com.amazonaws.emrserverless#EntryPointPath", + "traits": { + "smithy.api#documentation": "

The entry point for the Spark submit job run.

", + "smithy.api#required": {} + } + }, + "entryPointArguments": { + "target": "com.amazonaws.emrserverless#EntryPointArguments", + "traits": { + "smithy.api#documentation": "

The arguments for the Spark submit job run.

" + } + }, + "sparkSubmitParameters": { + "target": "com.amazonaws.emrserverless#SparkSubmitParameters", + "traits": { + "smithy.api#documentation": "

The parameters for the Spark submit job run.

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

The configurations for the Spark submit job driver.

" + } + }, + "com.amazonaws.emrserverless#SparkSubmitParameters": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 102400 + }, + "smithy.api#pattern": ".*\\S.*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrserverless#StartApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#StartApplicationRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#StartApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a specified application and initializes initial capacity if configured.

", + "smithy.api#http": { + "method": "POST", + "uri": "/applications/{applicationId}/start" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.emrserverless#StartApplicationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application to start.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + } + } + }, + "com.amazonaws.emrserverless#StartApplicationResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.emrserverless#StartJobRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#StartJobRunRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#StartJobRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#ConflictException" + }, + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a job run.

", + "smithy.api#http": { + "method": "POST", + "uri": "/applications/{applicationId}/jobruns" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.emrserverless#StartJobRunRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application on which to run the job.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "clientToken": { + "target": "com.amazonaws.emrserverless#ClientToken", + "traits": { + "smithy.api#documentation": "

The client idempotency token of the job run to start. Its value must be unique for each\n request.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "executionRoleArn": { + "target": "com.amazonaws.emrserverless#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

The execution role ARN for the job run.

", + "smithy.api#required": {} + } + }, + "jobDriver": { + "target": "com.amazonaws.emrserverless#JobDriver", + "traits": { + "smithy.api#documentation": "

The job driver for the job run.

" + } + }, + "configurationOverrides": { + "target": "com.amazonaws.emrserverless#ConfigurationOverrides", + "traits": { + "smithy.api#documentation": "

The configuration overrides for the job run.

" + } + }, + "tags": { + "target": "com.amazonaws.emrserverless#TagMap", + "traits": { + "smithy.api#documentation": "

The tags assigned to the job run.

" + } + }, + "executionTimeoutMinutes": { + "target": "com.amazonaws.emrserverless#Duration", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum duration for the job run to run. If the job run runs beyond this duration,\n it will be automatically cancelled.

" + } + }, + "name": { + "target": "com.amazonaws.emrserverless#String256", + "traits": { + "smithy.api#documentation": "

The optional job run name. This doesn't have to be unique.

" + } + } + } + }, + "com.amazonaws.emrserverless#StartJobRunResponse": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

This output displays the application ID on which the job run was submitted.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "jobRunId": { + "target": "com.amazonaws.emrserverless#JobRunId", + "traits": { + "smithy.api#documentation": "

The output contains the ID of the started job run.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "jobRunId" + } + }, + "arn": { + "target": "com.amazonaws.emrserverless#JobArn", + "traits": { + "smithy.api#documentation": "

The output lists the execution role ARN of the job run.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emrserverless#StopApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#StopApplicationRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#StopApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a specified application and releases initial capacity if configured. All scheduled\n and running jobs must be completed or cancelled before stopping an application.

", + "smithy.api#http": { + "method": "POST", + "uri": "/applications/{applicationId}/stop" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.emrserverless#StopApplicationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application to stop.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + } + } + }, + "com.amazonaws.emrserverless#StopApplicationResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.emrserverless#String1024": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": ".*\\S.*" + } + }, + "com.amazonaws.emrserverless#String256": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": ".*\\S.*" + } + }, + "com.amazonaws.emrserverless#SubnetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#SubnetString" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 16 + } + } + }, + "com.amazonaws.emrserverless#SubnetString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+" + } + }, + "com.amazonaws.emrserverless#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Za-z0-9 /_.:=+@-]+$" + } + }, + "com.amazonaws.emrserverless#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.emrserverless#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.emrserverless#TagKey" + }, + "value": { + "target": "com.amazonaws.emrserverless#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.emrserverless#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Assigns tags to resources. A tag is a label that you assign to an AWS resource. Each tag\n consists of a key and an optional value, both of which you define. Tags enable you to\n categorize your AWS resources by attributes such as purpose, owner, or environment. When\n you have many resources of the same type, you can quickly identify a specific resource\n based on the tags you've assigned to it.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}" + } + } + }, + "com.amazonaws.emrserverless#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.emrserverless#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource to list the tags for.\n Currently, the supported resources are Amazon EMR Serverless applications and job\n runs.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.emrserverless#TagMap", + "traits": { + "smithy.api#documentation": "

The tags to add to the resource. A tag is an array of key-value pairs.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emrserverless#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.emrserverless#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9 /_.:=+@-]*$" + } + }, + "com.amazonaws.emrserverless#TotalResourceUtilization": { + "type": "structure", + "members": { + "vCPUHour": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The aggregated vCPU used per hour from the time job start executing till the time job is\n terminated.

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

The aggregated memory used per hour from the time job start executing till the time job\n is terminated.

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

The aggregated storage used per hour from the time job start executing till the time job\n is terminated.

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

The aggregate vCPU, memory, and storage resources used from the time job start executing\n till the time job is terminated, rounded up to the nearest second.

" + } + }, + "com.amazonaws.emrserverless#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes tags from resources.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.emrserverless#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.emrserverless#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource to list the tags for.\n Currently, the supported resources are Amazon EMR Serverless applications and job\n runs.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.emrserverless#TagKeyList", + "traits": { + "smithy.api#documentation": "

The keys of the tags to be removed.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emrserverless#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.emrserverless#UpdateApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#UpdateApplicationRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#UpdateApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a specified application. An application has to be in a stopped or created state\n in order to be updated.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/applications/{applicationId}" + } + } + }, + "com.amazonaws.emrserverless#UpdateApplicationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "clientToken": { + "target": "com.amazonaws.emrserverless#ClientToken", + "traits": { + "smithy.api#documentation": "

The client idempotency token of the application to update. Its value must be unique for\n each request.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "initialCapacity": { + "target": "com.amazonaws.emrserverless#InitialCapacityConfigMap", + "traits": { + "smithy.api#documentation": "

The capacity to initialize when the application is updated.

" + } + }, + "maximumCapacity": { + "target": "com.amazonaws.emrserverless#MaximumAllowedResources", + "traits": { + "smithy.api#documentation": "

The maximum capacity to allocate when the application is updated. This is cumulative\n across all workers at any given point in time during the lifespan of the application. No\n new resources will be created once any one of the defined limits is hit.

" + } + }, + "autoStartConfiguration": { + "target": "com.amazonaws.emrserverless#AutoStartConfig", + "traits": { + "smithy.api#documentation": "

The configuration for an application to automatically start on job submission.

" + } + }, + "autoStopConfiguration": { + "target": "com.amazonaws.emrserverless#AutoStopConfig", + "traits": { + "smithy.api#documentation": "

The configuration for an application to automatically stop after a certain amount of\n time being idle.

" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.emrserverless#NetworkConfiguration" + }, + "architecture": { + "target": "com.amazonaws.emrserverless#Architecture", + "traits": { + "smithy.api#documentation": "

The CPU architecture of an application.

" + } + }, + "imageConfiguration": { + "target": "com.amazonaws.emrserverless#ImageConfigurationInput", + "traits": { + "smithy.api#documentation": "

The image configuration to be used for all worker types. You can either set this parameter or imageConfiguration \n for each worker type in WorkerTypeSpecificationInput.

" + } + }, + "workerTypeSpecifications": { + "target": "com.amazonaws.emrserverless#WorkerTypeSpecificationInputMap", + "traits": { + "smithy.api#documentation": "

The key-value pairs that specify worker type to WorkerTypeSpecificationInput. This parameter must contain all valid \n worker types for a Spark or Hive application. Valid worker types include Driver and Executor for \n Spark applications and HiveDriver and TezTask for Hive applications. You can either set \n image details in this parameter for each worker type, or in imageConfiguration for all worker types.

" + } + } + } + }, + "com.amazonaws.emrserverless#UpdateApplicationResponse": { + "type": "structure", + "members": { + "application": { + "target": "com.amazonaws.emrserverless#Application", + "traits": { + "smithy.api#documentation": "

Information about the updated application.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emrserverless#UriString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10280 + }, + "smithy.api#pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\r\\n\\t]*" + } + }, + "com.amazonaws.emrserverless#Url": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.emrserverless#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.emrserverless#String1024", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The input fails to satisfy the constraints specified by an AWS service.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.emrserverless#WorkerCounts": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 1000000 + } + } + }, + "com.amazonaws.emrserverless#WorkerResourceConfig": { + "type": "structure", + "members": { + "cpu": { + "target": "com.amazonaws.emrserverless#CpuSize", + "traits": { + "smithy.api#documentation": "

The CPU requirements for every worker instance of the worker type.

", + "smithy.api#required": {} + } + }, + "memory": { + "target": "com.amazonaws.emrserverless#MemorySize", + "traits": { + "smithy.api#documentation": "

The memory requirements for every worker instance of the worker type.

", + "smithy.api#required": {} + } + }, + "disk": { + "target": "com.amazonaws.emrserverless#DiskSize", + "traits": { + "smithy.api#documentation": "

The disk requirements for every worker instance of the worker type.

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

The cumulative configuration requirements for every worker instance of the worker\n type.

" + } + }, + "com.amazonaws.emrserverless#WorkerTypeSpecification": { + "type": "structure", + "members": { + "imageConfiguration": { + "target": "com.amazonaws.emrserverless#ImageConfiguration", + "traits": { + "smithy.api#documentation": "

The image configuration for a worker type.

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

The specifications for a worker type.

" + } + }, + "com.amazonaws.emrserverless#WorkerTypeSpecificationInput": { + "type": "structure", + "members": { + "imageConfiguration": { + "target": "com.amazonaws.emrserverless#ImageConfigurationInput", + "traits": { + "smithy.api#documentation": "

The image configuration for a worker type.

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

The specifications for a worker type.

" + } + }, + "com.amazonaws.emrserverless#WorkerTypeSpecificationInputMap": { + "type": "map", + "key": { + "target": "com.amazonaws.emrserverless#WorkerTypeString" + }, + "value": { + "target": "com.amazonaws.emrserverless#WorkerTypeSpecificationInput" + } + }, + "com.amazonaws.emrserverless#WorkerTypeSpecificationMap": { + "type": "map", + "key": { + "target": "com.amazonaws.emrserverless#WorkerTypeString" + }, + "value": { + "target": "com.amazonaws.emrserverless#WorkerTypeSpecification" + } + }, + "com.amazonaws.emrserverless#WorkerTypeString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^[a-zA-Z]+[-_]*[a-zA-Z]+$" + } } - }, - "traits": { - "smithy.api#documentation": "

The cumulative configuration requirements for every worker instance of the worker\n type.

" - } - }, - "com.amazonaws.emrserverless#WorkerTypeString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - }, - "smithy.api#pattern": "^[a-zA-Z]+[-_]*[a-zA-Z]+$" - } } - } -} +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/lightsail.json b/codegen/sdk-codegen/aws-models/lightsail.json index f15718aafe90..30f7e2e112a9 100644 --- a/codegen/sdk-codegen/aws-models/lightsail.json +++ b/codegen/sdk-codegen/aws-models/lightsail.json @@ -1,21612 +1,21603 @@ { - "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.lightsail#AccessDeniedException": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#string" - }, - "docs": { - "target": "com.amazonaws.lightsail#string" - }, - "message": { - "target": "com.amazonaws.lightsail#string" - }, - "tip": { - "target": "com.amazonaws.lightsail#string" - } - }, - "traits": { - "smithy.api#documentation": "

Lightsail throws this exception when the user cannot be authenticated or uses invalid\n credentials to access a resource.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.lightsail#AccessDirection": { - "type": "enum", - "members": { - "inbound": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "inbound" - } - }, - "outbound": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "outbound" - } - } - } - }, - "com.amazonaws.lightsail#AccessKey": { - "type": "structure", - "members": { - "accessKeyId": { - "target": "com.amazonaws.lightsail#IAMAccessKeyId", - "traits": { - "smithy.api#documentation": "

The ID of the access key.

" - } - }, - "secretAccessKey": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The secret access key used to sign requests.

\n\n

You should store the secret access key in a safe location. We recommend that you delete\n the access key if the secret access key is compromised.

" - } - }, - "status": { - "target": "com.amazonaws.lightsail#StatusType", - "traits": { - "smithy.api#documentation": "

The status of the access key.

\n\n

A status of Active means that the key is valid, while Inactive\n means it is not.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the access key was created.

" - } - }, - "lastUsed": { - "target": "com.amazonaws.lightsail#AccessKeyLastUsed", - "traits": { - "smithy.api#documentation": "

An object that describes the last time the access key was used.

\n\n \n

This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the\n region and serviceName values are N/A, and the\n lastUsedDate value is null.

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

Describes an access key for an Amazon Lightsail bucket.

\n\n

Access keys grant full programmatic access to the specified bucket and its objects. You\n can have a maximum of two access keys per bucket. Use the CreateBucketAccessKey action to create an access key for a specific bucket. For\n more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

\n\n \n

The secretAccessKey value is returned only in response to the\n CreateBucketAccessKey action. You can get a secret access key only when you\n first create an access key; you cannot get the secret access key later. If you lose the\n secret access key, you must create a new access key.

\n " - } - }, - "com.amazonaws.lightsail#AccessKeyLastUsed": { - "type": "structure", - "members": { - "lastUsedDate": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The date and time when the access key was most recently used.

\n

This value is null if the access key has not been used.

" - } - }, - "region": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region where this access key was most recently used.

\n

This value is N/A if the access key has not been used.

" - } - }, - "serviceName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Web Services service with which this access key was most recently\n used.

\n

This value is N/A if the access key has not been used.

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

Describes the last time an access key was used.

\n\n \n

This object does not include data in the response of a CreateBucketAccessKey action.

\n " - } - }, - "com.amazonaws.lightsail#AccessKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#AccessKey" - } - }, - "com.amazonaws.lightsail#AccessReceiverList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#ResourceReceivingAccess" - } - }, - "com.amazonaws.lightsail#AccessRules": { - "type": "structure", - "members": { - "getObject": { - "target": "com.amazonaws.lightsail#AccessType", - "traits": { - "smithy.api#documentation": "

Specifies the anonymous access to all objects in a bucket.

\n\n

The following options can be specified:

\n\n " - } - }, - "allowPublicOverrides": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether the access control list (ACL) permissions that are\n applied to individual objects override the getObject option that is currently\n specified.

\n\n

When this is true, you can use the PutObjectAcl Amazon S3 API action to set\n individual objects to public (read-only) using the public-read ACL, or to private\n using the private ACL.

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

Describes the anonymous access permissions for an Amazon Lightsail bucket and its\n objects.

\n

For more information about bucket access permissions, see Understanding bucket permissions in Amazon Lightsail in the

\n

\n Amazon Lightsail Developer Guide.

" - } - }, - "com.amazonaws.lightsail#AccessType": { - "type": "enum", - "members": { - "Public": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "public" - } - }, - "Private": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "private" - } - } - } - }, - "com.amazonaws.lightsail#AccountLevelBpaSync": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.lightsail#AccountLevelBpaSyncStatus", - "traits": { - "smithy.api#documentation": "

The status of the account-level BPA synchronization.

\n\n

The following statuses are possible:

\n \n \n

You might need to complete further actions if the status is Failed or\n Defaulted. The message parameter provides more information for\n those statuses.

\n " - } - }, - "lastSyncedAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp of when the account-level BPA configuration was last synchronized. This\n value is null when the account-level BPA configuration has not been synchronized.

" - } - }, - "message": { - "target": "com.amazonaws.lightsail#BPAStatusMessage", - "traits": { - "smithy.api#documentation": "

A message that provides a reason for a Failed or Defaulted\n synchronization status.

\n\n

The following messages are possible:

\n " - } - }, - "bpaImpactsLightsail": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether account-level block public access is affecting your\n Lightsail buckets.

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

Describes the synchronization status of the Amazon Simple Storage Service (Amazon S3)\n account-level block public access (BPA) feature for your Lightsail buckets.

\n\n

The account-level BPA feature of Amazon S3 provides centralized controls to limit\n public access to all Amazon S3 buckets in an account. BPA can make all Amazon S3 buckets in an Amazon Web Services account private regardless of the individual bucket and\n object permissions that are configured. Lightsail buckets take into account the\n Amazon S3 account-level BPA configuration when allowing or denying public access. To\n do this, Lightsail periodically fetches the account-level BPA configuration\n from Amazon S3. When the account-level BPA status is InSync, the Amazon S3 account-level BPA configuration is synchronized and it applies to your Lightsail\n buckets. For more information about Amazon Simple Storage Service account-level BPA and how it affects\n Lightsail buckets, see Block public access for buckets in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

" - } - }, - "com.amazonaws.lightsail#AccountLevelBpaSyncStatus": { - "type": "enum", - "members": { - "InSync": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InSync" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "NeverSynced": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NeverSynced" - } - }, - "Defaulted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Defaulted" - } - } - } - }, - "com.amazonaws.lightsail#AccountSetupInProgressException": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#string" + "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.lightsail#AccessDeniedException": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#string" + }, + "docs": { + "target": "com.amazonaws.lightsail#string" + }, + "message": { + "target": "com.amazonaws.lightsail#string" + }, + "tip": { + "target": "com.amazonaws.lightsail#string" + } + }, + "traits": { + "smithy.api#documentation": "

Lightsail throws this exception when the user cannot be authenticated or uses invalid\n credentials to access a resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } }, - "docs": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#AccessDirection": { + "type": "enum", + "members": { + "inbound": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inbound" + } + }, + "outbound": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "outbound" + } + } + } }, - "message": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#AccessKey": { + "type": "structure", + "members": { + "accessKeyId": { + "target": "com.amazonaws.lightsail#IAMAccessKeyId", + "traits": { + "smithy.api#documentation": "

The ID of the access key.

" + } + }, + "secretAccessKey": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The secret access key used to sign requests.

\n

You should store the secret access key in a safe location. We recommend that you delete\n the access key if the secret access key is compromised.

" + } + }, + "status": { + "target": "com.amazonaws.lightsail#StatusType", + "traits": { + "smithy.api#documentation": "

The status of the access key.

\n

A status of Active means that the key is valid, while Inactive\n means it is not.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the access key was created.

" + } + }, + "lastUsed": { + "target": "com.amazonaws.lightsail#AccessKeyLastUsed", + "traits": { + "smithy.api#documentation": "

An object that describes the last time the access key was used.

\n \n

This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the\n region and serviceName values are N/A, and the\n lastUsedDate value is null.

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

Describes an access key for an Amazon Lightsail bucket.

\n

Access keys grant full programmatic access to the specified bucket and its objects. You\n can have a maximum of two access keys per bucket. Use the CreateBucketAccessKey action to create an access key for a specific bucket. For\n more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

\n \n

The secretAccessKey value is returned only in response to the\n CreateBucketAccessKey action. You can get a secret access key only when you\n first create an access key; you cannot get the secret access key later. If you lose the\n secret access key, you must create a new access key.

\n " + } }, - "tip": { - "target": "com.amazonaws.lightsail#string" - } - }, - "traits": { - "smithy.api#documentation": "

Lightsail throws this exception when an account is still in the setup in progress\n state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 428 - } - }, - "com.amazonaws.lightsail#AddOn": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the add-on.

" - } - }, - "status": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The status of the add-on.

" - } - }, - "snapshotTimeOfDay": { - "target": "com.amazonaws.lightsail#TimeOfDay", - "traits": { - "smithy.api#documentation": "

The daily time when an automatic snapshot is created.

\n

The time shown is in HH:00 format, and in Coordinated Universal Time\n (UTC).

\n

The snapshot is automatically created between the time shown and up to 45 minutes\n after.

" - } - }, - "nextSnapshotTimeOfDay": { - "target": "com.amazonaws.lightsail#TimeOfDay", - "traits": { - "smithy.api#documentation": "

The next daily time an automatic snapshot will be created.

\n

The time shown is in HH:00 format, and in Coordinated Universal Time\n (UTC).

\n

The snapshot is automatically created between the time shown and up to 45 minutes\n after.

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

Describes an add-on that is enabled for an Amazon Lightsail resource.

" - } - }, - "com.amazonaws.lightsail#AddOnList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#AddOn" - } - }, - "com.amazonaws.lightsail#AddOnRequest": { - "type": "structure", - "members": { - "addOnType": { - "target": "com.amazonaws.lightsail#AddOnType", - "traits": { - "smithy.api#documentation": "

The add-on type.

", - "smithy.api#required": {} - } - }, - "autoSnapshotAddOnRequest": { - "target": "com.amazonaws.lightsail#AutoSnapshotAddOnRequest", - "traits": { - "smithy.api#documentation": "

An object that represents additional parameters when enabling or modifying the automatic\n snapshot add-on.

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

Describes a request to enable, modify, or disable an add-on for an Amazon Lightsail\n resource.

\n \n

An additional cost may be associated with enabling add-ons. For more information, see\n the Lightsail pricing\n page.

\n " - } - }, - "com.amazonaws.lightsail#AddOnRequestList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#AddOnRequest" - } - }, - "com.amazonaws.lightsail#AddOnType": { - "type": "enum", - "members": { - "AutoSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AutoSnapshot" - } - } - } - }, - "com.amazonaws.lightsail#Alarm": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the alarm.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the alarm.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the alarm was created.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

An object that lists information about the location of the alarm.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type (e.g., Alarm).

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail alarm. This code enables our support team to look up your Lightsail\n information more easily.

" - } - }, - "monitoredResourceInfo": { - "target": "com.amazonaws.lightsail#MonitoredResourceInfo", - "traits": { - "smithy.api#documentation": "

An object that lists information about the resource monitored by the alarm.

" - } - }, - "comparisonOperator": { - "target": "com.amazonaws.lightsail#ComparisonOperator", - "traits": { - "smithy.api#documentation": "

The arithmetic operation used when comparing the specified statistic and threshold.

" - } - }, - "evaluationPeriods": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The number of periods over which data is compared to the specified threshold.

" - } - }, - "period": { - "target": "com.amazonaws.lightsail#MetricPeriod", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The period, in seconds, over which the statistic is applied.

" - } - }, - "threshold": { - "target": "com.amazonaws.lightsail#double", - "traits": { - "smithy.api#documentation": "

The value against which the specified statistic is compared.

" - } - }, - "datapointsToAlarm": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The number of data points that must not within the specified threshold to trigger the\n alarm.

" - } - }, - "treatMissingData": { - "target": "com.amazonaws.lightsail#TreatMissingData", - "traits": { - "smithy.api#documentation": "

Specifies how the alarm handles missing data points.

\n

An alarm can treat missing data in the following ways:

\n " - } - }, - "statistic": { - "target": "com.amazonaws.lightsail#MetricStatistic", - "traits": { - "smithy.api#documentation": "

The statistic for the metric associated with the alarm.

\n

The following statistics are available:

\n " - } - }, - "metricName": { - "target": "com.amazonaws.lightsail#MetricName", - "traits": { - "smithy.api#documentation": "

The name of the metric associated with the alarm.

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#AlarmState", - "traits": { - "smithy.api#documentation": "

The current state of the alarm.

\n

An alarm has the following possible states:

\n " - } - }, - "unit": { - "target": "com.amazonaws.lightsail#MetricUnit", - "traits": { - "smithy.api#documentation": "

The unit of the metric associated with the alarm.

" - } - }, - "contactProtocols": { - "target": "com.amazonaws.lightsail#ContactProtocolsList", - "traits": { - "smithy.api#documentation": "

The contact protocols for the alarm, such as Email, SMS (text\n messaging), or both.

" - } - }, - "notificationTriggers": { - "target": "com.amazonaws.lightsail#NotificationTriggerList", - "traits": { - "smithy.api#documentation": "

The alarm states that trigger a notification.

" - } - }, - "notificationEnabled": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the alarm is enabled.

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

Describes an alarm.

\n

An alarm is a way to monitor your Lightsail resource metrics. For more information, see\n Alarms in Amazon Lightsail.

" - } - }, - "com.amazonaws.lightsail#AlarmState": { - "type": "enum", - "members": { - "OK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OK" - } - }, - "ALARM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALARM" - } - }, - "INSUFFICIENT_DATA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INSUFFICIENT_DATA" - } - } - } - }, - "com.amazonaws.lightsail#AlarmsList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Alarm" - } - }, - "com.amazonaws.lightsail#AllocateStaticIp": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#AllocateStaticIpRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#AllocateStaticIpResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Allocates a static IP address.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/AllocateStaticIp", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#AllocateStaticIpRequest": { - "type": "structure", - "members": { - "staticIpName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the static IP address.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#AllocateStaticIpResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#AttachCertificateToDistribution": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#AttachCertificateToDistributionRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#AttachCertificateToDistributionResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

After the certificate is attached, your distribution accepts HTTPS traffic for all of the\n domains that are associated with the certificate.

\n

Use the CreateCertificate action to create a certificate that you can attach\n to your distribution.

\n \n

Only certificates created in the us-east-1\n Amazon Web Services Region can be attached to Lightsail distributions. Lightsail\n distributions are global resources that can reference an origin in any Amazon Web Services\n Region, and distribute its content globally. However, all distributions are located in the\n us-east-1 Region.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/AttachCertificateToDistribution", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#AttachCertificateToDistributionRequest": { - "type": "structure", - "members": { - "distributionName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the distribution that the certificate will be attached to.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

", - "smithy.api#required": {} - } - }, - "certificateName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the certificate to attach to a distribution.

\n

Only certificates with a status of ISSUED can be attached to a\n distribution.

\n

Use the GetCertificates action to get a list of certificate names that you\n can specify.

\n \n

This is the name of the certificate resource type and is used only to reference the\n certificate in other API actions. It can be different than the domain name of the\n certificate. For example, your certificate name might be\n WordPress-Blog-Certificate and the domain name of the certificate might be\n example.com.

\n ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#AttachCertificateToDistributionResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#AttachDisk": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#AttachDiskRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#AttachDiskResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Attaches a block storage disk to a running or stopped Lightsail instance and exposes it\n to the instance with the specified disk name.

\n

The attach disk operation supports tag-based access control via resource tags\n applied to the resource identified by disk name. For more information, see the\n Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/AttachDisk", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#AttachDiskRequest": { - "type": "structure", - "members": { - "diskName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The unique Lightsail disk name (e.g., my-disk).

", - "smithy.api#required": {} - } - }, - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the Lightsail instance where you want to utilize the storage disk.

", - "smithy.api#required": {} - } - }, - "diskPath": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The disk path to expose to the instance (e.g., /dev/xvdf).

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#AttachDiskResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#AttachInstancesToLoadBalancer": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#AttachInstancesToLoadBalancerRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#AttachInstancesToLoadBalancerResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Attaches one or more Lightsail instances to a load balancer.

\n

After some time, the instances are attached to the load balancer and the health check\n status is available.

\n

The attach instances to load balancer operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/AttachInstancesToLoadBalancer", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#AttachInstancesToLoadBalancerRequest": { - "type": "structure", - "members": { - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the load balancer.

", - "smithy.api#required": {} - } - }, - "instanceNames": { - "target": "com.amazonaws.lightsail#ResourceNameList", - "traits": { - "smithy.api#documentation": "

An array of strings representing the instance name(s) you want to attach to your load\n balancer.

\n

An instance must be running before you can attach it to your load\n balancer.

\n

There are no additional limits on the number of instances you can attach to your load\n balancer, aside from the limit of Lightsail instances you can create in your account\n (20).

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#AttachInstancesToLoadBalancerResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificate": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificateRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificateResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just\n an updated, more secure version of Secure Socket Layer (SSL).

\n

Once you create and validate your certificate, you can attach it to your load balancer.\n You can also use this API to rotate the certificates on your account. Use the\n AttachLoadBalancerTlsCertificate action with the non-attached certificate, and\n it will replace the existing one and become the attached certificate.

\n

The AttachLoadBalancerTlsCertificate operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/AttachLoadBalancerTlsCertificate", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificateRequest": { - "type": "structure", - "members": { - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the load balancer to which you want to associate the SSL/TLS\n certificate.

", - "smithy.api#required": {} - } - }, - "certificateName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your SSL/TLS certificate.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificateResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

\n

These SSL/TLS certificates are only usable by Lightsail load balancers. You can't get\n the certificate and use it for another purpose.

" - } - } - } - }, - "com.amazonaws.lightsail#AttachStaticIp": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#AttachStaticIpRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#AttachStaticIpResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Attaches a static IP address to a specific Amazon Lightsail instance.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/AttachStaticIp", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#AttachStaticIpRequest": { - "type": "structure", - "members": { - "staticIpName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the static IP.

", - "smithy.api#required": {} - } - }, - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The instance name to which you want to attach the static IP address.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#AttachStaticIpResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#AttachedDisk": { - "type": "structure", - "members": { - "path": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The path of the disk (e.g., /dev/xvdf).

" - } - }, - "sizeInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The size of the disk in GB.

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

Describes a block storage disk that is attached to an instance, and is included in an\n automatic snapshot.

" - } - }, - "com.amazonaws.lightsail#AttachedDiskList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#AttachedDisk" - } - }, - "com.amazonaws.lightsail#AttachedDiskMap": { - "type": "map", - "key": { - "target": "com.amazonaws.lightsail#ResourceName" - }, - "value": { - "target": "com.amazonaws.lightsail#DiskMapList" - } - }, - "com.amazonaws.lightsail#AutoSnapshotAddOnRequest": { - "type": "structure", - "members": { - "snapshotTimeOfDay": { - "target": "com.amazonaws.lightsail#TimeOfDay", - "traits": { - "smithy.api#documentation": "

The daily time when an automatic snapshot will be created.

\n

Constraints:

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

Describes a request to enable or modify the automatic snapshot add-on for an\n Amazon Lightsail instance or disk.

\n

When you modify the automatic snapshot time for a resource, it is typically effective\n immediately except under the following conditions:

\n " - } - }, - "com.amazonaws.lightsail#AutoSnapshotDate": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" - } - }, - "com.amazonaws.lightsail#AutoSnapshotDetails": { - "type": "structure", - "members": { - "date": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The date of the automatic snapshot in YYYY-MM-DD format.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the automatic snapshot was created.

" - } - }, - "status": { - "target": "com.amazonaws.lightsail#AutoSnapshotStatus", - "traits": { - "smithy.api#documentation": "

The status of the automatic snapshot.

" - } - }, - "fromAttachedDisks": { - "target": "com.amazonaws.lightsail#AttachedDiskList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the block storage disks attached to the instance when\n the automatic snapshot was created.

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

Describes an automatic snapshot.

" - } - }, - "com.amazonaws.lightsail#AutoSnapshotDetailsList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#AutoSnapshotDetails" - } - }, - "com.amazonaws.lightsail#AutoSnapshotStatus": { - "type": "enum", - "members": { - "SUCCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Success" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NotFound" - } - } - } - }, - "com.amazonaws.lightsail#AvailabilityZone": { - "type": "structure", - "members": { - "zoneName": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the Availability Zone. The format is us-east-2a\n (case-sensitive).

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The state of the Availability Zone.

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

Describes an Availability Zone.

" - } - }, - "com.amazonaws.lightsail#AvailabilityZoneList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#AvailabilityZone" - } - }, - "com.amazonaws.lightsail#BPAStatusMessage": { - "type": "enum", - "members": { - "DEFAULTED_FOR_SLR_MISSING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEFAULTED_FOR_SLR_MISSING" - } - }, - "SYNC_ON_HOLD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SYNC_ON_HOLD" - } - }, - "DEFAULTED_FOR_SLR_MISSING_ON_HOLD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEFAULTED_FOR_SLR_MISSING_ON_HOLD" - } - }, - "Unknown": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Unknown" - } - } - } - }, - "com.amazonaws.lightsail#Base64": { - "type": "string" - }, - "com.amazonaws.lightsail#BehaviorEnum": { - "type": "enum", - "members": { - "DontCacheSetting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "dont-cache" - } - }, - "CacheSetting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cache" - } - } - } - }, - "com.amazonaws.lightsail#Blueprint": { - "type": "structure", - "members": { - "blueprintId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID for the virtual private server image (e.g., app_wordpress_4_4 or\n app_lamp_7_0).

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The friendly name of the blueprint (e.g., Amazon Linux).

" - } - }, - "group": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The group name of the blueprint (e.g., amazon-linux).

" - } - }, - "type": { - "target": "com.amazonaws.lightsail#BlueprintType", - "traits": { - "smithy.api#documentation": "

The type of the blueprint (e.g., os or app).

" - } - }, - "description": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The description of the blueprint.

" - } - }, - "isActive": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the blueprint is active. Inactive blueprints are listed\n to support customers with existing instances but are not necessarily available for launch of\n new instances. Blueprints are marked inactive when they become outdated due to operating\n system updates or new application releases.

" - } - }, - "minPower": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The minimum bundle power required to run this blueprint. For example, you need a bundle\n with a power value of 500 or more to create an instance that uses a blueprint with a minimum\n power value of 500. 0 indicates that the blueprint runs on all instance sizes.\n

" - } - }, - "version": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The version number of the operating system, application, or stack (e.g.,\n 2016.03.0).

" - } - }, - "versionCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The version code.

" - } - }, - "productUrl": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The product URL to learn more about the image or blueprint.

" - } - }, - "licenseUrl": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The end-user license agreement URL for the image or blueprint.

" - } - }, - "platform": { - "target": "com.amazonaws.lightsail#InstancePlatform", - "traits": { - "smithy.api#documentation": "

The operating system platform (either Linux/Unix-based or Windows Server-based) of the\n blueprint.

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

Describes a blueprint (a virtual private server image).

" - } - }, - "com.amazonaws.lightsail#BlueprintList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Blueprint" - } - }, - "com.amazonaws.lightsail#BlueprintType": { - "type": "enum", - "members": { - "os": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "os" - } - }, - "app": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "app" - } - } - } - }, - "com.amazonaws.lightsail#Bucket": { - "type": "structure", - "members": { - "resourceType": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type of the bucket (for example, Bucket).

" - } - }, - "accessRules": { - "target": "com.amazonaws.lightsail#AccessRules", - "traits": { - "smithy.api#documentation": "

An object that describes the access rules of the bucket.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the bucket.

" - } - }, - "bundleId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the bundle currently applied to the bucket.

\n\n

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\n bucket.

\n\n

Use the UpdateBucketBundle action to change the\n bundle of a bucket.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the distribution was created.

" - } - }, - "url": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The URL of the bucket.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

An object that describes the location of the bucket, such as the Amazon Web Services Region\n and Availability Zone.

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket.

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The support code for a bucket. Include this code in your email to support when you have\n questions about a Lightsail bucket. This code enables our support team to look up your\n Lightsail information more easily.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the bucket. For more information, see Tags in\n Amazon Lightsail in the Amazon Lightsail Developer Guide.

" - } - }, - "objectVersioning": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Indicates whether object versioning is enabled for the bucket.

\n\n

The following options can be configured:

\n " - } - }, - "ableToUpdateBundle": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the bundle that is currently applied to a bucket can be changed to\n another bundle.

\n\n

You can update a bucket's bundle only one time within a monthly Amazon Web Services billing\n cycle.

\n\n

Use the UpdateBucketBundle action to change a\n bucket's bundle.

" - } - }, - "readonlyAccessAccounts": { - "target": "com.amazonaws.lightsail#PartnerIdList", - "traits": { - "smithy.api#documentation": "

An array of strings that specify the Amazon Web Services account IDs that have read-only\n access to the bucket.

" - } - }, - "resourcesReceivingAccess": { - "target": "com.amazonaws.lightsail#AccessReceiverList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe Lightsail instances that have access to the\n bucket.

\n\n

Use the SetResourceAccessForBucket\n action to update the instances that have access to a bucket.

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#BucketState", - "traits": { - "smithy.api#documentation": "

An object that describes the state of the bucket.

" - } - }, - "accessLogConfig": { - "target": "com.amazonaws.lightsail#BucketAccessLogConfig", - "traits": { - "smithy.api#documentation": "

An object that describes the access log configuration for the bucket.

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

Describes an Amazon Lightsail bucket.

" - } - }, - "com.amazonaws.lightsail#BucketAccessLogConfig": { - "type": "structure", - "members": { - "enabled": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether bucket access logging is enabled for the\n bucket.

", - "smithy.api#required": {} - } - }, - "destination": { - "target": "com.amazonaws.lightsail#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket where the access logs are saved. The destination can be a\n Lightsail bucket in the same account, and in the same Amazon Web Services Region as the\n source bucket.

\n \n

This parameter is required when enabling the access log for a bucket, and should be\n omitted when disabling the access log.

\n " - } - }, - "prefix": { - "target": "com.amazonaws.lightsail#BucketAccessLogPrefix", - "traits": { - "smithy.api#documentation": "

The optional object prefix for the bucket access log.

\n

The prefix is an optional addition to the object key that organizes your access log files\n in the destination bucket. For example, if you specify a logs/ prefix, then each\n log object will begin with the logs/ prefix in its key (for example,\n logs/2021-11-01-21-32-16-E568B2907131C0C0).

\n \n

This parameter can be optionally specified when enabling the access log for a bucket,\n and should be omitted when disabling the access log.

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

Describes the access log configuration for a bucket in the Amazon Lightsail object storage\n service.

\n

For more information about bucket access logs, see Logging bucket requests using access logging in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

" - } - }, - "com.amazonaws.lightsail#BucketAccessLogPrefix": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^[\\w/!.*')(-]+$" - } - }, - "com.amazonaws.lightsail#BucketBundle": { - "type": "structure", - "members": { - "bundleId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the bundle.

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the bundle.

" - } - }, - "price": { - "target": "com.amazonaws.lightsail#float", - "traits": { - "smithy.api#documentation": "

The monthly price of the bundle, in US dollars.

" - } - }, - "storagePerMonthInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The storage size of the bundle, in GB.

" - } - }, - "transferPerMonthInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The monthly network transfer quota of the bundle.

" - } - }, - "isActive": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the bundle is active. Use for a new or existing bucket.

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

Describes the specifications of a bundle that can be applied to an Amazon Lightsail\n bucket.

\n\n

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\n bucket.

" - } - }, - "com.amazonaws.lightsail#BucketBundleList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#BucketBundle" - } - }, - "com.amazonaws.lightsail#BucketList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Bucket" - } - }, - "com.amazonaws.lightsail#BucketMetricName": { - "type": "enum", - "members": { - "BucketSizeBytes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BucketSizeBytes" - } - }, - "NumberOfObjects": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NumberOfObjects" - } - } - } - }, - "com.amazonaws.lightsail#BucketName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 54 - }, - "smithy.api#pattern": "^[a-z0-9][a-z0-9-]{1,52}[a-z0-9]$" - } - }, - "com.amazonaws.lightsail#BucketState": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The state code of the bucket.

\n\n

The following codes are possible:

\n\n " - } - }, - "message": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

A message that describes the state of the bucket.

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

Describes the state of an Amazon Lightsail bucket.

" - } - }, - "com.amazonaws.lightsail#Bundle": { - "type": "structure", - "members": { - "price": { - "target": "com.amazonaws.lightsail#float", - "traits": { - "smithy.api#documentation": "

The price in US dollars (e.g., 5.0) of the bundle.

" - } - }, - "cpuCount": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The number of vCPUs included in the bundle (e.g., 2).

" - } - }, - "diskSizeInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The size of the SSD (e.g., 30).

" - } - }, - "bundleId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The bundle ID (e.g., micro_1_0).

" - } - }, - "instanceType": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The Amazon EC2 instance type (e.g., t2.micro).

" - } - }, - "isActive": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the bundle is active.

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

A friendly name for the bundle (e.g., Micro).

" - } - }, - "power": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

A numeric value that represents the power of the bundle (e.g., 500). You can\n use the bundle's power value in conjunction with a blueprint's minimum power value to\n determine whether the blueprint will run on the bundle. For example, you need a bundle with a\n power value of 500 or more to create an instance that uses a blueprint with a minimum power\n value of 500.

" - } - }, - "ramSizeInGb": { - "target": "com.amazonaws.lightsail#float", - "traits": { - "smithy.api#documentation": "

The amount of RAM in GB (e.g., 2.0).

" - } - }, - "transferPerMonthInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The data transfer rate per month in GB (e.g., 2000).

" - } - }, - "supportedPlatforms": { - "target": "com.amazonaws.lightsail#InstancePlatformList", - "traits": { - "smithy.api#documentation": "

The operating system platform (Linux/Unix-based or Windows Server-based) that the bundle\n supports. You can only launch a WINDOWS bundle on a blueprint that supports the\n WINDOWS platform. LINUX_UNIX blueprints require a\n LINUX_UNIX bundle.

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

Describes a bundle, which is a set of specs describing your virtual private server (or\n instance).

" - } - }, - "com.amazonaws.lightsail#BundleList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Bundle" - } - }, - "com.amazonaws.lightsail#CacheBehavior": { - "type": "structure", - "members": { - "behavior": { - "target": "com.amazonaws.lightsail#BehaviorEnum", - "traits": { - "smithy.api#documentation": "

The cache behavior of the distribution.

\n

The following cache behaviors can be specified:

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

Describes the default cache behavior of an Amazon Lightsail content delivery network (CDN)\n distribution.

" - } - }, - "com.amazonaws.lightsail#CacheBehaviorList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#CacheBehaviorPerPath" - } - }, - "com.amazonaws.lightsail#CacheBehaviorPerPath": { - "type": "structure", - "members": { - "path": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify\n wildcard directories (path/to/assets/*), and file types (*.html, *jpg,\n *js). Directories and file paths are case-sensitive.

\n

Examples:

\n " - } - }, - "behavior": { - "target": "com.amazonaws.lightsail#BehaviorEnum", - "traits": { - "smithy.api#documentation": "

The cache behavior for the specified path.

\n

You can specify one of the following per-path cache behaviors:

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

Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN)\n distribution.

\n

A per-path cache behavior is used to override, or add an exception to, the default cache\n behavior of a distribution. For example, if the cacheBehavior is set to\n cache, then a per-path cache behavior can be used to specify a directory, file,\n or file type that your distribution will cache. Alternately, if the distribution's\n cacheBehavior is dont-cache, then a per-path cache behavior can be\n used to specify a directory, file, or file type that your distribution will not cache.

" - } - }, - "com.amazonaws.lightsail#CacheSettings": { - "type": "structure", - "members": { - "defaultTTL": { - "target": "com.amazonaws.lightsail#long", - "traits": { - "smithy.api#documentation": "

The default amount of time that objects stay in the distribution's cache before the\n distribution forwards another request to the origin to determine whether the content has been\n updated.

\n \n

The value specified applies only when the origin does not add HTTP headers such as\n Cache-Control max-age, Cache-Control s-maxage, and\n Expires to objects.

\n " - } - }, - "minimumTTL": { - "target": "com.amazonaws.lightsail#long", - "traits": { - "smithy.api#documentation": "

The minimum amount of time that objects stay in the distribution's cache before the\n distribution forwards another request to the origin to determine whether the object has been\n updated.

\n

A value of 0 must be specified for minimumTTL if the\n distribution is configured to forward all headers to the origin.

" - } - }, - "maximumTTL": { - "target": "com.amazonaws.lightsail#long", - "traits": { - "smithy.api#documentation": "

The maximum amount of time that objects stay in the distribution's cache before the\n distribution forwards another request to the origin to determine whether the object has been\n updated.

\n

The value specified applies only when the origin adds HTTP headers such as\n Cache-Control max-age, Cache-Control s-maxage, and\n Expires to objects.

" - } - }, - "allowedHTTPMethods": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The HTTP methods that are processed and forwarded to the distribution's origin.

\n

You can specify the following options:

\n \n

If you specify the third option, you might need to restrict access to your distribution's\n origin so users can't perform operations that you don't want them to. For example, you might\n not want users to have permission to delete objects from your origin.

" - } - }, - "cachedHTTPMethods": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The HTTP method responses that are cached by your distribution.

\n

You can specify the following options:

\n " - } - }, - "forwardedCookies": { - "target": "com.amazonaws.lightsail#CookieObject", - "traits": { - "smithy.api#documentation": "

An object that describes the cookies that are forwarded to the origin. Your content is\n cached based on the cookies that are forwarded.

" - } - }, - "forwardedHeaders": { - "target": "com.amazonaws.lightsail#HeaderObject", - "traits": { - "smithy.api#documentation": "

An object that describes the headers that are forwarded to the origin. Your content is\n cached based on the headers that are forwarded.

" - } - }, - "forwardedQueryStrings": { - "target": "com.amazonaws.lightsail#QueryStringObject", - "traits": { - "smithy.api#documentation": "

An object that describes the query strings that are forwarded to the origin. Your content\n is cached based on the query strings that are forwarded.

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

Describes the cache settings of an Amazon Lightsail content delivery network (CDN)\n distribution.

\n

These settings apply only to your distribution's cacheBehaviors (including\n the defaultCacheBehavior) that have a behavior of\n cache.

" - } - }, - "com.amazonaws.lightsail#Certificate": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate.

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#CertificateName", - "traits": { - "smithy.api#documentation": "

The name of the certificate (e.g., my-certificate).

" - } - }, - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The domain name of the certificate.

" - } - }, - "status": { - "target": "com.amazonaws.lightsail#CertificateStatus", - "traits": { - "smithy.api#documentation": "

The validation status of the certificate.

" - } - }, - "serialNumber": { - "target": "com.amazonaws.lightsail#SerialNumber", - "traits": { - "smithy.api#documentation": "

The serial number of the certificate.

" - } - }, - "subjectAlternativeNames": { - "target": "com.amazonaws.lightsail#SubjectAlternativeNameList", - "traits": { - "smithy.api#documentation": "

An array of strings that specify the alternate domains (e.g., example2.com)\n and subdomains (e.g., blog.example.com) of the certificate.

" - } - }, - "domainValidationRecords": { - "target": "com.amazonaws.lightsail#DomainValidationRecordList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the domain validation records of the certificate.

" - } - }, - "requestFailureReason": { - "target": "com.amazonaws.lightsail#RequestFailureReason", - "traits": { - "smithy.api#documentation": "

The validation failure reason, if any, of the certificate.

\n

The following failure reasons are possible:

\n " - } - }, - "inUseResourceCount": { - "target": "com.amazonaws.lightsail#InUseResourceCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of Lightsail resources that the certificate is attached to.

" - } - }, - "keyAlgorithm": { - "target": "com.amazonaws.lightsail#KeyAlgorithm", - "traits": { - "smithy.api#documentation": "

The algorithm used to generate the key pair (the public and private key) of the\n certificate.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the certificate was created.

" - } - }, - "issuedAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the certificate was issued.

" - } - }, - "issuerCA": { - "target": "com.amazonaws.lightsail#IssuerCA", - "traits": { - "smithy.api#documentation": "

The certificate authority that issued the certificate.

" - } - }, - "notBefore": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the certificate is first valid.

" - } - }, - "notAfter": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the certificate expires.

" - } - }, - "eligibleToRenew": { - "target": "com.amazonaws.lightsail#EligibleToRenew", - "traits": { - "smithy.api#documentation": "

The renewal eligibility of the certificate.

" - } - }, - "renewalSummary": { - "target": "com.amazonaws.lightsail#RenewalSummary", - "traits": { - "smithy.api#documentation": "

An object that describes the status of the certificate renewal managed by\n Lightsail.

" - } - }, - "revokedAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the certificate was revoked. This value is present only when the\n certificate status is REVOKED.

" - } - }, - "revocationReason": { - "target": "com.amazonaws.lightsail#RevocationReason", - "traits": { - "smithy.api#documentation": "

The reason the certificate was revoked. This value is present only when the certificate\n status is REVOKED.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail certificate. This code enables our support team to look up your Lightsail\n information more easily.

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

Describes the full details of an Amazon Lightsail SSL/TLS certificate.

\n \n

To get a summary of a certificate, use the GetCertificates action and ommit\n includeCertificateDetails from your request. The response will include only\n the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.

\n " - } - }, - "com.amazonaws.lightsail#CertificateDomainValidationStatus": { - "type": "enum", - "members": { - "PendingValidation": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_VALIDATION" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "Success": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESS" - } - } - } - }, - "com.amazonaws.lightsail#CertificateName": { - "type": "string" - }, - "com.amazonaws.lightsail#CertificateStatus": { - "type": "enum", - "members": { - "PendingValidation": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_VALIDATION" - } - }, - "Issued": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ISSUED" - } - }, - "Inactive": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INACTIVE" - } - }, - "Expired": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXPIRED" - } - }, - "ValidationTimedOut": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VALIDATION_TIMED_OUT" - } - }, - "Revoked": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REVOKED" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.lightsail#CertificateStatusList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#CertificateStatus" - } - }, - "com.amazonaws.lightsail#CertificateSummary": { - "type": "structure", - "members": { - "certificateArn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate.

" - } - }, - "certificateName": { - "target": "com.amazonaws.lightsail#CertificateName", - "traits": { - "smithy.api#documentation": "

The name of the certificate.

" - } - }, - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The domain name of the certificate.

" - } - }, - "certificateDetail": { - "target": "com.amazonaws.lightsail#Certificate", - "traits": { - "smithy.api#documentation": "

An object that describes a certificate in detail.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

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

Describes an Amazon Lightsail SSL/TLS certificate.

" - } - }, - "com.amazonaws.lightsail#CertificateSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#CertificateSummary" - } - }, - "com.amazonaws.lightsail#CloseInstancePublicPorts": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CloseInstancePublicPortsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CloseInstancePublicPortsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Closes ports for a specific Amazon Lightsail instance.

\n

The CloseInstancePublicPorts action supports tag-based access control via\n resource tags applied to the resource identified by instanceName. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CloseInstancePublicPorts", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CloseInstancePublicPortsRequest": { - "type": "structure", - "members": { - "portInfo": { - "target": "com.amazonaws.lightsail#PortInfo", - "traits": { - "smithy.api#documentation": "

An object to describe the ports to close for the specified instance.

", - "smithy.api#required": {} - } - }, - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance for which to close ports.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#CloseInstancePublicPortsResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CloudFormationStackRecord": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the CloudFormation stack record. It starts with\n CloudFormationStackRecord followed by a GUID.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudFormation stack record.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The date when the CloudFormation stack record was created.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

A list of objects describing the Availability Zone and Amazon Web Services Region of the\n CloudFormation stack record.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type (e.g., CloudFormationStackRecord).

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#RecordState", - "traits": { - "smithy.api#documentation": "

The current state of the CloudFormation stack record.

" - } - }, - "sourceInfo": { - "target": "com.amazonaws.lightsail#CloudFormationStackRecordSourceInfoList", - "traits": { - "smithy.api#documentation": "

A list of objects describing the source of the CloudFormation stack record.

" - } - }, - "destinationInfo": { - "target": "com.amazonaws.lightsail#DestinationInfo", - "traits": { - "smithy.api#documentation": "

A list of objects describing the destination service, which is AWS CloudFormation, and the Amazon\n Resource Name (ARN) of the AWS CloudFormation stack.

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

Describes a CloudFormation stack record created as a result of the create cloud\n formation stack action.

\n

A CloudFormation stack record provides information about the AWS CloudFormation stack used to\n create a new Amazon Elastic Compute Cloud instance from an exported Lightsail instance snapshot.

" - } - }, - "com.amazonaws.lightsail#CloudFormationStackRecordList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#CloudFormationStackRecord" - } - }, - "com.amazonaws.lightsail#CloudFormationStackRecordSourceInfo": { - "type": "structure", - "members": { - "resourceType": { - "target": "com.amazonaws.lightsail#CloudFormationStackRecordSourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type (e.g., ExportSnapshotRecord).

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the record.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the export snapshot record.

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

Describes the source of a CloudFormation stack record (i.e., the export snapshot\n record).

" - } - }, - "com.amazonaws.lightsail#CloudFormationStackRecordSourceInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#CloudFormationStackRecordSourceInfo" - } - }, - "com.amazonaws.lightsail#CloudFormationStackRecordSourceType": { - "type": "enum", - "members": { - "ExportSnapshotRecord": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ExportSnapshotRecord" - } - } - } - }, - "com.amazonaws.lightsail#ComparisonOperator": { - "type": "enum", - "members": { - "GreaterThanOrEqualToThreshold": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GreaterThanOrEqualToThreshold" - } - }, - "GreaterThanThreshold": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GreaterThanThreshold" - } - }, - "LessThanThreshold": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LessThanThreshold" - } - }, - "LessThanOrEqualToThreshold": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LessThanOrEqualToThreshold" - } - } - } - }, - "com.amazonaws.lightsail#ContactMethod": { - "type": "structure", - "members": { - "contactEndpoint": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The destination of the contact method, such as an email address or a mobile phone\n number.

" - } - }, - "status": { - "target": "com.amazonaws.lightsail#ContactMethodStatus", - "traits": { - "smithy.api#documentation": "

The current status of the contact method.

\n

A contact method has the following possible status:

\n " - } - }, - "protocol": { - "target": "com.amazonaws.lightsail#ContactProtocol", - "traits": { - "smithy.api#documentation": "

The protocol of the contact method, such as email or SMS (text messaging).

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the contact method.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the contact method.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the contact method was created.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

An object that describes the location of the contact method, such as the Amazon Web Services Region and Availability Zone.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type (e.g., ContactMethod).

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail contact method. This code enables our support team to look up your\n Lightsail information more easily.

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

Describes a contact method.

\n

A contact method is a way to send you notifications. For more information, see Notifications in Amazon Lightsail.

" - } - }, - "com.amazonaws.lightsail#ContactMethodStatus": { - "type": "enum", - "members": { - "PendingVerification": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PendingVerification" - } - }, - "Valid": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Valid" - } - }, - "Invalid": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Invalid" - } - } - } - }, - "com.amazonaws.lightsail#ContactMethodVerificationProtocol": { - "type": "enum", - "members": { - "Email": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Email" - } - } - } - }, - "com.amazonaws.lightsail#ContactMethodsList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#ContactMethod" - } - }, - "com.amazonaws.lightsail#ContactProtocol": { - "type": "enum", - "members": { - "Email": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Email" - } - }, - "SMS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SMS" - } - } - } - }, - "com.amazonaws.lightsail#ContactProtocolsList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#ContactProtocol" - } - }, - "com.amazonaws.lightsail#Container": { - "type": "structure", - "members": { - "image": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the image used for the container.

\n\n

Container images sourced from your Lightsail container service, that are registered and\n stored on your service, start with a colon (:). For example, if your container\n service name is container-service-1, the container image label is\n mystaticsite, and you want to use the third (3) version of the\n registered container image, then you should specify\n :container-service-1.mystaticsite.3. To use the latest version of a container\n image, specify latest instead of a version number (for example,\n :container-service-1.mystaticsite.latest). Lightsail will automatically use\n the highest numbered version of the registered container image.

\n\n

Container images sourced from a public registry like Docker Hub don't start with a colon.\n For example, nginx:latest or nginx.

" - } - }, - "command": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The launch command for the container.

" - } - }, - "environment": { - "target": "com.amazonaws.lightsail#Environment", - "traits": { - "smithy.api#documentation": "

The environment variables of the container.

" - } - }, - "ports": { - "target": "com.amazonaws.lightsail#PortMap", - "traits": { - "smithy.api#documentation": "

The open firewall ports of the container.

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

Describes the settings of a container that will be launched, or that is launched, to an\n Amazon Lightsail container service.

" - } - }, - "com.amazonaws.lightsail#ContainerImage": { - "type": "structure", - "members": { - "image": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the container image.

" - } - }, - "digest": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The digest of the container image.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the container image was created.

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

Describes a container image that is registered to an Amazon Lightsail container\n service.

" - } - }, - "com.amazonaws.lightsail#ContainerImageList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#ContainerImage" - } - }, - "com.amazonaws.lightsail#ContainerLabel": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 53 - }, - "smithy.api#pattern": "^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$" - } - }, - "com.amazonaws.lightsail#ContainerMap": { - "type": "map", - "key": { - "target": "com.amazonaws.lightsail#ContainerName" - }, - "value": { - "target": "com.amazonaws.lightsail#Container" - } - }, - "com.amazonaws.lightsail#ContainerName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 53 - }, - "smithy.api#pattern": "^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$" - } - }, - "com.amazonaws.lightsail#ContainerService": { - "type": "structure", - "members": { - "containerServiceName": { - "target": "com.amazonaws.lightsail#ContainerServiceName", - "traits": { - "smithy.api#documentation": "

The name of the container service.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container service.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the container service was created.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

An object that describes the location of the container service, such as the Amazon Web Services Region and Availability Zone.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type of the container service (i.e.,\n ContainerService).

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "power": { - "target": "com.amazonaws.lightsail#ContainerServicePowerName", - "traits": { - "smithy.api#documentation": "

The power specification of the container service.

\n\n

The power specifies the amount of RAM, the number of vCPUs, and the base price of the\n container service.

" - } - }, - "powerId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The ID of the power of the container service.

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#ContainerServiceState", - "traits": { - "smithy.api#documentation": "

The current state of the container service.

\n

The following container service states are possible:

\n " - } - }, - "stateDetail": { - "target": "com.amazonaws.lightsail#ContainerServiceStateDetail", - "traits": { - "smithy.api#documentation": "

An object that describes the current state of the container service.

\n \n

The state detail is populated only when a container service is in a\n PENDING, DEPLOYING, or UPDATING state.

\n " - } - }, - "scale": { - "target": "com.amazonaws.lightsail#ContainerServiceScale", - "traits": { - "smithy.api#documentation": "

The scale specification of the container service.

\n\n

The scale specifies the allocated compute nodes of the container service.

" - } - }, - "currentDeployment": { - "target": "com.amazonaws.lightsail#ContainerServiceDeployment", - "traits": { - "smithy.api#documentation": "

An object that describes the current container deployment of the container service.

" - } - }, - "nextDeployment": { - "target": "com.amazonaws.lightsail#ContainerServiceDeployment", - "traits": { - "smithy.api#documentation": "

An object that describes the next deployment of the container service.

\n\n

This value is null when there is no deployment in a pending\n state.

" - } - }, - "isDisabled": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the container service is disabled.

" - } - }, - "principalArn": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The principal ARN of the container service.

\n\n

The principal ARN can be used to create a trust relationship between your standard Amazon Web Services account and your Lightsail container service. This allows you to give your\n service permission to access resources in your standard Amazon Web Services account.

" - } - }, - "privateDomainName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The private domain name of the container service.

\n\n

The private domain name is accessible only by other resources within the default virtual\n private cloud (VPC) of your Lightsail account.

" - } - }, - "publicDomainNames": { - "target": "com.amazonaws.lightsail#ContainerServicePublicDomains", - "traits": { - "smithy.api#documentation": "

The public domain name of the container service, such as example.com and\n www.example.com.

\n\n

You can specify up to four public domain names for a container service. The domain names\n that you specify are used when you create a deployment with a container configured as the\n public endpoint of your container service.

\n\n

If you don't specify public domain names, then you can use the default domain of the\n container service.

\n\n \n

You must create and validate an SSL/TLS certificate before you can use public domain\n names with your container service. Use the CreateCertificate action to create a\n certificate for the public domain names you want to use with your container service.

\n \n\n

See CreateContainerService or UpdateContainerService for\n information about how to specify public domain names for your Lightsail container\n service.

" - } - }, - "url": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The publicly accessible URL of the container service.

\n\n

If no public endpoint is specified in the currentDeployment, this URL returns\n a 404 response.

" - } - }, - "privateRegistryAccess": { - "target": "com.amazonaws.lightsail#PrivateRegistryAccess", - "traits": { - "smithy.api#documentation": "

An object that describes the configuration for the container service to access private\n container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private\n repositories.

\n\n

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

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

Describes an Amazon Lightsail container service.

" - } - }, - "com.amazonaws.lightsail#ContainerServiceDeployment": { - "type": "structure", - "members": { - "version": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The version number of the deployment.

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#ContainerServiceDeploymentState", - "traits": { - "smithy.api#documentation": "

The state of the deployment.

\n\n

A deployment can be in one of the following states:

\n " - } - }, - "containers": { - "target": "com.amazonaws.lightsail#ContainerMap", - "traits": { - "smithy.api#documentation": "

An object that describes the configuration for the containers of the deployment.

" - } - }, - "publicEndpoint": { - "target": "com.amazonaws.lightsail#ContainerServiceEndpoint", - "traits": { - "smithy.api#documentation": "

An object that describes the endpoint of the deployment.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the deployment was created.

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

Describes a container deployment configuration of an Amazon Lightsail container\n service.

\n\n

A deployment specifies the settings, such as the ports and launch command, of containers\n that are deployed to your container service.

" - } - }, - "com.amazonaws.lightsail#ContainerServiceDeploymentList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#ContainerServiceDeployment" - } - }, - "com.amazonaws.lightsail#ContainerServiceDeploymentRequest": { - "type": "structure", - "members": { - "containers": { - "target": "com.amazonaws.lightsail#ContainerMap", - "traits": { - "smithy.api#documentation": "

An object that describes the configuration for the containers of the deployment.

" - } - }, - "publicEndpoint": { - "target": "com.amazonaws.lightsail#EndpointRequest", - "traits": { - "smithy.api#documentation": "

An object that describes the endpoint of the deployment.

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

Describes a container deployment configuration of an Amazon Lightsail container\n service.

\n\n

A deployment specifies the settings, such as the ports and launch command, of containers\n that are deployed to your container service.

" - } - }, - "com.amazonaws.lightsail#ContainerServiceDeploymentState": { - "type": "enum", - "members": { - "ACTIVATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVATING" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "INACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INACTIVE" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.lightsail#ContainerServiceECRImagePullerRole": { - "type": "structure", - "members": { - "isActive": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether the role is activated.

" - } - }, - "principalArn": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role, if it is activated.

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

Describes the activation status of the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR)\n private repositories.

\n\n

When activated, Lightsail creates an Identity and Access Management (IAM) role\n for the specified Lightsail container service. You can use the ARN of the role to create a\n trust relationship between your Lightsail container service and an Amazon ECR private repository in your Amazon Web Services account. This allows your container\n service to pull images from Amazon ECR private repositories. For more information, see\n Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" - } - }, - "com.amazonaws.lightsail#ContainerServiceECRImagePullerRoleRequest": { - "type": "structure", - "members": { - "isActive": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether to activate the role.

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

Describes a request to activate or deactivate the role that you can use to grant an\n Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.

\n\n

When activated, Lightsail creates an Identity and Access Management (IAM) role\n for the specified Lightsail container service. You can use the ARN of the role to create a\n trust relationship between your Lightsail container service and an Amazon ECR private repository in your Amazon Web Services account. This allows your container\n service to pull images from Amazon ECR private repositories. For more information, see\n Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" - } - }, - "com.amazonaws.lightsail#ContainerServiceEndpoint": { - "type": "structure", - "members": { - "containerName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the container entry of the deployment that the endpoint configuration applies\n to.

" - } - }, - "containerPort": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The port of the specified container to which traffic is forwarded to.

" - } - }, - "healthCheck": { - "target": "com.amazonaws.lightsail#ContainerServiceHealthCheckConfig", - "traits": { - "smithy.api#documentation": "

An object that describes the health check configuration of the container.

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

Describes the public endpoint configuration of a deployment of an Amazon Lightsail\n container service.

" - } - }, - "com.amazonaws.lightsail#ContainerServiceHealthCheckConfig": { - "type": "structure", - "members": { - "healthyThreshold": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The number of consecutive health checks successes required before moving the container to\n the Healthy state. The default value is 2.

" - } - }, - "unhealthyThreshold": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The number of consecutive health check failures required before moving the container to\n the Unhealthy state. The default value is 2.

" - } - }, - "timeoutSeconds": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, during which no response means a failed health check. You\n can specify between 2 and 60 seconds. The default value is 2.

" - } - }, - "intervalSeconds": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The approximate interval, in seconds, between health checks of an individual container.\n You can specify between 5 and 300 seconds. The default value is 5.

" - } - }, - "path": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The path on the container on which to perform the health check. The default value is\n /.

" - } - }, - "successCodes": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The HTTP codes to use when checking for a successful response from a container. You can\n specify values between 200 and 499. You can specify multiple values\n (for example, 200,202) or a range of values (for example,\n 200-299).

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

Describes the health check configuration of an Amazon Lightsail container service.

" - } - }, - "com.amazonaws.lightsail#ContainerServiceList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#ContainerService" - } - }, - "com.amazonaws.lightsail#ContainerServiceLogEvent": { - "type": "structure", - "members": { - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the container service log event was created.

" - } - }, - "message": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The message of the container service log event.

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

Describes the log events of a container of an Amazon Lightsail container service.

" - } - }, - "com.amazonaws.lightsail#ContainerServiceLogEventList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#ContainerServiceLogEvent" - } - }, - "com.amazonaws.lightsail#ContainerServiceMetadataEntry": { - "type": "map", - "key": { - "target": "com.amazonaws.lightsail#string" - }, - "value": { - "target": "com.amazonaws.lightsail#string" - } - }, - "com.amazonaws.lightsail#ContainerServiceMetadataEntryList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#ContainerServiceMetadataEntry" - } - }, - "com.amazonaws.lightsail#ContainerServiceMetricName": { - "type": "enum", - "members": { - "CPUUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CPUUtilization" - } - }, - "MemoryUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MemoryUtilization" - } - } - } - }, - "com.amazonaws.lightsail#ContainerServiceName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$" - } - }, - "com.amazonaws.lightsail#ContainerServicePower": { - "type": "structure", - "members": { - "powerId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The ID of the power (e.g., nano-1).

" - } - }, - "price": { - "target": "com.amazonaws.lightsail#float", - "traits": { - "smithy.api#documentation": "

The monthly price of the power in USD.

" - } - }, - "cpuCount": { - "target": "com.amazonaws.lightsail#float", - "traits": { - "smithy.api#documentation": "

The number of vCPUs included in the power.

" - } - }, - "ramSizeInGb": { - "target": "com.amazonaws.lightsail#float", - "traits": { - "smithy.api#documentation": "

The amount of RAM (in GB) of the power.

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The friendly name of the power (e.g., nano).

" - } - }, - "isActive": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the power is active and can be specified for container\n services.

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

Describes the powers that can be specified for an Amazon Lightsail container\n service.

\n\n

The power specifies the amount of RAM, the number of vCPUs, and the base price of the\n container service.

" - } - }, - "com.amazonaws.lightsail#ContainerServicePowerList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#ContainerServicePower" - } - }, - "com.amazonaws.lightsail#ContainerServicePowerName": { - "type": "enum", - "members": { - "nano": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "nano" - } - }, - "micro": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "micro" - } - }, - "small": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "small" - } - }, - "medium": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "medium" - } - }, - "large": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "large" - } - }, - "xlarge": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "xlarge" - } - } - } - }, - "com.amazonaws.lightsail#ContainerServiceProtocol": { - "type": "enum", - "members": { - "HTTP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTP" - } - }, - "HTTPS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPS" - } - }, - "TCP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TCP" - } - }, - "UDP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UDP" - } - } - } - }, - "com.amazonaws.lightsail#ContainerServicePublicDomains": { - "type": "map", - "key": { - "target": "com.amazonaws.lightsail#string" - }, - "value": { - "target": "com.amazonaws.lightsail#ContainerServicePublicDomainsList" - } - }, - "com.amazonaws.lightsail#ContainerServicePublicDomainsList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#string" - } - }, - "com.amazonaws.lightsail#ContainerServiceRegistryLogin": { - "type": "structure", - "members": { - "username": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The container service registry username to use to push container images to the container\n image registry of a Lightsail account.

" - } - }, - "password": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The container service registry password to use to push container images to the container\n image registry of a Lightsail account

" - } - }, - "expiresAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp of when the container image registry username and password expire.

\n\n

The log in credentials expire 12 hours after they are created, at which point you will\n need to create a new set of log in credentials using the\n CreateContainerServiceRegistryLogin action.

" - } - }, - "registry": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The address to use to push container images to the container image registry of a\n Lightsail account.

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

Describes the login information for the container image registry of an Amazon Lightsail\n account.

" - } - }, - "com.amazonaws.lightsail#ContainerServiceScale": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.lightsail#ContainerServiceState": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "READY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READY" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - }, - "DEPLOYING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEPLOYING" - } - } - } - }, - "com.amazonaws.lightsail#ContainerServiceStateDetail": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#ContainerServiceStateDetailCode", - "traits": { - "smithy.api#documentation": "

The state code of the container service.

\n

The following state codes are possible:

\n " - } - }, - "message": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

A message that provides more information for the state code.

\n \n

The state detail is populated only when a container service is in a\n PENDING, DEPLOYING, or UPDATING state.

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

Describes the current state of a container service.

" - } - }, - "com.amazonaws.lightsail#ContainerServiceStateDetailCode": { - "type": "enum", - "members": { - "CREATING_SYSTEM_RESOURCES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING_SYSTEM_RESOURCES" - } - }, - "CREATING_NETWORK_INFRASTRUCTURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING_NETWORK_INFRASTRUCTURE" - } - }, - "PROVISIONING_CERTIFICATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROVISIONING_CERTIFICATE" - } - }, - "PROVISIONING_SERVICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROVISIONING_SERVICE" - } - }, - "CREATING_DEPLOYMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING_DEPLOYMENT" - } - }, - "EVALUATING_HEALTH_CHECK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EVALUATING_HEALTH_CHECK" - } - }, - "ACTIVATING_DEPLOYMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVATING_DEPLOYMENT" - } - }, - "CERTIFICATE_LIMIT_EXCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CERTIFICATE_LIMIT_EXCEEDED" - } - }, - "UNKNOWN_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNKNOWN_ERROR" - } - } - } - }, - "com.amazonaws.lightsail#ContainerServicesListResult": { - "type": "structure", - "members": { - "containerServices": { - "target": "com.amazonaws.lightsail#ContainerServiceList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe one or more container services.

" - } - } - } - }, - "com.amazonaws.lightsail#CookieObject": { - "type": "structure", - "members": { - "option": { - "target": "com.amazonaws.lightsail#ForwardValues", - "traits": { - "smithy.api#documentation": "

Specifies which cookies to forward to the distribution's origin for a cache behavior:\n all, none, or allow-list to forward only the cookies\n specified in the cookiesAllowList parameter.

" - } - }, - "cookiesAllowList": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The specific cookies to forward to your distribution's origin.

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

Describes whether an Amazon Lightsail content delivery network (CDN) distribution forwards\n cookies to the origin and, if so, which ones.

\n

For the cookies that you specify, your distribution caches separate versions of the\n specified content based on the cookie values in viewer\n requests.

" - } - }, - "com.amazonaws.lightsail#CopySnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CopySnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CopySnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an\n automatic snapshot of an instance or disk as a manual snapshot. This operation can also be\n used to copy a manual or automatic snapshot of an instance or a disk from one Amazon Web Services Region to another in Amazon Lightsail.

\n

When copying a manual snapshot, be sure to define the source\n region, source snapshot name, and target snapshot name\n parameters.

\n

When copying an automatic snapshot, be sure to define the\n source region, source resource name, target snapshot\n name, and either the restore date or the use latest restorable\n auto snapshot parameters.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CopySnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CopySnapshotRequest": { - "type": "structure", - "members": { - "sourceSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the source manual snapshot to copy.

\n

Constraint:

\n " - } - }, - "sourceResourceName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the source instance or disk from which the source automatic snapshot was\n created.

\n

Constraint:

\n " - } - }, - "restoreDate": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The date of the source automatic snapshot to copy. Use the get auto snapshots\n operation to identify the dates of the available automatic snapshots.

\n

Constraints:

\n " - } - }, - "useLatestRestorableAutoSnapshot": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value to indicate whether to use the latest available automatic snapshot of the\n specified source instance or disk.

\n

Constraints:

\n " - } - }, - "targetSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the new manual snapshot to be created as a copy.

", - "smithy.api#required": {} - } - }, - "sourceRegion": { - "target": "com.amazonaws.lightsail#RegionName", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region where the source manual or automatic snapshot is\n located.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#CopySnapshotResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateBucket": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateBucketRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateBucketResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an Amazon Lightsail bucket.

\n\n

A bucket is a cloud storage resource available in the Lightsail object storage service.\n Use buckets to store objects such as data and its descriptive metadata. For more information\n about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer\n Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateBucket", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateBucketAccessKey": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateBucketAccessKeyRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateBucketAccessKeyResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of\n an access key ID and corresponding secret access key.

\n\n

Access keys grant full programmatic access to the specified bucket and its objects. You\n can have a maximum of two access keys per bucket. Use the GetBucketAccessKeys action to get a list of current access keys for a specific bucket. For more\n information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

\n\n \n

The secretAccessKey value is returned only in response to the\n CreateBucketAccessKey action. You can get a secret access key only when you\n first create an access key; you cannot get the secret access key later. If you lose the\n secret access key, you must create a new access key.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateBucketAccessKey", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateBucketAccessKeyRequest": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.lightsail#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket that the new access key will belong to, and grant access to.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#CreateBucketAccessKeyResult": { - "type": "structure", - "members": { - "accessKey": { - "target": "com.amazonaws.lightsail#AccessKey", - "traits": { - "smithy.api#documentation": "

An object that describes the access key that is created.

" - } - }, - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateBucketRequest": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.lightsail#BucketName", - "traits": { - "smithy.api#documentation": "

The name for the bucket.

\n\n

For more information about bucket names, see Bucket naming rules in Amazon Lightsail in the Amazon Lightsail Developer\n Guide.

", - "smithy.api#required": {} - } - }, - "bundleId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the bundle to use for the bucket.

\n\n

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\n bucket.

\n\n

Use the GetBucketBundles action to get a list of\n bundle IDs that you can specify.

\n\n

Use the UpdateBucketBundle action to change the\n bundle after the bucket is created.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the bucket during creation.

\n\n

Use the TagResource action to tag the bucket after it's\n created.

" - } - }, - "enableObjectVersioning": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether to enable versioning of objects in the\n bucket.

\n\n

For more information about versioning, see Enabling and suspending object versioning in a bucket in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateBucketResult": { - "type": "structure", - "members": { - "bucket": { - "target": "com.amazonaws.lightsail#Bucket", - "traits": { - "smithy.api#documentation": "

An object that describes the bucket that is created.

" - } - }, - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateCertificate": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateCertificateRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateCertificateResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN)\n distribution and a container service.

\n

After the certificate is valid, use the AttachCertificateToDistribution\n action to use the certificate and its domains with your distribution. Or use the\n UpdateContainerService action to use the certificate and its domains with your\n container service.

\n \n

Only certificates created in the us-east-1\n Amazon Web Services Region can be attached to Lightsail distributions. Lightsail\n distributions are global resources that can reference an origin in any Amazon Web Services\n Region, and distribute its content globally. However, all distributions are located in the\n us-east-1 Region.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateCertificate", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateCertificateRequest": { - "type": "structure", - "members": { - "certificateName": { - "target": "com.amazonaws.lightsail#CertificateName", - "traits": { - "smithy.api#documentation": "

The name for the certificate.

", - "smithy.api#required": {} - } - }, - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The domain name (e.g., example.com) for the certificate.

", - "smithy.api#required": {} - } - }, - "subjectAlternativeNames": { - "target": "com.amazonaws.lightsail#SubjectAlternativeNameList", - "traits": { - "smithy.api#documentation": "

An array of strings that specify the alternate domains (e.g., example2.com)\n and subdomains (e.g., blog.example.com) for the certificate.

\n

You can specify a maximum of nine alternate domains (in addition to the primary domain\n name).

\n

Wildcard domain entries (e.g., *.example.com) are not supported.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the certificate during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateCertificateResult": { - "type": "structure", - "members": { - "certificate": { - "target": "com.amazonaws.lightsail#CertificateSummary", - "traits": { - "smithy.api#documentation": "

An object that describes the certificate created.

" - } - }, - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateCloudFormationStack": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateCloudFormationStackRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateCloudFormationStackResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported\n Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be\n used to track the AWS CloudFormation stack created. Use the get cloud formation stack\n records operation to get a list of the CloudFormation stacks created.

\n \n

Wait until after your new Amazon EC2 instance is created before running the create\n cloud formation stack operation again with the same export snapshot record.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateCloudFormationStack", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateCloudFormationStackRequest": { - "type": "structure", - "members": { - "instances": { - "target": "com.amazonaws.lightsail#InstanceEntryList", - "traits": { - "smithy.api#documentation": "

An array of parameters that will be used to create the new Amazon EC2 instance. You can only\n pass one instance entry at a time in this array. You will get an invalid parameter error if\n you pass more than one instance entry in this array.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#CreateCloudFormationStackResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateContactMethod": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateContactMethodRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateContactMethodResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an email or SMS text message contact method.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services\n Regions, and SMS text messages cannot be sent to some countries/regions. For more information,\n see Notifications in Amazon Lightsail.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateContactMethod", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateContactMethodRequest": { - "type": "structure", - "members": { - "protocol": { - "target": "com.amazonaws.lightsail#ContactProtocol", - "traits": { - "smithy.api#documentation": "

The protocol of the contact method, such as Email or SMS (text\n messaging).

\n

The SMS protocol is supported only in the following Amazon Web Services\n Regions.

\n \n

For a list of countries/regions where SMS text messages can be sent, and the latest\n Amazon Web Services Regions where SMS text messaging is supported, see Supported Regions and Countries in the Amazon SNS Developer\n Guide.

\n

For more information about notifications in Amazon Lightsail, see Notifications in Amazon Lightsail.

", - "smithy.api#required": {} - } - }, - "contactEndpoint": { - "target": "com.amazonaws.lightsail#StringMax256", - "traits": { - "smithy.api#documentation": "

The destination of the contact method, such as an email address or a mobile phone\n number.

\n

Use the E.164 format when specifying a mobile phone number. E.164 is a standard for the\n phone number structure used for international telecommunication. Phone numbers that follow\n this format can have a maximum of 15 digits, and they are prefixed with the plus character (+)\n and the country code. For example, a U.S. phone number in E.164 format would be specified as\n +1XXX5550100. For more information, see E.164 on Wikipedia.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#CreateContactMethodResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateContainerService": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateContainerServiceRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateContainerServiceResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an Amazon Lightsail container service.

\n\n

A Lightsail container service is a compute resource to which you can deploy containers.\n For more information, see Container services in Amazon Lightsail in the Lightsail Dev\n Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/container-services", - "code": 201 - } - } - }, - "com.amazonaws.lightsail#CreateContainerServiceDeployment": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateContainerServiceDeploymentRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateContainerServiceDeploymentResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a deployment for your Amazon Lightsail container service.

\n\n

A deployment specifies the containers that will be launched on the container service and\n their settings, such as the ports to open, the environment variables to apply, and the launch\n command to run. It also specifies the container that will serve as the public endpoint of the\n deployment and its settings, such as the HTTP or HTTPS port to use, and the health check\n configuration.

\n\n

You can deploy containers to your container service using container images from a public\n registry such as Amazon ECR Public, or from your local machine. For more information, see\n Creating container images for your Amazon Lightsail container services in the\n Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/container-services/{serviceName}/deployments", - "code": 201 - } - } - }, - "com.amazonaws.lightsail#CreateContainerServiceDeploymentRequest": { - "type": "structure", - "members": { - "serviceName": { - "target": "com.amazonaws.lightsail#ContainerServiceName", - "traits": { - "smithy.api#documentation": "

The name of the container service for which to create the deployment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "containers": { - "target": "com.amazonaws.lightsail#ContainerMap", - "traits": { - "smithy.api#documentation": "

An object that describes the settings of the containers that will be launched on the\n container service.

" - } - }, - "publicEndpoint": { - "target": "com.amazonaws.lightsail#EndpointRequest", - "traits": { - "smithy.api#documentation": "

An object that describes the settings of the public endpoint for the container\n service.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateContainerServiceDeploymentResult": { - "type": "structure", - "members": { - "containerService": { - "target": "com.amazonaws.lightsail#ContainerService", - "traits": { - "smithy.api#documentation": "

An object that describes a container service.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateContainerServiceRegistryLogin": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateContainerServiceRegistryLoginRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateContainerServiceRegistryLoginResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a temporary set of log in credentials that you can use to log in to the Docker\n process on your local machine. After you're logged in, you can use the native Docker commands\n to push your local container images to the container image registry of your Amazon Lightsail\n account so that you can use them with your Lightsail container service. The log in\n credentials expire 12 hours after they are created, at which point you will need to create a\n new set of log in credentials.

\n\n \n

You can only push container images to the container service registry of your Lightsail\n account. You cannot pull container images or perform any other container image management\n actions on the container service registry.

\n \n\n

After you push your container images to the container image registry of your Lightsail\n account, use the RegisterContainerImage action to register the pushed images to a\n specific Lightsail container service.

\n\n \n

This action is not required if you install and use the Lightsail Control\n (lightsailctl) plugin to push container images to your Lightsail container service. For\n more information, see Pushing and managing container images on your Amazon Lightsail container services\n in the Amazon Lightsail Developer Guide.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/container-registry-login", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateContainerServiceRegistryLoginRequest": { - "type": "structure", - "members": {} - }, - "com.amazonaws.lightsail#CreateContainerServiceRegistryLoginResult": { - "type": "structure", - "members": { - "registryLogin": { - "target": "com.amazonaws.lightsail#ContainerServiceRegistryLogin", - "traits": { - "smithy.api#documentation": "

An object that describes the log in information for the container service registry of your\n Lightsail account.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateContainerServiceRequest": { - "type": "structure", - "members": { - "serviceName": { - "target": "com.amazonaws.lightsail#ContainerServiceName", - "traits": { - "smithy.api#documentation": "

The name for the container service.

\n\n

The name that you specify for your container service will make up part of its default\n domain. The default domain of a container service is typically\n https://...cs.amazonlightsail.com.\n If the name of your container service is container-service-1, and it's located in\n the US East (Ohio) Amazon Web Services Region (us-east-2), then the domain for\n your container service will be like the following example:\n https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com\n

\n\n

The following are the requirements for container service names:

\n\n ", - "smithy.api#required": {} - } - }, - "power": { - "target": "com.amazonaws.lightsail#ContainerServicePowerName", - "traits": { - "smithy.api#documentation": "

The power specification for the container service.

\n\n

The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the\n container service. The power and scale of a container service makes\n up its configured capacity. To determine the monthly price of your container service, multiply\n the base price of the power with the scale (the number of nodes) of\n the service.

\n\n

Use the GetContainerServicePowers action to get a list of power options that\n you can specify using this parameter, and their base monthly cost.

", - "smithy.api#required": {} - } - }, - "scale": { - "target": "com.amazonaws.lightsail#ContainerServiceScale", - "traits": { - "smithy.api#documentation": "

The scale specification for the container service.

\n\n

The scale specifies the allocated compute nodes of the container service. The\n power and scale of a container service makes up its configured\n capacity. To determine the monthly price of your container service, multiply the base price of\n the power with the scale (the number of nodes) of the\n service.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the container service during create.

\n

Use the TagResource action to tag a resource after it's created.

\n

For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "publicDomainNames": { - "target": "com.amazonaws.lightsail#ContainerServicePublicDomains", - "traits": { - "smithy.api#documentation": "

The public domain names to use with the container service, such as\n example.com and www.example.com.

\n\n

You can specify up to four public domain names for a container service. The domain names\n that you specify are used when you create a deployment with a container configured as the\n public endpoint of your container service.

\n\n

If you don't specify public domain names, then you can use the default domain of the\n container service.

\n\n \n

You must create and validate an SSL/TLS certificate before you can use public domain\n names with your container service. Use the CreateCertificate action to create a\n certificate for the public domain names you want to use with your container service.

\n \n\n

You can specify public domain names using a string to array map as shown in the example\n later on this page.

" - } - }, - "deployment": { - "target": "com.amazonaws.lightsail#ContainerServiceDeploymentRequest", - "traits": { - "smithy.api#documentation": "

An object that describes a deployment for the container service.

\n\n

A deployment specifies the containers that will be launched on the container service and\n their settings, such as the ports to open, the environment variables to apply, and the launch\n command to run. It also specifies the container that will serve as the public endpoint of the\n deployment and its settings, such as the HTTP or HTTPS port to use, and the health check\n configuration.

" - } - }, - "privateRegistryAccess": { - "target": "com.amazonaws.lightsail#PrivateRegistryAccessRequest", - "traits": { - "smithy.api#documentation": "

An object to describe the configuration for the container service to access private\n container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private\n repositories.

\n\n

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateContainerServiceResult": { - "type": "structure", - "members": { - "containerService": { - "target": "com.amazonaws.lightsail#ContainerService", - "traits": { - "smithy.api#documentation": "

An object that describes a container service.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateDisk": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateDiskRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateDiskResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a block storage disk that can be attached to an Amazon Lightsail instance in the\n same Availability Zone (e.g., us-east-2a).

\n

The create disk operation supports tag-based access control via request tags.\n For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateDisk", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateDiskFromSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateDiskFromSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateDiskFromSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting\n disk can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g.,\n us-east-2a).

\n

The create disk from snapshot operation supports tag-based access control via\n request tags and resource tags applied to the resource identified by disk snapshot\n name. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateDiskFromSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateDiskFromSnapshotRequest": { - "type": "structure", - "members": { - "diskName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The unique Lightsail disk name (e.g., my-disk).

", - "smithy.api#required": {} - } - }, - "diskSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the disk snapshot (e.g., my-snapshot) from which to create the\n new storage disk.

\n

Constraint:

\n " - } - }, - "availabilityZone": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Availability Zone where you want to create the disk (e.g., us-east-2a).\n Choose the same Availability Zone as the Lightsail instance where you want to create the\n disk.

\n

Use the GetRegions operation to list the Availability Zones where Lightsail is currently\n available.

", - "smithy.api#required": {} - } - }, - "sizeInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The size of the disk in GB (e.g., 32).

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - }, - "addOns": { - "target": "com.amazonaws.lightsail#AddOnRequestList", - "traits": { - "smithy.api#documentation": "

An array of objects that represent the add-ons to enable for the new disk.

" - } - }, - "sourceDiskName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the source disk from which the source automatic snapshot was created.

\n

Constraints:

\n " - } - }, - "restoreDate": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The date of the automatic snapshot to use for the new disk. Use the get auto\n snapshots operation to identify the dates of the available automatic\n snapshots.

\n

Constraints:

\n " - } - }, - "useLatestRestorableAutoSnapshot": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value to indicate whether to use the latest available automatic snapshot.

\n

Constraints:

\n " - } - } - } - }, - "com.amazonaws.lightsail#CreateDiskFromSnapshotResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateDiskRequest": { - "type": "structure", - "members": { - "diskName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The unique Lightsail disk name (e.g., my-disk).

", - "smithy.api#required": {} - } - }, - "availabilityZone": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Availability Zone where you want to create the disk (e.g., us-east-2a).\n Use the same Availability Zone as the Lightsail instance to which you want to attach the\n disk.

\n

Use the get regions operation to list the Availability Zones where\n Lightsail is currently available.

", - "smithy.api#required": {} - } - }, - "sizeInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The size of the disk in GB (e.g., 32).

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - }, - "addOns": { - "target": "com.amazonaws.lightsail#AddOnRequestList", - "traits": { - "smithy.api#documentation": "

An array of objects that represent the add-ons to enable for the new disk.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateDiskResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateDiskSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateDiskSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateDiskSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a snapshot of a block storage disk. You can use snapshots for backups, to make\n copies of disks, and to save data before shutting down a Lightsail instance.

\n

You can take a snapshot of an attached disk that is in use; however, snapshots only\n capture data that has been written to your disk at the time the snapshot command is issued.\n This may exclude any data that has been cached by any applications or the operating system. If\n you can pause any file systems on the disk long enough to take a snapshot, your snapshot\n should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should\n unmount the disk from within the Lightsail instance, issue the create disk snapshot command,\n and then remount the disk to ensure a consistent and complete snapshot. You may remount and\n use your disk while the snapshot status is pending.

\n

You can also use this operation to create a snapshot of an instance's system volume. You\n might want to do this, for example, to recover data from the system volume of a botched\n instance or to create a backup of the system volume like you would for a block storage disk.\n To create a snapshot of a system volume, just define the instance name parameter\n when issuing the snapshot command, and a snapshot of the defined instance's system volume will\n be created. After the snapshot is available, you can create a block storage disk from the\n snapshot and attach it to a running instance to access the data on the disk.

\n \n

The create disk snapshot operation supports tag-based access control via\n request tags. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateDiskSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateDiskSnapshotRequest": { - "type": "structure", - "members": { - "diskName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The unique name of the source disk (e.g., Disk-Virginia-1).

\n \n

This parameter cannot be defined together with the instance name parameter.\n The disk name and instance name parameters are mutually\n exclusive.

\n " - } - }, - "diskSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the destination disk snapshot (e.g., my-disk-snapshot) based on\n the source disk.

", - "smithy.api#required": {} - } - }, - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The unique name of the source instance (e.g., Amazon_Linux-512MB-Virginia-1).\n When this is defined, a snapshot of the instance's system volume is created.

\n \n

This parameter cannot be defined together with the disk name parameter. The\n instance name and disk name parameters are mutually\n exclusive.

\n " - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateDiskSnapshotResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateDistribution": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateDistributionRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateDistributionResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an Amazon Lightsail content delivery network (CDN) distribution.

\n

A distribution is a globally distributed network of caching servers that improve the\n performance of your website or web application hosted on a Lightsail instance. For more\n information, see Content delivery networks in Amazon Lightsail.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateDistribution", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateDistributionRequest": { - "type": "structure", - "members": { - "distributionName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name for the distribution.

", - "smithy.api#required": {} - } - }, - "origin": { - "target": "com.amazonaws.lightsail#InputOrigin", - "traits": { - "smithy.api#documentation": "

An object that describes the origin resource for the distribution, such as a Lightsail\n instance, bucket, or load balancer.

\n

The distribution pulls, caches, and serves content from the origin.

", - "smithy.api#required": {} - } - }, - "defaultCacheBehavior": { - "target": "com.amazonaws.lightsail#CacheBehavior", - "traits": { - "smithy.api#documentation": "

An object that describes the default cache behavior for the distribution.

", - "smithy.api#required": {} - } - }, - "cacheBehaviorSettings": { - "target": "com.amazonaws.lightsail#CacheSettings", - "traits": { - "smithy.api#documentation": "

An object that describes the cache behavior settings for the distribution.

" - } - }, - "cacheBehaviors": { - "target": "com.amazonaws.lightsail#CacheBehaviorList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the per-path cache behavior for the distribution.

" - } - }, - "bundleId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The bundle ID to use for the distribution.

\n

A distribution bundle describes the specifications of your distribution, such as the\n monthly cost and monthly network transfer quota.

\n

Use the GetDistributionBundles action to get a list of distribution bundle\n IDs that you can specify.

", - "smithy.api#required": {} - } - }, - "ipAddressType": { - "target": "com.amazonaws.lightsail#IpAddressType", - "traits": { - "smithy.api#documentation": "

The IP address type for the distribution.

\n\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

\n\n

The default value is dualstack.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the distribution during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateDistributionResult": { - "type": "structure", - "members": { - "distribution": { - "target": "com.amazonaws.lightsail#LightsailDistribution", - "traits": { - "smithy.api#documentation": "

An object that describes the distribution created.

" - } - }, - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateDomain": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateDomainRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateDomainResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a domain resource for the specified domain (e.g., example.com).

\n

The create domain operation supports tag-based access control via request\n tags. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateDomain", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateDomainEntry": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateDomainEntryRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateDomainEntryResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates one of the following domain name system (DNS) records in a domain DNS zone:\n Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority\n (SOA), service locator (SRV), or text (TXT).

\n\n\n\n

The create domain entry operation supports tag-based access control via\n resource tags applied to the resource identified by domain name. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateDomainEntry", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateDomainEntryRequest": { - "type": "structure", - "members": { - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The domain name (e.g., example.com) for which you want to create the domain\n entry.

", - "smithy.api#required": {} - } - }, - "domainEntry": { - "target": "com.amazonaws.lightsail#DomainEntry", - "traits": { - "smithy.api#documentation": "

An array of key-value pairs containing information about the domain entry request.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#CreateDomainEntryResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateDomainRequest": { - "type": "structure", - "members": { - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The domain name to manage (e.g., example.com).

\n \n

You cannot register a new domain name using Lightsail. You must register a domain name\n using Amazon Route 53 or another domain name registrar. If you have already registered your\n domain, you can enter its name in this parameter to manage the DNS records for that domain\n using Lightsail.

\n ", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateDomainResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateInstanceSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateInstanceSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateInstanceSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a snapshot of a specific virtual private server, or instance.\n You can use a snapshot to create a new instance that is based on that snapshot.

\n

The create instance snapshot operation supports tag-based access control via\n request tags. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateInstanceSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateInstanceSnapshotRequest": { - "type": "structure", - "members": { - "instanceSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name for your new snapshot.

", - "smithy.api#required": {} - } - }, - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The Lightsail instance on which to base your snapshot.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateInstanceSnapshotResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateInstancesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateInstancesResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates one or more Amazon Lightsail instances.

\n

The create instances operation supports tag-based access control via request\n tags. For more information, see the Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateInstances", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateInstancesFromSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateInstancesFromSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateInstancesFromSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates one or more new instances from a manual or automatic snapshot of an\n instance.

\n

The create instances from snapshot operation supports tag-based access\n control via request tags and resource tags applied to the resource identified by\n instance snapshot name. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateInstancesFromSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateInstancesFromSnapshotRequest": { - "type": "structure", - "members": { - "instanceNames": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The names for your new instances.

", - "smithy.api#required": {} - } - }, - "attachedDiskMapping": { - "target": "com.amazonaws.lightsail#AttachedDiskMap", - "traits": { - "smithy.api#documentation": "

An object containing information about one or more disk mappings.

" - } - }, - "availabilityZone": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The Availability Zone where you want to create your instances. Use the following\n formatting: us-east-2a (case sensitive). You can get a list of Availability Zones\n by using the get\n regions operation. Be sure to add the include Availability Zones\n parameter to your request.

", - "smithy.api#required": {} - } - }, - "instanceSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance snapshot on which you are basing your new instances. Use the get\n instance snapshots operation to return information about your existing snapshots.

\n

Constraint:

\n " - } - }, - "bundleId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The bundle of specification information for your virtual private server (or\n instance), including the pricing plan (e.g.,\n micro_1_0).

", - "smithy.api#required": {} - } - }, - "userData": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

You can create a launch script that configures a server with additional user data. For\n example, apt-get -y update.

\n \n

Depending on the machine image you choose, the command to get software on your instance\n varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use\n apt-get, and FreeBSD uses pkg. For a complete list, see the\n Amazon Lightsail Developer Guide.

\n " - } - }, - "keyPairName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name for your key pair.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - }, - "addOns": { - "target": "com.amazonaws.lightsail#AddOnRequestList", - "traits": { - "smithy.api#documentation": "

An array of objects representing the add-ons to enable for the new instance.

" - } - }, - "ipAddressType": { - "target": "com.amazonaws.lightsail#IpAddressType", - "traits": { - "smithy.api#documentation": "

The IP address type for the instance.

\n\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

\n\n

The default value is dualstack.

" - } - }, - "sourceInstanceName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the source instance from which the source automatic snapshot was\n created.

\n

Constraints:

\n " - } - }, - "restoreDate": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The date of the automatic snapshot to use for the new instance. Use the get auto\n snapshots operation to identify the dates of the available automatic\n snapshots.

\n

Constraints:

\n " - } - }, - "useLatestRestorableAutoSnapshot": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value to indicate whether to use the latest available automatic snapshot.

\n

Constraints:

\n " - } - } - } - }, - "com.amazonaws.lightsail#CreateInstancesFromSnapshotResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateInstancesRequest": { - "type": "structure", - "members": { - "instanceNames": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The names to use for your new Lightsail instances. Separate multiple values using\n quotation marks and commas, for example:\n [\"MyFirstInstance\",\"MySecondInstance\"]\n

", - "smithy.api#required": {} - } - }, - "availabilityZone": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The Availability Zone in which to create your instance. Use the following format:\n us-east-2a (case sensitive). You can get a list of Availability Zones by using\n the get\n regions operation. Be sure to add the include Availability Zones\n parameter to your request.

", - "smithy.api#required": {} - } - }, - "customImageName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

(Deprecated) The name for your custom image.

\n \n

In releases prior to June 12, 2017, this parameter was ignored by the API. It is now\n deprecated.

\n " - } - }, - "blueprintId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID for a virtual private server image (e.g., app_wordpress_4_4 or\n app_lamp_7_0). Use the get blueprints operation to return a list\n of available images (or blueprints).

\n \n

Use active blueprints when creating new instances. Inactive blueprints are listed to\n support customers with existing instances and are not necessarily available to create new\n instances. Blueprints are marked inactive when they become outdated due to operating system\n updates or new application releases.

\n ", - "smithy.api#required": {} - } - }, - "bundleId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The bundle of specification information for your virtual private server (or\n instance), including the pricing plan (e.g.,\n micro_1_0).

", - "smithy.api#required": {} - } - }, - "userData": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

A launch script you can create that configures a server with additional user data. For\n example, you might want to run apt-get -y update.

\n \n

Depending on the machine image you choose, the command to get software on your instance\n varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use\n apt-get, and FreeBSD uses pkg. For a complete list, see the\n Amazon Lightsail Developer Guide.

\n " - } - }, - "keyPairName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your key pair.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - }, - "addOns": { - "target": "com.amazonaws.lightsail#AddOnRequestList", - "traits": { - "smithy.api#documentation": "

An array of objects representing the add-ons to enable for the new instance.

" - } - }, - "ipAddressType": { - "target": "com.amazonaws.lightsail#IpAddressType", - "traits": { - "smithy.api#documentation": "

The IP address type for the instance.

\n\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

\n\n

The default value is dualstack.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateInstancesResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateKeyPair": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateKeyPairRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateKeyPairResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a custom SSH key pair that you can use with an Amazon Lightsail\n instance.

\n \n

Use the DownloadDefaultKeyPair action to create a Lightsail default key\n pair in an Amazon Web Services Region where a default key pair does not currently\n exist.

\n \n

The create key pair operation supports tag-based access control via request\n tags. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateKeyPair", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateKeyPairRequest": { - "type": "structure", - "members": { - "keyPairName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name for your new key pair.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateKeyPairResult": { - "type": "structure", - "members": { - "keyPair": { - "target": "com.amazonaws.lightsail#KeyPair", - "traits": { - "smithy.api#documentation": "

An array of key-value pairs containing information about the new key pair you just\n created.

" - } - }, - "publicKeyBase64": { - "target": "com.amazonaws.lightsail#Base64", - "traits": { - "smithy.api#documentation": "

A base64-encoded public key of the ssh-rsa type.

" - } - }, - "privateKeyBase64": { - "target": "com.amazonaws.lightsail#Base64", - "traits": { - "smithy.api#documentation": "

A base64-encoded RSA private key.

" - } - }, - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateLoadBalancer": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateLoadBalancerRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateLoadBalancerResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a Lightsail load balancer. To learn more about deciding whether to load balance\n your application, see Configure your Lightsail instances for load balancing. You can create up to 5\n load balancers per AWS Region in your account.

\n

When you create a load balancer, you can specify a unique name and port settings. To\n change additional load balancer settings, use the UpdateLoadBalancerAttribute\n operation.

\n

The create load balancer operation supports tag-based access control via\n request tags. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateLoadBalancer", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateLoadBalancerRequest": { - "type": "structure", - "members": { - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your load balancer.

", - "smithy.api#required": {} - } - }, - "instancePort": { - "target": "com.amazonaws.lightsail#Port", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The instance port where you're creating your load balancer.

", - "smithy.api#required": {} - } - }, - "healthCheckPath": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The path you provided to perform the load balancer health check. If you didn't specify a\n health check path, Lightsail uses the root path of your website (e.g.,\n \"/\").

\n

You may want to specify a custom health check path other than the root of your application\n if your home page loads slowly or has a lot of media or scripting on it.

" - } - }, - "certificateName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the SSL/TLS certificate.

\n

If you specify certificateName, then certificateDomainName is\n required (and vice-versa).

" - } - }, - "certificateDomainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The domain name with which your certificate is associated (e.g.,\n example.com).

\n

If you specify certificateDomainName, then certificateName is\n required (and vice-versa).

" - } - }, - "certificateAlternativeNames": { - "target": "com.amazonaws.lightsail#DomainNameList", - "traits": { - "smithy.api#documentation": "

The optional alternative domains and subdomains to use with your SSL/TLS certificate\n (e.g., www.example.com, example.com, m.example.com,\n blog.example.com).

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - }, - "ipAddressType": { - "target": "com.amazonaws.lightsail#IpAddressType", - "traits": { - "smithy.api#documentation": "

The IP address type for the load balancer.

\n\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

\n\n

The default value is dualstack.

" - } - }, - "tlsPolicyName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the TLS policy to apply to the load balancer.

\n\n

Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can\n specify.

\n\n

For more information about load balancer TLS policies, see Configuring TLS security policies on your Amazon Lightsail load\n balancers in the Amazon Lightsail Developer Guide.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateLoadBalancerResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificate": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificateRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificateResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.

\n

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

\n

The CreateLoadBalancerTlsCertificate operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateLoadBalancerTlsCertificate", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificateRequest": { - "type": "structure", - "members": { - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The load balancer name where you want to create the SSL/TLS certificate.

", - "smithy.api#required": {} - } - }, - "certificateName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The SSL/TLS certificate name.

\n

You can have up to 10 certificates in your account at one time. Each Lightsail load\n balancer can have up to 2 certificates associated with it at one time. There is also an\n overall limit to the number of certificates that can be issue in a 365-day period. For more\n information, see Limits.

", - "smithy.api#required": {} - } - }, - "certificateDomainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The domain name (e.g., example.com) for your SSL/TLS certificate.

", - "smithy.api#required": {} - } - }, - "certificateAlternativeNames": { - "target": "com.amazonaws.lightsail#DomainNameList", - "traits": { - "smithy.api#documentation": "

An array of strings listing alternative domains and subdomains for your SSL/TLS\n certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9\n alternative names (in addition to the 1 primary domain). We do not support wildcards (e.g.,\n *.example.com).

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificateResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateRelationalDatabase": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateRelationalDatabaseRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateRelationalDatabaseResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new database in Amazon Lightsail.

\n

The create relational database operation supports tag-based access control\n via request tags. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateRelationalDatabase", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new database from an existing database snapshot in Amazon Lightsail.

\n

You can create a new database from a snapshot in if something goes wrong with your\n original database, or to change it to a different plan, such as a high availability or\n standard plan.

\n

The create relational database from snapshot operation supports tag-based\n access control via request tags and resource tags applied to the resource identified by\n relationalDatabaseSnapshotName. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateRelationalDatabaseFromSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshotRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name to use for your new Lightsail database resource.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "availabilityZone": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The Availability Zone in which to create your new database. Use the\n us-east-2a case-sensitive format.

\n

You can get a list of Availability Zones by using the get regions operation.\n Be sure to add the include relational database Availability Zones parameter to\n your request.

" - } - }, - "publiclyAccessible": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Specifies the accessibility options for your new database. A value of true\n specifies a database that is available to resources outside of your Lightsail account. A\n value of false specifies a database that is available only to your Lightsail\n resources in the same region as your database.

" - } - }, - "relationalDatabaseSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the database snapshot from which to create your new database.

" - } - }, - "relationalDatabaseBundleId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The bundle ID for your new database. A bundle describes the performance specifications for\n your database.

\n

You can get a list of database bundle IDs by using the get relational database\n bundles operation.

\n

When creating a new database from a snapshot, you cannot choose a bundle that is smaller\n than the bundle of the source database.

" - } - }, - "sourceRelationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the source database.

" - } - }, - "restoreTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The date and time to restore your database from.

\n

Constraints:

\n " - } - }, - "useLatestRestorableTime": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether your database is restored from the latest backup time. A value of\n true restores from the latest backup time.

\n

Default: false\n

\n

Constraints: Cannot be specified if the restore time parameter is\n provided.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshotResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateRelationalDatabaseRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name to use for your new Lightsail database resource.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "availabilityZone": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The Availability Zone in which to create your new database. Use the\n us-east-2a case-sensitive format.

\n

You can get a list of Availability Zones by using the get regions operation.\n Be sure to add the include relational database Availability Zones parameter to\n your request.

" - } - }, - "relationalDatabaseBlueprintId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The blueprint ID for your new database. A blueprint describes the major engine version of\n a database.

\n

You can get a list of database blueprints IDs by using the get relational database\n blueprints operation.

", - "smithy.api#required": {} - } - }, - "relationalDatabaseBundleId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The bundle ID for your new database. A bundle describes the performance specifications for\n your database.

\n

You can get a list of database bundle IDs by using the get relational database\n bundles operation.

", - "smithy.api#required": {} - } - }, - "masterDatabaseName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The meaning of this parameter differs according to the database engine you use.

\n

\n MySQL\n

\n

The name of the database to create when the Lightsail database resource is created. If\n this parameter isn't specified, no database is created in the database resource.

\n

Constraints:

\n \n

\n PostgreSQL\n

\n

The name of the database to create when the Lightsail database resource is created. If\n this parameter isn't specified, a database named postgres is created in the\n database resource.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "masterUsername": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name for the master user.

\n

\n MySQL\n

\n

Constraints:

\n \n

\n PostgreSQL\n

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "masterUserPassword": { - "target": "com.amazonaws.lightsail#SensitiveString", - "traits": { - "smithy.api#documentation": "

The password for the master user. The password can include any printable ASCII character\n except \"/\", \"\"\", or \"@\". It cannot contain spaces.

\n

\n MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

" - } - }, - "preferredBackupWindow": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created for your new database if\n automated backups are enabled.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n AWS Region. For more information about the preferred backup window time blocks for each\n region, see the Working With Backups guide in the Amazon Relational Database Service documentation.

\n

Constraints:

\n " - } - }, - "preferredMaintenanceWindow": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur on your new\n database.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n AWS Region, occurring on a random day of the week.

\n

Constraints:

\n " - } - }, - "publiclyAccessible": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Specifies the accessibility options for your new database. A value of true\n specifies a database that is available to resources outside of your Lightsail account. A\n value of false specifies a database that is available only to your Lightsail\n resources in the same region as your database.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateRelationalDatabaseResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups,\n to make copies of a database, and to save data before deleting a database.

\n

The create relational database snapshot operation supports tag-based access\n control via request tags. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/CreateRelationalDatabaseSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshotRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the database on which to base your new snapshot.

", - "smithy.api#required": {} - } - }, - "relationalDatabaseSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name for your new database snapshot.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" - } - } - } - }, - "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshotResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteAlarm": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteAlarmRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteAlarmResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an alarm.

\n

An alarm is used to monitor a single metric for one of your resources. When a metric\n condition is met, the alarm can notify you by email, SMS text message, and a banner displayed\n on the Amazon Lightsail console. For more information, see Alarms\n in Amazon Lightsail.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/ls/api/2016-11-28/DeleteAlarm", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteAlarmRequest": { - "type": "structure", - "members": { - "alarmName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the alarm to delete.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#DeleteAlarmResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteAutoSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteAutoSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteAutoSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteAutoSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteAutoSnapshotRequest": { - "type": "structure", - "members": { - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the source instance or disk from which to delete the automatic\n snapshot.

", - "smithy.api#required": {} - } - }, - "date": { - "target": "com.amazonaws.lightsail#AutoSnapshotDate", - "traits": { - "smithy.api#documentation": "

The date of the automatic snapshot to delete in YYYY-MM-DD format. Use the\n get auto snapshots operation to get the available automatic snapshots for a\n resource.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#DeleteAutoSnapshotResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteBucket": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteBucketRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteBucketResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a Amazon Lightsail bucket.

\n\n \n

When you delete your bucket, the bucket name is released and can be reused for a new\n bucket in your account or another Amazon Web Services account.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteBucket", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteBucketAccessKey": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteBucketAccessKeyRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteBucketAccessKeyResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an access key for the specified Amazon Lightsail bucket.

\n\n

We recommend that you delete an access key if the secret access key is compromised.

\n\n

For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteBucketAccessKey", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteBucketAccessKeyRequest": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.lightsail#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket that the access key belongs to.

", - "smithy.api#required": {} - } - }, - "accessKeyId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the access key to delete.

\n\n

Use the GetBucketAccessKeys action to get a\n list of access key IDs that you can specify.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#DeleteBucketAccessKeyResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteBucketRequest": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.lightsail#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket to delete.

\n\n

Use the GetBuckets action to get a list of bucket names\n that you can specify.

", - "smithy.api#required": {} - } - }, - "forceDelete": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether to force delete the bucket.

\n\n

You must force delete the bucket if it has one of the following conditions:

\n \n\n \n

Force deleting a bucket might impact other resources that rely on the bucket, such as\n instances, distributions, or software that use the issued access keys.

\n " - } - } - } - }, - "com.amazonaws.lightsail#DeleteBucketResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteCertificate": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteCertificateRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteCertificateResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

Certificates that are currently attached to a distribution cannot be deleted. Use the\n DetachCertificateFromDistribution action to detach a certificate from a\n distribution.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteCertificate", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteCertificateRequest": { - "type": "structure", - "members": { - "certificateName": { - "target": "com.amazonaws.lightsail#CertificateName", - "traits": { - "smithy.api#documentation": "

The name of the certificate to delete.

\n

Use the GetCertificates action to get a list of certificate names that you\n can specify.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#DeleteCertificateResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteContactMethod": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteContactMethodRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteContactMethodResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a contact method.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services\n Regions, and SMS text messages cannot be sent to some countries/regions. For more information,\n see Notifications in Amazon Lightsail.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteContactMethod", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteContactMethodRequest": { - "type": "structure", - "members": { - "protocol": { - "target": "com.amazonaws.lightsail#ContactProtocol", - "traits": { - "smithy.api#documentation": "

The protocol that will be deleted, such as Email or SMS (text\n messaging).

\n \n

To delete an Email and an SMS contact method if you added\n both, you must run separate DeleteContactMethod actions to delete each\n protocol.

\n ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#DeleteContactMethodResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteContainerImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteContainerImageRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteContainerImageResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a container image that is registered to your Amazon Lightsail container\n service.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/ls/api/2016-11-28/container-services/{serviceName}/images/{image}", - "code": 204 - } - } - }, - "com.amazonaws.lightsail#DeleteContainerImageRequest": { - "type": "structure", - "members": { - "serviceName": { - "target": "com.amazonaws.lightsail#ContainerServiceName", - "traits": { - "smithy.api#documentation": "

The name of the container service for which to delete a registered container image.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "image": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the container image to delete from the container service.

\n\n

Use the GetContainerImages action to get the name of the container images\n that are registered to a container service.

\n\n \n

Container images sourced from your Lightsail container service, that are registered\n and stored on your service, start with a colon (:). For example,\n :container-service-1.mystaticwebsite.1. Container images sourced from a\n public registry like Docker Hub don't start with a colon. For example,\n nginx:latest or nginx.

\n ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#DeleteContainerImageResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.lightsail#DeleteContainerService": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteContainerServiceRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteContainerServiceResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes your Amazon Lightsail container service.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/ls/api/2016-11-28/container-services/{serviceName}", - "code": 204 - } - } - }, - "com.amazonaws.lightsail#DeleteContainerServiceRequest": { - "type": "structure", - "members": { - "serviceName": { - "target": "com.amazonaws.lightsail#ContainerServiceName", - "traits": { - "smithy.api#documentation": "

The name of the container service to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#DeleteContainerServiceResult": { - "type": "structure", - "members": {} - }, - "com.amazonaws.lightsail#DeleteDisk": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteDiskRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteDiskResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified block storage disk. The disk must be in the available\n state (not attached to a Lightsail instance).

\n \n

The disk may remain in the deleting state for several minutes.

\n \n

The delete disk operation supports tag-based access control via resource tags\n applied to the resource identified by disk name. For more information, see the\n Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteDisk", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteDiskRequest": { - "type": "structure", - "members": { - "diskName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The unique name of the disk you want to delete (e.g., my-disk).

", - "smithy.api#required": {} - } - }, - "forceDeleteAddOns": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value to indicate whether to delete the enabled add-ons for the disk.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteDiskResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteDiskSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteDiskSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteDiskSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified disk snapshot.

\n

When you make periodic snapshots of a disk, the snapshots are incremental, and only the\n blocks on the device that have changed since your last snapshot are saved in the new snapshot.\n When you delete a snapshot, only the data not needed for any other snapshot is removed. So\n regardless of which prior snapshots have been deleted, all active snapshots will have access\n to all the information needed to restore the disk.

\n

The delete disk snapshot operation supports tag-based access control via\n resource tags applied to the resource identified by disk snapshot name. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteDiskSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteDiskSnapshotRequest": { - "type": "structure", - "members": { - "diskSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the disk snapshot you want to delete (e.g.,\n my-disk-snapshot).

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#DeleteDiskSnapshotResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteDistribution": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteDistributionRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteDistributionResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes your Amazon Lightsail content delivery network (CDN) distribution.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteDistribution", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteDistributionRequest": { - "type": "structure", - "members": { - "distributionName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the distribution to delete.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteDistributionResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteDomain": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteDomainRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteDomainResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified domain recordset and all of its domain records.

\n

The delete domain operation supports tag-based access control via resource\n tags applied to the resource identified by domain name. For more information, see\n the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteDomain", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteDomainEntry": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteDomainEntryRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteDomainEntryResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a specific domain entry.

\n

The delete domain entry operation supports tag-based access control via\n resource tags applied to the resource identified by domain name. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteDomainEntry", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteDomainEntryRequest": { - "type": "structure", - "members": { - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The name of the domain entry to delete.

", - "smithy.api#required": {} - } - }, - "domainEntry": { - "target": "com.amazonaws.lightsail#DomainEntry", - "traits": { - "smithy.api#documentation": "

An array of key-value pairs containing information about your domain entries.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#DeleteDomainEntryResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteDomainRequest": { - "type": "structure", - "members": { - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The specific domain name to delete.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#DeleteDomainResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteInstanceRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteInstanceResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an Amazon Lightsail instance.

\n

The delete instance operation supports tag-based access control via resource\n tags applied to the resource identified by instance name. For more information,\n see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteInstance", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteInstanceRequest": { - "type": "structure", - "members": { - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance to delete.

", - "smithy.api#required": {} - } - }, - "forceDeleteAddOns": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value to indicate whether to delete the enabled add-ons for the disk.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteInstanceResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteInstanceSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteInstanceSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteInstanceSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a specific snapshot of a virtual private server (or\n instance).

\n

The delete instance snapshot operation supports tag-based access control via\n resource tags applied to the resource identified by instance snapshot name. For\n more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteInstanceSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteInstanceSnapshotRequest": { - "type": "structure", - "members": { - "instanceSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the snapshot to delete.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#DeleteInstanceSnapshotResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteKeyPair": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteKeyPairRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteKeyPairResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified key pair by removing the public key from Amazon Lightsail.

\n

You can delete key pairs that were created using the ImportKeyPair and\n CreateKeyPair actions, as well as the Lightsail default key pair. A new default\n key pair will not be created unless you launch an instance without specifying a custom key\n pair, or you call the DownloadDefaultKeyPair API.

\n\n

The delete key pair operation supports tag-based access control via resource\n tags applied to the resource identified by key pair name. For more information,\n see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteKeyPair", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteKeyPairRequest": { - "type": "structure", - "members": { - "keyPairName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the key pair to delete.

", - "smithy.api#required": {} - } - }, - "expectedFingerprint": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The RSA fingerprint of the Lightsail default key pair to delete.

\n \n

The expectedFingerprint parameter is required only when specifying to\n delete a Lightsail default key pair.

\n " - } - } - } - }, - "com.amazonaws.lightsail#DeleteKeyPairResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteKnownHostKeys": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteKnownHostKeysRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteKnownHostKeysResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or\n RDP clients to authenticate an instance. This operation enables the Lightsail browser-based\n SSH or RDP clients to connect to the instance after a host key mismatch.

\n \n

Perform this operation only if you were expecting the host key or certificate mismatch\n or if you are familiar with the new host key or certificate on the instance. For more\n information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP\n client.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteKnownHostKeys", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteKnownHostKeysRequest": { - "type": "structure", - "members": { - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance for which you want to reset the host key or certificate.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#DeleteKnownHostKeysResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteLoadBalancer": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteLoadBalancerRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteLoadBalancerResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the\n load balancer is deleted, you will need to create a new load balancer, create a new\n certificate, and verify domain ownership again.

\n

The delete load balancer operation supports tag-based access control via\n resource tags applied to the resource identified by load balancer name. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteLoadBalancer", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteLoadBalancerRequest": { - "type": "structure", - "members": { - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the load balancer you want to delete.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#DeleteLoadBalancerResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificate": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificateRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificateResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an SSL/TLS certificate associated with a Lightsail load balancer.

\n

The DeleteLoadBalancerTlsCertificate operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteLoadBalancerTlsCertificate", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificateRequest": { - "type": "structure", - "members": { - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The load balancer name.

", - "smithy.api#required": {} - } - }, - "certificateName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The SSL/TLS certificate name.

", - "smithy.api#required": {} - } - }, - "force": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

When true, forces the deletion of an SSL/TLS certificate.

\n

There can be two certificates associated with a Lightsail load balancer: the primary and\n the backup. The force parameter is required when the primary SSL/TLS certificate\n is in use by an instance attached to the load balancer.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificateResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteRelationalDatabase": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteRelationalDatabaseRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteRelationalDatabaseResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a database in Amazon Lightsail.

\n

The delete relational database operation supports tag-based access control\n via resource tags applied to the resource identified by relationalDatabaseName. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteRelationalDatabase", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteRelationalDatabaseRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the database that you are deleting.

", - "smithy.api#required": {} - } - }, - "skipFinalSnapshot": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Determines whether a final database snapshot is created before your database is deleted.\n If true is specified, no database snapshot is created. If false is\n specified, a database snapshot is created before your database is deleted.

\n

You must specify the final relational database snapshot name parameter if the\n skip final snapshot parameter is false.

\n

Default: false\n

" - } - }, - "finalRelationalDatabaseSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the database snapshot created if skip final snapshot is\n false, which is the default value for that parameter.

\n \n

Specifying this parameter and also specifying the skip final snapshot\n parameter to true results in an error.

\n \n

Constraints:

\n " - } - } - } - }, - "com.amazonaws.lightsail#DeleteRelationalDatabaseResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a database snapshot in Amazon Lightsail.

\n

The delete relational database snapshot operation supports tag-based access\n control via resource tags applied to the resource identified by relationalDatabaseName. For\n more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DeleteRelationalDatabaseSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshotRequest": { - "type": "structure", - "members": { - "relationalDatabaseSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the database snapshot that you are deleting.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshotResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DestinationInfo": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the resource created at the destination.

" - } - }, - "service": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The destination service of the record.

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

Describes the destination of a record.

" - } - }, - "com.amazonaws.lightsail#DetachCertificateFromDistribution": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DetachCertificateFromDistributionRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DetachCertificateFromDistributionResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

After the certificate is detached, your distribution stops accepting traffic for all of\n the domains that are associated with the certificate.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DetachCertificateFromDistribution", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DetachCertificateFromDistributionRequest": { - "type": "structure", - "members": { - "distributionName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the distribution from which to detach the certificate.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#DetachCertificateFromDistributionResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DetachDisk": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DetachDiskRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DetachDiskResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount\n any file systems on the device within your operating system before stopping the instance and\n detaching the disk.

\n

The detach disk operation supports tag-based access control via resource tags\n applied to the resource identified by disk name. For more information, see the\n Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DetachDisk", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DetachDiskRequest": { - "type": "structure", - "members": { - "diskName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The unique name of the disk you want to detach from your instance (e.g.,\n my-disk).

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#DetachDiskResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DetachInstancesFromLoadBalancer": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DetachInstancesFromLoadBalancerRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DetachInstancesFromLoadBalancerResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Detaches the specified instances from a Lightsail load balancer.

\n

This operation waits until the instances are no longer needed before they are detached\n from the load balancer.

\n

The detach instances from load balancer operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DetachInstancesFromLoadBalancer", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DetachInstancesFromLoadBalancerRequest": { - "type": "structure", - "members": { - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the Lightsail load balancer.

", - "smithy.api#required": {} - } - }, - "instanceNames": { - "target": "com.amazonaws.lightsail#ResourceNameList", - "traits": { - "smithy.api#documentation": "

An array of strings containing the names of the instances you want to detach from the load\n balancer.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#DetachInstancesFromLoadBalancerResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DetachStaticIp": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DetachStaticIpRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DetachStaticIpResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Detaches a static IP from the Amazon Lightsail instance to which it is attached.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DetachStaticIp", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DetachStaticIpRequest": { - "type": "structure", - "members": { - "staticIpName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the static IP to detach from the instance.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#DetachStaticIpResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#DisableAddOn": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DisableAddOnRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DisableAddOnResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Disables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DisableAddOn", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DisableAddOnRequest": { - "type": "structure", - "members": { - "addOnType": { - "target": "com.amazonaws.lightsail#AddOnType", - "traits": { - "smithy.api#documentation": "

The add-on type to disable.

", - "smithy.api#required": {} - } - }, - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the source resource for which to disable the add-on.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#DisableAddOnResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#Disk": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The unique name of the disk.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the disk.

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The date when the disk was created.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

The AWS Region and Availability Zone where the disk is located.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type (e.g., Disk).

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "addOns": { - "target": "com.amazonaws.lightsail#AddOnList", - "traits": { - "smithy.api#documentation": "

An array of objects representing the add-ons enabled on the disk.

" - } - }, - "sizeInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The size of the disk in GB.

" - } - }, - "isSystemDisk": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether this disk is a system disk (has an operating system\n loaded on it).

" - } - }, - "iops": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The input/output operations per second (IOPS) of the disk.

" - } - }, - "path": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The disk path.

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#DiskState", - "traits": { - "smithy.api#documentation": "

Describes the status of the disk.

" - } - }, - "attachedTo": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The resources to which the disk is attached.

" - } - }, - "isAttached": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the disk is attached.

" - } - }, - "attachmentState": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

(Deprecated) The attachment state of the disk.

\n \n

In releases prior to November 14, 2017, this parameter returned attached\n for system disks in the API response. It is now deprecated, but still included in the\n response. Use isAttached instead.

\n " - } - }, - "gbInUse": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

(Deprecated) The number of GB in use by the disk.

\n \n

In releases prior to November 14, 2017, this parameter was not included in the API\n response. It is now deprecated.

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

Describes a block storage disk.

" - } - }, - "com.amazonaws.lightsail#DiskInfo": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The disk name.

" - } - }, - "path": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The disk path.

" - } - }, - "sizeInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The size of the disk in GB (e.g., 32).

" - } - }, - "isSystemDisk": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether this disk is a system disk (has an operating system\n loaded on it).

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

Describes a disk.

" - } - }, - "com.amazonaws.lightsail#DiskInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#DiskInfo" - } - }, - "com.amazonaws.lightsail#DiskList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Disk" - } - }, - "com.amazonaws.lightsail#DiskMap": { - "type": "structure", - "members": { - "originalDiskPath": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The original disk path exposed to the instance (for example,\n /dev/sdh).

" - } - }, - "newDiskName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The new disk name (e.g., my-new-disk).

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

Describes a block storage disk mapping.

" - } - }, - "com.amazonaws.lightsail#DiskMapList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#DiskMap" - } - }, - "com.amazonaws.lightsail#DiskSnapshot": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the disk snapshot (e.g., my-disk-snapshot).

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the disk snapshot.

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The date when the disk snapshot was created.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

The AWS Region and Availability Zone where the disk snapshot was created.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type (e.g., DiskSnapshot).

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "sizeInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The size of the disk in GB.

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#DiskSnapshotState", - "traits": { - "smithy.api#documentation": "

The status of the disk snapshot operation.

" - } - }, - "progress": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The progress of the snapshot.

" - } - }, - "fromDiskName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The unique name of the source disk from which the disk snapshot was created.

" - } - }, - "fromDiskArn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was\n created.

" - } - }, - "fromInstanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The unique name of the source instance from which the disk (system volume) snapshot was\n created.

" - } - }, - "fromInstanceArn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source instance from which the disk (system volume)\n snapshot was created.

" - } - }, - "isFromAutoSnapshot": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the snapshot was created from an automatic\n snapshot.

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

Describes a block storage disk snapshot.

" - } - }, - "com.amazonaws.lightsail#DiskSnapshotInfo": { - "type": "structure", - "members": { - "sizeInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The size of the disk in GB (e.g., 32).

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

Describes a disk snapshot.

" - } - }, - "com.amazonaws.lightsail#DiskSnapshotList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#DiskSnapshot" - } - }, - "com.amazonaws.lightsail#DiskSnapshotState": { - "type": "enum", - "members": { - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "Completed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "completed" - } - }, - "Error": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "error" - } - }, - "Unknown": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unknown" - } - } - } - }, - "com.amazonaws.lightsail#DiskState": { - "type": "enum", - "members": { - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "Error": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "error" - } - }, - "Available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "InUse": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "in-use" - } - }, - "Unknown": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unknown" - } - } - } - }, - "com.amazonaws.lightsail#DistributionBundle": { - "type": "structure", - "members": { - "bundleId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The ID of the bundle.

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the distribution bundle.

" - } - }, - "price": { - "target": "com.amazonaws.lightsail#float", - "traits": { - "smithy.api#documentation": "

The monthly price, in US dollars, of the bundle.

" - } - }, - "transferPerMonthInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The monthly network transfer quota of the bundle.

" - } - }, - "isActive": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the bundle is active, and can be specified for a new or existing\n distribution.

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

Describes the specifications of a distribution bundle.

" - } - }, - "com.amazonaws.lightsail#DistributionBundleList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#DistributionBundle" - } - }, - "com.amazonaws.lightsail#DistributionList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#LightsailDistribution" - } - }, - "com.amazonaws.lightsail#DistributionMetricName": { - "type": "enum", - "members": { - "Requests": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Requests" - } - }, - "BytesDownloaded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BytesDownloaded" - } - }, - "BytesUploaded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BytesUploaded" - } - }, - "TotalErrorRate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TotalErrorRate" - } - }, - "Http4xxErrorRate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Http4xxErrorRate" - } - }, - "Http5xxErrorRate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Http5xxErrorRate" - } - } - } - }, - "com.amazonaws.lightsail#DnsRecordCreationState": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#DnsRecordCreationStateCode", - "traits": { - "smithy.api#documentation": "

The status code for the automated DNS record creation.

\n\n

Following are the possible values:

\n " - } - }, - "message": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The message that describes the reason for the status code.

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

Describes the creation state of the canonical name (CNAME) records that are automatically\n added by Amazon Lightsail to the DNS of a domain to validate domain ownership for\n an SSL/TLS certificate.

\n\n

When you create an SSL/TLS certificate for a Lightsail resource, you must\n add a set of CNAME records to the DNS of the domains for the certificate to validate that you\n own the domains. Lightsail can automatically add the CNAME records to the DNS\n of the domain if the DNS zone for the domain exists within your Lightsail\n account. If automatic record addition fails, or if you manage the DNS of your domain using a\n third-party service, then you must manually add the CNAME records to the DNS of your domain.\n For more information, see Verify an SSL/TLS certificate in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

" - } - }, - "com.amazonaws.lightsail#DnsRecordCreationStateCode": { - "type": "enum", - "members": { - "Succeeded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCEEDED" - } - }, - "Started": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTED" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.lightsail#Domain": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the domain.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the domain recordset (e.g.,\n arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE).

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The date when the domain recordset was created.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

The AWS Region and Availability Zones where the domain recordset was created.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The resource type.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "domainEntries": { - "target": "com.amazonaws.lightsail#DomainEntryList", - "traits": { - "smithy.api#documentation": "

An array of key-value pairs containing information about the domain entries.

" - } - }, - "registeredDomainDelegationInfo": { - "target": "com.amazonaws.lightsail#RegisteredDomainDelegationInfo", - "traits": { - "smithy.api#documentation": "

An object that describes the state of the RouteĀ 53 domain delegation to a\n Lightsail DNS zone.

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

Describes a domain where you are storing recordsets.

" - } - }, - "com.amazonaws.lightsail#DomainEntry": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the domain recordset entry.

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The name of the domain.

" - } - }, - "target": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The target IP address (e.g., 192.0.2.0), or AWS name server (e.g.,\n ns-111.awsdns-22.com.).

\n

For Lightsail load balancers, the value looks like\n ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. For\n Lightsail distributions, the value looks like exampled1182ne.cloudfront.net.\n For Lightsail container services, the value looks like\n container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com. Be sure to\n also set isAlias to true when setting up an A record for a\n Lightsail load balancer, distribution, or container service.

" - } - }, - "isAlias": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

When true, specifies whether the domain entry is an alias used by the\n Lightsail load balancer. You can include an alias (A type) record in your request, which\n points to a load balancer DNS name and routes traffic to your load balancer.

" - } - }, - "type": { - "target": "com.amazonaws.lightsail#DomainEntryType", - "traits": { - "smithy.api#documentation": "

The type of domain entry, such as address for IPv4 (A), address for IPv6 (AAAA), canonical\n name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator\n (SRV), or text (TXT).

\n

The following domain entry types can be used:

\n " - } - }, - "options": { - "target": "com.amazonaws.lightsail#DomainEntryOptions", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

(Deprecated) The options for the domain entry.

\n \n

In releases prior to November 29, 2017, this parameter was not included in the API\n response. It is now deprecated.

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

Describes a domain recordset entry.

" - } - }, - "com.amazonaws.lightsail#DomainEntryList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#DomainEntry" - } - }, - "com.amazonaws.lightsail#DomainEntryOptions": { - "type": "map", - "key": { - "target": "com.amazonaws.lightsail#DomainEntryOptionsKeys" - }, - "value": { - "target": "com.amazonaws.lightsail#string" - } - }, - "com.amazonaws.lightsail#DomainEntryOptionsKeys": { - "type": "string" - }, - "com.amazonaws.lightsail#DomainEntryType": { - "type": "string" - }, - "com.amazonaws.lightsail#DomainList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Domain" - } - }, - "com.amazonaws.lightsail#DomainName": { - "type": "string" - }, - "com.amazonaws.lightsail#DomainNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#DomainName" - } - }, - "com.amazonaws.lightsail#DomainValidationRecord": { - "type": "structure", - "members": { - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The domain name of the certificate validation record. For example,\n example.com or www.example.com.

" - } - }, - "resourceRecord": { - "target": "com.amazonaws.lightsail#ResourceRecord", - "traits": { - "smithy.api#documentation": "

An object that describes the DNS records to add to your domain's DNS to validate it for\n the certificate.

" - } - }, - "dnsRecordCreationState": { - "target": "com.amazonaws.lightsail#DnsRecordCreationState", - "traits": { - "smithy.api#documentation": "

An object that describes the state of the canonical name (CNAME) records that are\n automatically added by Lightsail to the DNS of the domain to validate domain\n ownership.

" - } - }, - "validationStatus": { - "target": "com.amazonaws.lightsail#CertificateDomainValidationStatus", - "traits": { - "smithy.api#documentation": "

The validation status of the record.

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

Describes the domain name system (DNS) records that you must add to the DNS of your\n registered domain to validate ownership for an Amazon Lightsail SSL/TLS certificate.

" - } - }, - "com.amazonaws.lightsail#DomainValidationRecordList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#DomainValidationRecord" - } - }, - "com.amazonaws.lightsail#DownloadDefaultKeyPair": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#DownloadDefaultKeyPairRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#DownloadDefaultKeyPairResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Downloads the regional Amazon Lightsail default key pair.

\n

This action also creates a Lightsail default key pair if a default key pair\n does not currently exist in the Amazon Web Services Region.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/DownloadDefaultKeyPair", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#DownloadDefaultKeyPairRequest": { - "type": "structure", - "members": {} - }, - "com.amazonaws.lightsail#DownloadDefaultKeyPairResult": { - "type": "structure", - "members": { - "publicKeyBase64": { - "target": "com.amazonaws.lightsail#Base64", - "traits": { - "smithy.api#documentation": "

A base64-encoded public key of the ssh-rsa type.

" - } - }, - "privateKeyBase64": { - "target": "com.amazonaws.lightsail#Base64", - "traits": { - "smithy.api#documentation": "

A base64-encoded RSA private key.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the default key pair was created.

" - } - } - } - }, - "com.amazonaws.lightsail#EligibleToRenew": { - "type": "string" - }, - "com.amazonaws.lightsail#EnableAddOn": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#EnableAddOnRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#EnableAddOnResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see\n the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/EnableAddOn", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#EnableAddOnRequest": { - "type": "structure", - "members": { - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the source resource for which to enable or modify the add-on.

", - "smithy.api#required": {} - } - }, - "addOnRequest": { - "target": "com.amazonaws.lightsail#AddOnRequest", - "traits": { - "smithy.api#documentation": "

An array of strings representing the add-on to enable or modify.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#EnableAddOnResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#EndpointRequest": { - "type": "structure", - "members": { - "containerName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the container for the endpoint.

", - "smithy.api#required": {} - } - }, - "containerPort": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The port of the container to which traffic is forwarded to.

", - "smithy.api#required": {} - } - }, - "healthCheck": { - "target": "com.amazonaws.lightsail#ContainerServiceHealthCheckConfig", - "traits": { - "smithy.api#documentation": "

An object that describes the health check configuration of the container.

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

Describes the settings of a public endpoint for an Amazon Lightsail container\n service.

" - } - }, - "com.amazonaws.lightsail#Environment": { - "type": "map", - "key": { - "target": "com.amazonaws.lightsail#string" - }, - "value": { - "target": "com.amazonaws.lightsail#string" - } - }, - "com.amazonaws.lightsail#ExportSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#ExportSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#ExportSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).\n This operation results in an export snapshot record that can be used with the create\n cloud formation stack operation to create new Amazon EC2 instances.

\n

Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the\n instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in\n Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in\n Amazon EC2 as the source Lightsail snapshot.

\n

\n

The export snapshot operation supports tag-based access control via resource\n tags applied to the resource identified by source snapshot name. For more\n information, see the Amazon Lightsail Developer Guide.

\n \n

Use the get instance snapshots or get disk snapshots\n operations to get a list of snapshots that you can export to Amazon EC2.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/ExportSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#ExportSnapshotRecord": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The export snapshot record name.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the export snapshot record.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The date when the export snapshot record was created.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

The AWS Region and Availability Zone where the export snapshot record is located.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type (e.g., ExportSnapshotRecord).

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#RecordState", - "traits": { - "smithy.api#documentation": "

The state of the export snapshot record.

" - } - }, - "sourceInfo": { - "target": "com.amazonaws.lightsail#ExportSnapshotRecordSourceInfo", - "traits": { - "smithy.api#documentation": "

A list of objects describing the source of the export snapshot record.

" - } - }, - "destinationInfo": { - "target": "com.amazonaws.lightsail#DestinationInfo", - "traits": { - "smithy.api#documentation": "

A list of objects describing the destination of the export snapshot record.

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

Describes an export snapshot record.

" - } - }, - "com.amazonaws.lightsail#ExportSnapshotRecordList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#ExportSnapshotRecord" - } - }, - "com.amazonaws.lightsail#ExportSnapshotRecordSourceInfo": { - "type": "structure", - "members": { - "resourceType": { - "target": "com.amazonaws.lightsail#ExportSnapshotRecordSourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type (e.g., InstanceSnapshot or\n DiskSnapshot).

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The date when the source instance or disk snapshot was created.

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the source instance or disk snapshot.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source instance or disk snapshot.

" - } - }, - "fromResourceName": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the snapshot's source instance or disk.

" - } - }, - "fromResourceArn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot's source instance or disk.

" - } - }, - "instanceSnapshotInfo": { - "target": "com.amazonaws.lightsail#InstanceSnapshotInfo", - "traits": { - "smithy.api#documentation": "

A list of objects describing an instance snapshot.

" - } - }, - "diskSnapshotInfo": { - "target": "com.amazonaws.lightsail#DiskSnapshotInfo", - "traits": { - "smithy.api#documentation": "

A list of objects describing a disk snapshot.

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

Describes the source of an export snapshot record.

" - } - }, - "com.amazonaws.lightsail#ExportSnapshotRecordSourceType": { - "type": "enum", - "members": { - "InstanceSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InstanceSnapshot" - } - }, - "DiskSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DiskSnapshot" - } - } - } - }, - "com.amazonaws.lightsail#ExportSnapshotRequest": { - "type": "structure", - "members": { - "sourceSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance or disk snapshot to be exported to Amazon EC2.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#ExportSnapshotResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#ForwardValues": { - "type": "enum", - "members": { - "none": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "none" - } - }, - "allowList": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "allow-list" - } - }, - "all": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "all" - } - } - } - }, - "com.amazonaws.lightsail#GetActiveNames": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetActiveNamesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetActiveNamesResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the names of all active (not deleted) resources.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetActiveNames", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetActiveNamesRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetActiveNames request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetActiveNamesResult": { - "type": "structure", - "members": { - "activeNames": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The list of active names returned by the get active names request.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetActiveNames request and\n specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetAlarms": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetAlarmsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetAlarmsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about the configured alarms. Specify an alarm name in your request to\n return information about a specific alarm, or specify a monitored resource name to return\n information about all alarms for a specific resource.

\n

An alarm is used to monitor a single metric for one of your resources. When a metric\n condition is met, the alarm can notify you by email, SMS text message, and a banner displayed\n on the Amazon Lightsail console. For more information, see Alarms\n in Amazon Lightsail.

", - "smithy.api#http": { - "method": "GET", - "uri": "/ls/api/2016-11-28/GetAlarms", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetAlarmsRequest": { - "type": "structure", - "members": { - "alarmName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the alarm.

\n

Specify an alarm name to return information about a specific alarm.

" - } - }, - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetAlarms request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" - } - }, - "monitoredResourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the Lightsail resource being monitored by the alarm.

\n

Specify a monitored resource name to return information about all alarms for a specific\n resource.

" - } - } - } - }, - "com.amazonaws.lightsail#GetAlarmsResult": { - "type": "structure", - "members": { - "alarms": { - "target": "com.amazonaws.lightsail#AlarmsList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the alarms.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetAlarms request and\n specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetAutoSnapshots": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetAutoSnapshotsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetAutoSnapshotsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the available automatic snapshots for an instance or disk. For more information,\n see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetAutoSnapshots", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetAutoSnapshotsRequest": { - "type": "structure", - "members": { - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the source instance or disk from which to get automatic snapshot\n information.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#GetAutoSnapshotsResult": { - "type": "structure", - "members": { - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the source instance or disk for the automatic snapshots.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The resource type (e.g., Instance or Disk).

" - } - }, - "autoSnapshots": { - "target": "com.amazonaws.lightsail#AutoSnapshotDetailsList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the automatic snapshots that are available for the\n specified source instance or disk.

" - } - } - } - }, - "com.amazonaws.lightsail#GetBlueprints": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetBlueprintsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetBlueprintsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the list of available instance images, or blueprints. You can\n use a blueprint to create a new instance already running a specific operating system, as well\n as a preinstalled app or development stack. The software each instance is running depends on\n the blueprint image you choose.

\n \n

Use active blueprints when creating new instances. Inactive blueprints are listed to\n support customers with existing instances and are not necessarily available to create new\n instances. Blueprints are marked inactive when they become outdated due to operating system\n updates or new application releases.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetBlueprints", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetBlueprintsRequest": { - "type": "structure", - "members": { - "includeInactive": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether to include inactive (unavailable) blueprints in the\n response of your request.

" - } - }, - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetBlueprints request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetBlueprintsResult": { - "type": "structure", - "members": { - "blueprints": { - "target": "com.amazonaws.lightsail#BlueprintList", - "traits": { - "smithy.api#documentation": "

An array of key-value pairs that contains information about the available\n blueprints.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetBlueprints request and\n specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetBucketAccessKeys": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetBucketAccessKeysRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetBucketAccessKeysResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the existing access key IDs for the specified Amazon Lightsail bucket.

\n\n \n

This action does not return the secret access key value of an access key. You can get a\n secret access key only when you create it from the response of the CreateBucketAccessKey action. If you lose the secret access key, you must create\n a new access key.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetBucketAccessKeys", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetBucketAccessKeysRequest": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.lightsail#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket for which to return access keys.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#GetBucketAccessKeysResult": { - "type": "structure", - "members": { - "accessKeys": { - "target": "com.amazonaws.lightsail#AccessKeyList", - "traits": { - "smithy.api#documentation": "

An object that describes the access keys for the specified bucket.

" - } - } - } - }, - "com.amazonaws.lightsail#GetBucketBundles": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetBucketBundlesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetBucketBundlesResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the bundles that you can apply to a Amazon Lightsail bucket.

\n\n

The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a\n bucket.

\n\n

Use the UpdateBucketBundle action to update the\n bundle for a bucket.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetBucketBundles", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetBucketBundlesRequest": { - "type": "structure", - "members": { - "includeInactive": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether to include inactive (unavailable) bundles in the\n response of your request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetBucketBundlesResult": { - "type": "structure", - "members": { - "bundles": { - "target": "com.amazonaws.lightsail#BucketBundleList", - "traits": { - "smithy.api#documentation": "

An object that describes bucket bundles.

" - } - } - } - }, - "com.amazonaws.lightsail#GetBucketMetricData": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetBucketMetricDataRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetBucketMetricDataResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the data points of a specific metric for an Amazon Lightsail bucket.

\n\n

Metrics report the utilization of a bucket. View and collect metric data regularly to\n monitor the number of objects stored in a bucket (including object versions) and the storage\n space used by those objects.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetBucketMetricData", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetBucketMetricDataRequest": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.lightsail#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket for which to get metric data.

", - "smithy.api#required": {} - } - }, - "metricName": { - "target": "com.amazonaws.lightsail#BucketMetricName", - "traits": { - "smithy.api#documentation": "

The metric for which you want to return information.

\n\n

Valid bucket metric names are listed below, along with the most useful statistics to\n include in your request, and the published unit value.

\n\n \n

These bucket metrics are reported once per day.

\n \n\n ", - "smithy.api#required": {} - } - }, - "startTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp indicating the earliest data to be returned.

", - "smithy.api#required": {} - } - }, - "endTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp indicating the latest data to be returned.

", - "smithy.api#required": {} - } - }, - "period": { - "target": "com.amazonaws.lightsail#MetricPeriod", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

\n \n

Bucket storage metrics are reported once per day. Therefore, you should specify a period\n of 86400 seconds, which is the number of seconds in a day.

\n ", - "smithy.api#required": {} - } - }, - "statistics": { - "target": "com.amazonaws.lightsail#MetricStatisticList", - "traits": { - "smithy.api#documentation": "

The statistic for the metric.

\n\n

The following statistics are available:

\n\n ", - "smithy.api#required": {} - } - }, - "unit": { - "target": "com.amazonaws.lightsail#MetricUnit", - "traits": { - "smithy.api#documentation": "

The unit for the metric data request.

\n

Valid units depend on the metric data being requested. For the valid units with each\n available metric, see the metricName parameter.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#GetBucketMetricDataResult": { - "type": "structure", - "members": { - "metricName": { - "target": "com.amazonaws.lightsail#BucketMetricName", - "traits": { - "smithy.api#documentation": "

The name of the metric returned.

" - } - }, - "metricData": { - "target": "com.amazonaws.lightsail#MetricDatapointList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" - } - } - } - }, - "com.amazonaws.lightsail#GetBuckets": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetBucketsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetBucketsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about one or more Amazon Lightsail buckets. The information returned\n includes the synchronization status of the Amazon Simple Storage Service (Amazon S3)\n account-level block public access feature for your Lightsail buckets.

\n\n

For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer\n Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetBuckets", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetBucketsRequest": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.lightsail#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket for which to return information.

\n\n

When omitted, the response includes all of your buckets in the Amazon Web Services Region\n where the request is made.

" - } - }, - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n\n

To get a page token, perform an initial GetBuckets request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" - } - }, - "includeConnectedResources": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether to include Lightsail instances that were given\n access to the bucket using the SetResourceAccessForBucket\n action.

" - } - } - } - }, - "com.amazonaws.lightsail#GetBucketsResult": { - "type": "structure", - "members": { - "buckets": { - "target": "com.amazonaws.lightsail#BucketList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe buckets.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n\n

A next page token is not returned if there are no more results to display.

\n\n

To get the next page of results, perform another GetBuckets request and\n specify the next page token using the pageToken parameter.

" - } - }, - "accountLevelBpaSync": { - "target": "com.amazonaws.lightsail#AccountLevelBpaSync", - "traits": { - "smithy.api#documentation": "

An object that describes the synchronization status of the Amazon S3 account-level\n block public access feature for your Lightsail buckets.

\n\n

For more information about this feature and how it affects Lightsail buckets, see Block public access for buckets in Amazon Lightsail.

" - } - } - } - }, - "com.amazonaws.lightsail#GetBundles": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetBundlesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetBundlesResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the bundles that you can apply to an Amazon Lightsail instance when you create\n it.

\n\n

A bundle describes the specifications of an instance, such as the monthly cost, amount of\n memory, the number of vCPUs, amount of storage space, and monthly network data transfer\n quota.

\n\n \n

Bundles are referred to as instance plans in the Lightsail\n console.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetBundles", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetBundlesRequest": { - "type": "structure", - "members": { - "includeInactive": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether to include inactive (unavailable) bundles in the\n response of your request.

" - } - }, - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetBundles request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetBundlesResult": { - "type": "structure", - "members": { - "bundles": { - "target": "com.amazonaws.lightsail#BundleList", - "traits": { - "smithy.api#documentation": "

An array of key-value pairs that contains information about the available bundles.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetBundles request and\n specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetCertificates": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetCertificatesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetCertificatesResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about one or more Amazon Lightsail SSL/TLS certificates.

\n \n

To get a summary of a certificate, ommit includeCertificateDetails from\n your request. The response will include only the certificate Amazon Resource Name (ARN),\n certificate name, domain name, and tags.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetCertificates", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetCertificatesRequest": { - "type": "structure", - "members": { - "certificateStatuses": { - "target": "com.amazonaws.lightsail#CertificateStatusList", - "traits": { - "smithy.api#documentation": "

The status of the certificates for which to return information.

\n

For example, specify ISSUED to return only certificates with an\n ISSUED status.

\n

When omitted, the response includes all of your certificates in the Amazon Web Services\n Region where the request is made, regardless of their current status.

" - } - }, - "includeCertificateDetails": { - "target": "com.amazonaws.lightsail#IncludeCertificateDetails", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether to include detailed information about the certificates in the\n response.

\n

When omitted, the response includes only the certificate names, Amazon Resource Names\n (ARNs), domain names, and tags.

" - } - }, - "certificateName": { - "target": "com.amazonaws.lightsail#CertificateName", - "traits": { - "smithy.api#documentation": "

The name for the certificate for which to return information.

\n

When omitted, the response includes all of your certificates in the Amazon Web Services\n Region where the request is made.

" - } - } - } - }, - "com.amazonaws.lightsail#GetCertificatesResult": { - "type": "structure", - "members": { - "certificates": { - "target": "com.amazonaws.lightsail#CertificateSummaryList", - "traits": { - "smithy.api#documentation": "

An object that describes certificates.

" - } - } - } - }, - "com.amazonaws.lightsail#GetCloudFormationStackRecords": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetCloudFormationStackRecordsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetCloudFormationStackRecordsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the CloudFormation stack record created as a result of the create cloud\n formation stack operation.

\n

An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail\n snapshot.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetCloudFormationStackRecords", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetCloudFormationStackRecordsRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetClouFormationStackRecords request.\n If your results are paginated, the response will return a next page token that you can specify\n as the page token in a subsequent request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetCloudFormationStackRecordsResult": { - "type": "structure", - "members": { - "cloudFormationStackRecords": { - "target": "com.amazonaws.lightsail#CloudFormationStackRecordList", - "traits": { - "smithy.api#documentation": "

A list of objects describing the CloudFormation stack records.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another\n GetCloudFormationStackRecords request and specify the next page token using the\n pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetContactMethods": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetContactMethodsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetContactMethodsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about the configured contact methods. Specify a protocol in your\n request to return information about a specific contact method.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services\n Regions, and SMS text messages cannot be sent to some countries/regions. For more information,\n see Notifications in Amazon Lightsail.

", - "smithy.api#http": { - "method": "GET", - "uri": "/ls/api/2016-11-28/GetContactMethods", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetContactMethodsRequest": { - "type": "structure", - "members": { - "protocols": { - "target": "com.amazonaws.lightsail#ContactProtocolsList", - "traits": { - "smithy.api#documentation": "

The protocols used to send notifications, such as Email, or SMS\n (text messaging).

\n

Specify a protocol in your request to return information about a specific contact method\n protocol.

" - } - } - } - }, - "com.amazonaws.lightsail#GetContactMethodsResult": { - "type": "structure", - "members": { - "contactMethods": { - "target": "com.amazonaws.lightsail#ContactMethodsList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the contact methods.

" - } - } - } - }, - "com.amazonaws.lightsail#GetContainerAPIMetadata": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetContainerAPIMetadataRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetContainerAPIMetadataResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about Amazon Lightsail containers, such as the current version of the\n Lightsail Control (lightsailctl) plugin.

", - "smithy.api#http": { - "method": "GET", - "uri": "/ls/api/2016-11-28/container-api-metadata", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetContainerAPIMetadataRequest": { - "type": "structure", - "members": {} - }, - "com.amazonaws.lightsail#GetContainerAPIMetadataResult": { - "type": "structure", - "members": { - "metadata": { - "target": "com.amazonaws.lightsail#ContainerServiceMetadataEntryList", - "traits": { - "smithy.api#documentation": "

Metadata about Lightsail containers, such as the current version of the Lightsail\n Control (lightsailctl) plugin.

" - } - } - } - }, - "com.amazonaws.lightsail#GetContainerImages": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetContainerImagesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetContainerImagesResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the container images that are registered to your Amazon Lightsail container\n service.

\n\n \n

If you created a deployment on your Lightsail container service that uses container\n images from a public registry like Docker Hub, those images are not returned as part of this\n action. Those images are not registered to your Lightsail container service.

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/ls/api/2016-11-28/container-services/{serviceName}/images", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetContainerImagesRequest": { - "type": "structure", - "members": { - "serviceName": { - "target": "com.amazonaws.lightsail#ContainerServiceName", - "traits": { - "smithy.api#documentation": "

The name of the container service for which to return registered container images.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#GetContainerImagesResult": { - "type": "structure", - "members": { - "containerImages": { - "target": "com.amazonaws.lightsail#ContainerImageList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe container images that are registered to the container\n service.

" - } - } - } - }, - "com.amazonaws.lightsail#GetContainerLog": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetContainerLogRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetContainerLogResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the log events of a container of your Amazon Lightsail container service.

\n\n

If your container service has more than one node (i.e., a scale greater than 1), then the\n log events that are returned for the specified container are merged from all nodes on your\n container service.

\n\n \n

Container logs are retained for a certain amount of time. For more information, see\n Amazon Lightsail\n endpoints and quotas in the Amazon Web Services General\n Reference.

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/ls/api/2016-11-28/container-services/{serviceName}/containers/{containerName}/log", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetContainerLogRequest": { - "type": "structure", - "members": { - "serviceName": { - "target": "com.amazonaws.lightsail#ContainerServiceName", - "traits": { - "smithy.api#documentation": "

The name of the container service for which to get a container log.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "containerName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the container that is either running or previously ran on the container\n service for which to return a log.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "startTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The start of the time interval for which to get log data.

\n\n

Constraints:

\n\n \n\n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", - "smithy.api#httpQuery": "startTime" - } - }, - "endTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The end of the time interval for which to get log data.

\n\n

Constraints:

\n\n \n\n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", - "smithy.api#httpQuery": "endTime" - } - }, - "filterPattern": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The pattern to use to filter the returned log events to a specific term.

\n\n

The following are a few examples of filter patterns that you can specify:

\n ", - "smithy.api#httpQuery": "filterPattern" - } - }, - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n\n

To get a page token, perform an initial GetContainerLog request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

", - "smithy.api#httpQuery": "pageToken" - } - } - } - }, - "com.amazonaws.lightsail#GetContainerLogResult": { - "type": "structure", - "members": { - "logEvents": { - "target": "com.amazonaws.lightsail#ContainerServiceLogEventList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the log events of a container.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n\n

A next page token is not returned if there are no more results to display.

\n\n

To get the next page of results, perform another GetContainerLog request and\n specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetContainerServiceDeployments": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetContainerServiceDeploymentsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetContainerServiceDeploymentsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the deployments for your Amazon Lightsail container service

\n\n

A deployment specifies the settings, such as the ports and launch command, of containers\n that are deployed to your container service.

\n\n

The deployments are ordered by version in ascending order. The newest version is listed at\n the top of the response.

\n\n \n

A set number of deployments are kept before the oldest one is replaced with the newest\n one. For more information, see Amazon Lightsail\n endpoints and quotas in the Amazon Web Services General\n Reference.

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/ls/api/2016-11-28/container-services/{serviceName}/deployments", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetContainerServiceDeploymentsRequest": { - "type": "structure", - "members": { - "serviceName": { - "target": "com.amazonaws.lightsail#ContainerServiceName", - "traits": { - "smithy.api#documentation": "

The name of the container service for which to return deployments.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#GetContainerServiceDeploymentsResult": { - "type": "structure", - "members": { - "deployments": { - "target": "com.amazonaws.lightsail#ContainerServiceDeploymentList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe deployments for a container service.

" - } - } - } - }, - "com.amazonaws.lightsail#GetContainerServiceMetricData": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetContainerServiceMetricDataRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetContainerServiceMetricDataResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the data points of a specific metric of your Amazon Lightsail container\n service.

\n\n

Metrics report the utilization of your resources. Monitor and collect metric data\n regularly to maintain the reliability, availability, and performance of your resources.

", - "smithy.api#http": { - "method": "GET", - "uri": "/ls/api/2016-11-28/container-services/{serviceName}/metrics", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetContainerServiceMetricDataRequest": { - "type": "structure", - "members": { - "serviceName": { - "target": "com.amazonaws.lightsail#ContainerServiceName", - "traits": { - "smithy.api#documentation": "

The name of the container service for which to get metric data.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "metricName": { - "target": "com.amazonaws.lightsail#ContainerServiceMetricName", - "traits": { - "smithy.api#documentation": "

The metric for which you want to return information.

\n\n

Valid container service metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit value.

\n\n ", - "smithy.api#httpQuery": "metricName", - "smithy.api#required": {} - } - }, - "startTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The start time of the time period.

", - "smithy.api#httpQuery": "startTime", - "smithy.api#required": {} - } - }, - "endTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The end time of the time period.

", - "smithy.api#httpQuery": "endTime", - "smithy.api#required": {} - } - }, - "period": { - "target": "com.amazonaws.lightsail#MetricPeriod", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

\n\n

All container service metric data is available in 5-minute (300 seconds)\n granularity.

", - "smithy.api#httpQuery": "period", - "smithy.api#required": {} - } - }, - "statistics": { - "target": "com.amazonaws.lightsail#MetricStatisticList", - "traits": { - "smithy.api#documentation": "

The statistic for the metric.

\n\n

The following statistics are available:

\n\n ", - "smithy.api#httpQuery": "statistics", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#GetContainerServiceMetricDataResult": { - "type": "structure", - "members": { - "metricName": { - "target": "com.amazonaws.lightsail#ContainerServiceMetricName", - "traits": { - "smithy.api#documentation": "

The name of the metric returned.

" - } - }, - "metricData": { - "target": "com.amazonaws.lightsail#MetricDatapointList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" - } - } - } - }, - "com.amazonaws.lightsail#GetContainerServicePowers": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetContainerServicePowersRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetContainerServicePowersResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the list of powers that can be specified for your Amazon Lightsail container\n services.

\n\n

The power specifies the amount of memory, the number of vCPUs, and the base price of the\n container service.

", - "smithy.api#http": { - "method": "GET", - "uri": "/ls/api/2016-11-28/container-service-powers", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetContainerServicePowersRequest": { - "type": "structure", - "members": {} - }, - "com.amazonaws.lightsail#GetContainerServicePowersResult": { - "type": "structure", - "members": { - "powers": { - "target": "com.amazonaws.lightsail#ContainerServicePowerList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the powers that can be specified for a container\n service.

" - } - } - } - }, - "com.amazonaws.lightsail#GetContainerServices": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetContainerServicesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#ContainerServicesListResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about one or more of your Amazon Lightsail container services.

", - "smithy.api#http": { - "method": "GET", - "uri": "/ls/api/2016-11-28/container-services", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetContainerServicesRequest": { - "type": "structure", - "members": { - "serviceName": { - "target": "com.amazonaws.lightsail#ContainerServiceName", - "traits": { - "smithy.api#documentation": "

The name of the container service for which to return information.

\n\n

When omitted, the response includes all of your container services in the Amazon Web Services Region where the request is made.

", - "smithy.api#httpQuery": "serviceName" - } - } - } - }, - "com.amazonaws.lightsail#GetDisk": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetDiskRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetDiskResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a specific block storage disk.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetDisk", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetDiskRequest": { - "type": "structure", - "members": { - "diskName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the disk (e.g., my-disk).

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#GetDiskResult": { - "type": "structure", - "members": { - "disk": { - "target": "com.amazonaws.lightsail#Disk", - "traits": { - "smithy.api#documentation": "

An object containing information about the disk.

" - } - } - } - }, - "com.amazonaws.lightsail#GetDiskSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetDiskSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetDiskSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a specific block storage disk snapshot.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetDiskSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetDiskSnapshotRequest": { - "type": "structure", - "members": { - "diskSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the disk snapshot (e.g., my-disk-snapshot).

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#GetDiskSnapshotResult": { - "type": "structure", - "members": { - "diskSnapshot": { - "target": "com.amazonaws.lightsail#DiskSnapshot", - "traits": { - "smithy.api#documentation": "

An object containing information about the disk snapshot.

" - } - } - } - }, - "com.amazonaws.lightsail#GetDiskSnapshots": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetDiskSnapshotsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetDiskSnapshotsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about all block storage disk snapshots in your AWS account and\n region.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetDiskSnapshots", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetDiskSnapshotsRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetDiskSnapshots request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetDiskSnapshotsResult": { - "type": "structure", - "members": { - "diskSnapshots": { - "target": "com.amazonaws.lightsail#DiskSnapshotList", - "traits": { - "smithy.api#documentation": "

An array of objects containing information about all block storage disk snapshots.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetDiskSnapshots request and\n specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetDisks": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetDisksRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetDisksResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about all block storage disks in your AWS account and region.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetDisks", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetDisksRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetDisks request. If your results are\n paginated, the response will return a next page token that you can specify as the page token\n in a subsequent request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetDisksResult": { - "type": "structure", - "members": { - "disks": { - "target": "com.amazonaws.lightsail#DiskList", - "traits": { - "smithy.api#documentation": "

An array of objects containing information about all block storage disks.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetDisks request and specify\n the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetDistributionBundles": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetDistributionBundlesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetDistributionBundlesResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the bundles that can be applied to your Amazon Lightsail content delivery network\n (CDN) distributions.

\n

A distribution bundle specifies the monthly network transfer quota and monthly cost of\n your distribution.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetDistributionBundles", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetDistributionBundlesRequest": { - "type": "structure", - "members": {} - }, - "com.amazonaws.lightsail#GetDistributionBundlesResult": { - "type": "structure", - "members": { - "bundles": { - "target": "com.amazonaws.lightsail#DistributionBundleList", - "traits": { - "smithy.api#documentation": "

An object that describes a distribution bundle.

" - } - } - } - }, - "com.amazonaws.lightsail#GetDistributionLatestCacheReset": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetDistributionLatestCacheResetRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetDistributionLatestCacheResetResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail\n content delivery network (CDN) distribution.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetDistributionLatestCacheReset", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetDistributionLatestCacheResetRequest": { - "type": "structure", - "members": { - "distributionName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the distribution for which to return the timestamp of the last cache\n reset.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

\n

When omitted, the response includes the latest cache reset timestamp of all your\n distributions.

" - } - } - } - }, - "com.amazonaws.lightsail#GetDistributionLatestCacheResetResult": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The status of the last cache reset.

" - } - }, - "createTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp of the last cache reset (e.g., 1479734909.17) in Unix time\n format.

" - } - } - } - }, - "com.amazonaws.lightsail#GetDistributionMetricData": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetDistributionMetricDataRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetDistributionMetricDataResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the data points of a specific metric for an Amazon Lightsail content delivery\n network (CDN) distribution.

\n

Metrics report the utilization of your resources, and the error counts generated by them.\n Monitor and collect metric data regularly to maintain the reliability, availability, and\n performance of your resources.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetDistributionMetricData", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetDistributionMetricDataRequest": { - "type": "structure", - "members": { - "distributionName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the distribution for which to get metric data.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

", - "smithy.api#required": {} - } - }, - "metricName": { - "target": "com.amazonaws.lightsail#DistributionMetricName", - "traits": { - "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid distribution metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value.

\n ", - "smithy.api#required": {} - } - }, - "startTime": { - "target": "com.amazonaws.lightsail#timestamp", - "traits": { - "smithy.api#documentation": "

The start of the time interval for which to get metric data.

\n

Constraints:

\n \n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", - "smithy.api#required": {} - } - }, - "endTime": { - "target": "com.amazonaws.lightsail#timestamp", - "traits": { - "smithy.api#documentation": "

The end of the time interval for which to get metric data.

\n

Constraints:

\n \n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", - "smithy.api#required": {} - } - }, - "period": { - "target": "com.amazonaws.lightsail#MetricPeriod", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The granularity, in seconds, for the metric data points that will be returned.

", - "smithy.api#required": {} - } - }, - "unit": { - "target": "com.amazonaws.lightsail#MetricUnit", - "traits": { - "smithy.api#documentation": "

The unit for the metric data request.

\n

Valid units depend on the metric data being requested. For the valid units with each\n available metric, see the metricName parameter.

", - "smithy.api#required": {} - } - }, - "statistics": { - "target": "com.amazonaws.lightsail#MetricStatisticList", - "traits": { - "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#GetDistributionMetricDataResult": { - "type": "structure", - "members": { - "metricName": { - "target": "com.amazonaws.lightsail#DistributionMetricName", - "traits": { - "smithy.api#documentation": "

The name of the metric returned.

" - } - }, - "metricData": { - "target": "com.amazonaws.lightsail#MetricDatapointList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" - } - } - } - }, - "com.amazonaws.lightsail#GetDistributions": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetDistributionsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetDistributionsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about one or more of your Amazon Lightsail content delivery network\n (CDN) distributions.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetDistributions", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetDistributionsRequest": { - "type": "structure", - "members": { - "distributionName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the distribution for which to return information.

\n \n

When omitted, the response includes all of your distributions in the Amazon Web Services\n Region where the request is made.

" - } - }, - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetDistributions request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetDistributionsResult": { - "type": "structure", - "members": { - "distributions": { - "target": "com.amazonaws.lightsail#DistributionList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe your distributions.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetDistributions request and\n specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetDomain": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetDomainRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetDomainResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a specific domain recordset.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetDomain", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetDomainRequest": { - "type": "structure", - "members": { - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The domain name for which your want to return information about.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#GetDomainResult": { - "type": "structure", - "members": { - "domain": { - "target": "com.amazonaws.lightsail#Domain", - "traits": { - "smithy.api#documentation": "

An array of key-value pairs containing information about your get domain request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetDomains": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetDomainsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetDomainsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of all domains in the user's account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetDomains", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetDomainsRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetDomains request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetDomainsResult": { - "type": "structure", - "members": { - "domains": { - "target": "com.amazonaws.lightsail#DomainList", - "traits": { - "smithy.api#documentation": "

An array of key-value pairs containing information about each of the domain entries in the\n user's account.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetDomains request and\n specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetExportSnapshotRecords": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetExportSnapshotRecordsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetExportSnapshotRecordsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns all export snapshot records created as a result of the export\n snapshot operation.

\n

An export snapshot record can be used to create a new Amazon EC2 instance and its related\n resources with the CreateCloudFormationStack\n action.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetExportSnapshotRecords", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetExportSnapshotRecordsRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetExportSnapshotRecords request. If\n your results are paginated, the response will return a next page token that you can specify as\n the page token in a subsequent request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetExportSnapshotRecordsResult": { - "type": "structure", - "members": { - "exportSnapshotRecords": { - "target": "com.amazonaws.lightsail#ExportSnapshotRecordList", - "traits": { - "smithy.api#documentation": "

A list of objects describing the export snapshot records.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetExportSnapshotRecords\n request and specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetInstanceRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetInstanceResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a specific Amazon Lightsail instance, which is a virtual private\n server.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetInstance", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetInstanceAccessDetails": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetInstanceAccessDetailsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetInstanceAccessDetailsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns temporary SSH keys you can use to connect to a specific virtual private server, or\n instance.

\n

The get instance access details operation supports tag-based access control\n via resource tags applied to the resource identified by instance name. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetInstanceAccessDetails", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetInstanceAccessDetailsRequest": { - "type": "structure", - "members": { - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance to access.

", - "smithy.api#required": {} - } - }, - "protocol": { - "target": "com.amazonaws.lightsail#InstanceAccessProtocol", - "traits": { - "smithy.api#documentation": "

The protocol to use to connect to your instance. Defaults to ssh.

" - } - } - } - }, - "com.amazonaws.lightsail#GetInstanceAccessDetailsResult": { - "type": "structure", - "members": { - "accessDetails": { - "target": "com.amazonaws.lightsail#InstanceAccessDetails", - "traits": { - "smithy.api#documentation": "

An array of key-value pairs containing information about a get instance access\n request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetInstanceMetricData": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetInstanceMetricDataRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetInstanceMetricDataResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the data points for the specified Amazon Lightsail instance metric, given an\n instance name.

\n

Metrics report the utilization of your resources, and the error counts generated by them.\n Monitor and collect metric data regularly to maintain the reliability, availability, and\n performance of your resources.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetInstanceMetricData", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetInstanceMetricDataRequest": { - "type": "structure", - "members": { - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance for which you want to get metrics data.

", - "smithy.api#required": {} - } - }, - "metricName": { - "target": "com.amazonaws.lightsail#InstanceMetricName", - "traits": { - "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid instance metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value.

\n ", - "smithy.api#required": {} - } - }, - "period": { - "target": "com.amazonaws.lightsail#MetricPeriod", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

\n

The StatusCheckFailed, StatusCheckFailed_Instance, and\n StatusCheckFailed_System instance metric data is available in 1-minute (60\n seconds) granularity. All other instance metric data is available in 5-minute (300 seconds)\n granularity.

", - "smithy.api#required": {} - } - }, - "startTime": { - "target": "com.amazonaws.lightsail#timestamp", - "traits": { - "smithy.api#documentation": "

The start time of the time period.

", - "smithy.api#required": {} - } - }, - "endTime": { - "target": "com.amazonaws.lightsail#timestamp", - "traits": { - "smithy.api#documentation": "

The end time of the time period.

", - "smithy.api#required": {} - } - }, - "unit": { - "target": "com.amazonaws.lightsail#MetricUnit", - "traits": { - "smithy.api#documentation": "

The unit for the metric data request. Valid units depend on the metric data being\n requested. For the valid units to specify with each available metric, see the\n metricName parameter.

", - "smithy.api#required": {} - } - }, - "statistics": { - "target": "com.amazonaws.lightsail#MetricStatisticList", - "traits": { - "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#GetInstanceMetricDataResult": { - "type": "structure", - "members": { - "metricName": { - "target": "com.amazonaws.lightsail#InstanceMetricName", - "traits": { - "smithy.api#documentation": "

The name of the metric returned.

" - } - }, - "metricData": { - "target": "com.amazonaws.lightsail#MetricDatapointList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" - } - } - } - }, - "com.amazonaws.lightsail#GetInstancePortStates": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetInstancePortStatesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetInstancePortStatesResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses\n allowed to connect to the instance through the ports, and the protocol.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetInstancePortStates", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetInstancePortStatesRequest": { - "type": "structure", - "members": { - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance for which to return firewall port states.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#GetInstancePortStatesResult": { - "type": "structure", - "members": { - "portStates": { - "target": "com.amazonaws.lightsail#InstancePortStateList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the firewall port states for the specified\n instance.

" - } - } - } - }, - "com.amazonaws.lightsail#GetInstanceRequest": { - "type": "structure", - "members": { - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#GetInstanceResult": { - "type": "structure", - "members": { - "instance": { - "target": "com.amazonaws.lightsail#Instance", - "traits": { - "smithy.api#documentation": "

An array of key-value pairs containing information about the specified instance.

" - } - } - } - }, - "com.amazonaws.lightsail#GetInstanceSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetInstanceSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetInstanceSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a specific instance snapshot.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetInstanceSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetInstanceSnapshotRequest": { - "type": "structure", - "members": { - "instanceSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the snapshot for which you are requesting information.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#GetInstanceSnapshotResult": { - "type": "structure", - "members": { - "instanceSnapshot": { - "target": "com.amazonaws.lightsail#InstanceSnapshot", - "traits": { - "smithy.api#documentation": "

An array of key-value pairs containing information about the results of your get instance\n snapshot request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetInstanceSnapshots": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetInstanceSnapshotsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetInstanceSnapshotsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns all instance snapshots for the user's account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetInstanceSnapshots", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetInstanceSnapshotsRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetInstanceSnapshots request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetInstanceSnapshotsResult": { - "type": "structure", - "members": { - "instanceSnapshots": { - "target": "com.amazonaws.lightsail#InstanceSnapshotList", - "traits": { - "smithy.api#documentation": "

An array of key-value pairs containing information about the results of your get instance\n snapshots request.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetInstanceSnapshots request\n and specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetInstanceState": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetInstanceStateRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetInstanceStateResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the state of a specific instance. Works on one instance at a time.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetInstanceState", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetInstanceStateRequest": { - "type": "structure", - "members": { - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance to get state information about.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#GetInstanceStateResult": { - "type": "structure", - "members": { - "state": { - "target": "com.amazonaws.lightsail#InstanceState", - "traits": { - "smithy.api#documentation": "

The state of the instance.

" - } - } - } - }, - "com.amazonaws.lightsail#GetInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetInstancesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetInstancesResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about all Amazon Lightsail virtual private servers, or\n instances.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetInstances", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetInstancesRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetInstances request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetInstancesResult": { - "type": "structure", - "members": { - "instances": { - "target": "com.amazonaws.lightsail#InstanceList", - "traits": { - "smithy.api#documentation": "

An array of key-value pairs containing information about your instances.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetInstances request and\n specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetKeyPair": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetKeyPairRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetKeyPairResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a specific key pair.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetKeyPair", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetKeyPairRequest": { - "type": "structure", - "members": { - "keyPairName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the key pair for which you are requesting information.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#GetKeyPairResult": { - "type": "structure", - "members": { - "keyPair": { - "target": "com.amazonaws.lightsail#KeyPair", - "traits": { - "smithy.api#documentation": "

An array of key-value pairs containing information about the key pair.

" - } - } - } - }, - "com.amazonaws.lightsail#GetKeyPairs": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetKeyPairsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetKeyPairsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about all key pairs in the user's account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetKeyPairs", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetKeyPairsRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetKeyPairs request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" - } - }, - "includeDefaultKeyPair": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether to include the default key pair in the response of\n your request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetKeyPairsResult": { - "type": "structure", - "members": { - "keyPairs": { - "target": "com.amazonaws.lightsail#KeyPairList", - "traits": { - "smithy.api#documentation": "

An array of key-value pairs containing information about the key pairs.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetKeyPairs request and\n specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetLoadBalancer": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetLoadBalancerRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetLoadBalancerResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about the specified Lightsail load balancer.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetLoadBalancer", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetLoadBalancerMetricData": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetLoadBalancerMetricDataRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetLoadBalancerMetricDataResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about health metrics for your Lightsail load balancer.

\n

Metrics report the utilization of your resources, and the error counts generated by them.\n Monitor and collect metric data regularly to maintain the reliability, availability, and\n performance of your resources.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetLoadBalancerMetricData", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetLoadBalancerMetricDataRequest": { - "type": "structure", - "members": { - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the load balancer.

", - "smithy.api#required": {} - } - }, - "metricName": { - "target": "com.amazonaws.lightsail#LoadBalancerMetricName", - "traits": { - "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid load balancer metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value.

\n ", - "smithy.api#required": {} - } - }, - "period": { - "target": "com.amazonaws.lightsail#MetricPeriod", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

", - "smithy.api#required": {} - } - }, - "startTime": { - "target": "com.amazonaws.lightsail#timestamp", - "traits": { - "smithy.api#documentation": "

The start time of the period.

", - "smithy.api#required": {} - } - }, - "endTime": { - "target": "com.amazonaws.lightsail#timestamp", - "traits": { - "smithy.api#documentation": "

The end time of the period.

", - "smithy.api#required": {} - } - }, - "unit": { - "target": "com.amazonaws.lightsail#MetricUnit", - "traits": { - "smithy.api#documentation": "

The unit for the metric data request. Valid units depend on the metric data being\n requested. For the valid units with each available metric, see the metricName\n parameter.

", - "smithy.api#required": {} - } - }, - "statistics": { - "target": "com.amazonaws.lightsail#MetricStatisticList", - "traits": { - "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#GetLoadBalancerMetricDataResult": { - "type": "structure", - "members": { - "metricName": { - "target": "com.amazonaws.lightsail#LoadBalancerMetricName", - "traits": { - "smithy.api#documentation": "

The name of the metric returned.

" - } - }, - "metricData": { - "target": "com.amazonaws.lightsail#MetricDatapointList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" - } - } - } - }, - "com.amazonaws.lightsail#GetLoadBalancerRequest": { - "type": "structure", - "members": { - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the load balancer.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#GetLoadBalancerResult": { - "type": "structure", - "members": { - "loadBalancer": { - "target": "com.amazonaws.lightsail#LoadBalancer", - "traits": { - "smithy.api#documentation": "

An object containing information about your load balancer.

" - } - } - } - }, - "com.amazonaws.lightsail#GetLoadBalancerTlsCertificates": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetLoadBalancerTlsCertificatesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetLoadBalancerTlsCertificatesResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about the TLS certificates that are associated with the specified\n Lightsail load balancer.

\n

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

\n

You can have a maximum of 2 certificates associated with a Lightsail load balancer. One\n is active and the other is inactive.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetLoadBalancerTlsCertificates", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetLoadBalancerTlsCertificatesRequest": { - "type": "structure", - "members": { - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the load balancer you associated with your SSL/TLS certificate.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#GetLoadBalancerTlsCertificatesResult": { - "type": "structure", - "members": { - "tlsCertificates": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateList", - "traits": { - "smithy.api#documentation": "

An array of LoadBalancerTlsCertificate objects describing your SSL/TLS\n certificates.

" - } - } - } - }, - "com.amazonaws.lightsail#GetLoadBalancerTlsPolicies": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetLoadBalancerTlsPoliciesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetLoadBalancerTlsPoliciesResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of TLS security policies that you can apply to Lightsail load\n balancers.

\n\n

For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load\n balancers in the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetLoadBalancerTlsPolicies", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetLoadBalancerTlsPoliciesRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n\n

To get a page token, perform an initial GetLoadBalancerTlsPolicies request.\n If your results are paginated, the response will return a next page token that you can specify\n as the page token in a subsequent request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetLoadBalancerTlsPoliciesResult": { - "type": "structure", - "members": { - "tlsPolicies": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsPolicyList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the TLS security policies that are available.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n\n

A next page token is not returned if there are no more results to display.

\n\n

To get the next page of results, perform another GetLoadBalancerTlsPolicies\n request and specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetLoadBalancers": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetLoadBalancersRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetLoadBalancersResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about all load balancers in an account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetLoadBalancers", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetLoadBalancersRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetLoadBalancers request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetLoadBalancersResult": { - "type": "structure", - "members": { - "loadBalancers": { - "target": "com.amazonaws.lightsail#LoadBalancerList", - "traits": { - "smithy.api#documentation": "

An array of LoadBalancer objects describing your load balancers.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetLoadBalancers request and\n specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetOperation": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetOperationRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetOperationResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a specific operation. Operations include events such as when you\n create an instance, allocate a static IP, attach a static IP, and so on.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetOperation", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetOperationRequest": { - "type": "structure", - "members": { - "operationId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A GUID used to identify the operation.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#GetOperationResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetOperations": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetOperationsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetOperationsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about all operations.

\n

Results are returned from oldest to newest, up to a maximum of 200. Results can be paged\n by making each subsequent call to GetOperations use the maximum (last)\n statusChangedAt value from the previous request.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetOperations", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetOperationsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetOperationsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetOperationsForResourceResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets operations for a specific resource (e.g., an instance or a static IP).

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetOperationsForResource", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetOperationsForResourceRequest": { - "type": "structure", - "members": { - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the resource for which you are requesting information.

", - "smithy.api#required": {} - } - }, - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetOperationsForResource request. If\n your results are paginated, the response will return a next page token that you can specify as\n the page token in a subsequent request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetOperationsForResourceResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - }, - "nextPageCount": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

(Deprecated) Returns the number of pages of results that remain.

\n \n

In releases prior to June 12, 2017, this parameter returned null by the\n API. It is now deprecated, and the API returns the next page token parameter\n instead.

\n " - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetOperationsForResource\n request and specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetOperationsRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetOperations request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetOperationsResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetOperations request and\n specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRegions": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetRegionsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetRegionsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of all valid regions for Amazon Lightsail. Use the include\n availability zones parameter to also return the Availability Zones in a\n region.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetRegions", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetRegionsRequest": { - "type": "structure", - "members": { - "includeAvailabilityZones": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether to also include Availability Zones in your get regions\n request. Availability Zones are indicated with a letter: e.g., us-east-2a.

" - } - }, - "includeRelationalDatabaseAvailabilityZones": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether to also include Availability Zones for databases in\n your get regions request. Availability Zones are indicated with a letter (e.g.,\n us-east-2a).

" - } - } - } - }, - "com.amazonaws.lightsail#GetRegionsResult": { - "type": "structure", - "members": { - "regions": { - "target": "com.amazonaws.lightsail#RegionList", - "traits": { - "smithy.api#documentation": "

An array of key-value pairs containing information about your get regions request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabase": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a specific database in Amazon Lightsail.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetRelationalDatabase", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseBlueprints": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseBlueprintsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseBlueprintsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes\n the major engine version of a database.

\n

You can use a blueprint ID to create a new database that runs a specific database\n engine.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetRelationalDatabaseBlueprints", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseBlueprintsRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseBlueprints\n request. If your results are paginated, the response will return a next page token that you\n can specify as the page token in a subsequent request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseBlueprintsResult": { - "type": "structure", - "members": { - "blueprints": { - "target": "com.amazonaws.lightsail#RelationalDatabaseBlueprintList", - "traits": { - "smithy.api#documentation": "

An object describing the result of your get relational database blueprints request.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another\n GetRelationalDatabaseBlueprints request and specify the next page token using\n the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseBundles": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseBundlesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseBundlesResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the\n performance specifications for a database.

\n

You can use a bundle ID to create a new database with explicit performance\n specifications.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetRelationalDatabaseBundles", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseBundlesRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseBundles request.\n If your results are paginated, the response will return a next page token that you can specify\n as the page token in a subsequent request.

" - } - }, - "includeInactive": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether to include inactive (unavailable) bundles in the\n response of your request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseBundlesResult": { - "type": "structure", - "members": { - "bundles": { - "target": "com.amazonaws.lightsail#RelationalDatabaseBundleList", - "traits": { - "smithy.api#documentation": "

An object describing the result of your get relational database bundles request.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetRelationalDatabaseBundles\n request and specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseEvents": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseEventsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseEventsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of events for a specific database in Amazon Lightsail.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetRelationalDatabaseEvents", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseEventsRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the database from which to get events.

", - "smithy.api#required": {} - } - }, - "durationInMinutes": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The number of minutes in the past from which to retrieve events. For example, to get all\n events from the past 2 hours, enter 120.

\n

Default: 60\n

\n

The minimum is 1 and the maximum is 14 days (20160 minutes).

" - } - }, - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseEvents request.\n If your results are paginated, the response will return a next page token that you can specify\n as the page token in a subsequent request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseEventsResult": { - "type": "structure", - "members": { - "relationalDatabaseEvents": { - "target": "com.amazonaws.lightsail#RelationalDatabaseEventList", - "traits": { - "smithy.api#documentation": "

An object describing the result of your get relational database events request.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetRelationalDatabaseEvents\n request and specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseLogEvents": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogEventsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogEventsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of log events for a database in Amazon Lightsail.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetRelationalDatabaseLogEvents", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseLogEventsRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your database for which to get log events.

", - "smithy.api#required": {} - } - }, - "logStreamName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the log stream.

\n

Use the get relational database log streams operation to get a list of\n available log streams.

", - "smithy.api#required": {} - } - }, - "startTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The start of the time interval from which to get log events.

\n

Constraints:

\n " - } - }, - "endTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The end of the time interval from which to get log events.

\n

Constraints:

\n " - } - }, - "startFromHead": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Parameter to specify if the log should start from head or tail. If true is\n specified, the log event starts from the head of the log. If false is specified,\n the log event starts from the tail of the log.

\n \n

For PostgreSQL, the default value of false is the only option\n available.

\n " - } - }, - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next or previous page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseLogEvents\n request. If your results are paginated, the response will return a next forward token and/or\n next backward token that you can specify as the page token in a subsequent request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseLogEventsResult": { - "type": "structure", - "members": { - "resourceLogEvents": { - "target": "com.amazonaws.lightsail#LogEventList", - "traits": { - "smithy.api#documentation": "

An object describing the result of your get relational database log events request.

" - } - }, - "nextBackwardToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

A token used for advancing to the previous page of results from your get relational\n database log events request.

" - } - }, - "nextForwardToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

A token used for advancing to the next page of results from your get relational database\n log events request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseLogStreams": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogStreamsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogStreamsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of available log streams for a specific database in Amazon Lightsail.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetRelationalDatabaseLogStreams", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseLogStreamsRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your database for which to get log streams.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseLogStreamsResult": { - "type": "structure", - "members": { - "logStreams": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

An object describing the result of your get relational database log streams\n request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPassword": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPasswordRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPasswordResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the current, previous, or pending versions of the master user password for a\n Lightsail database.

\n

The GetRelationalDatabaseMasterUserPassword operation supports tag-based\n access control via resource tags applied to the resource identified by\n relationalDatabaseName.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetRelationalDatabaseMasterUserPassword", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPasswordRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your database for which to get the master user password.

", - "smithy.api#required": {} - } - }, - "passwordVersion": { - "target": "com.amazonaws.lightsail#RelationalDatabasePasswordVersion", - "traits": { - "smithy.api#documentation": "

The password version to return.

\n

Specifying CURRENT or PREVIOUS returns the current or previous\n passwords respectively. Specifying PENDING returns the newest version of the\n password that will rotate to CURRENT. After the PENDING password\n rotates to CURRENT, the PENDING password is no longer\n available.

\n

Default: CURRENT\n

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPasswordResult": { - "type": "structure", - "members": { - "masterUserPassword": { - "target": "com.amazonaws.lightsail#SensitiveString", - "traits": { - "smithy.api#documentation": "

The master user password for the password version specified.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the specified version of the master user password was created.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseMetricData": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseMetricDataRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseMetricDataResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the data points of the specified metric for a database in Amazon Lightsail.

\n

Metrics report the utilization of your resources, and the error counts generated by them.\n Monitor and collect metric data regularly to maintain the reliability, availability, and\n performance of your resources.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetRelationalDatabaseMetricData", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseMetricDataRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your database from which to get metric data.

", - "smithy.api#required": {} - } - }, - "metricName": { - "target": "com.amazonaws.lightsail#RelationalDatabaseMetricName", - "traits": { - "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid relational database metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value. All relational database metric data is available in 1-minute (60 seconds)\n granularity.

\n ", - "smithy.api#required": {} - } - }, - "period": { - "target": "com.amazonaws.lightsail#MetricPeriod", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

\n

All relational database metric data is available in 1-minute (60 seconds)\n granularity.

", - "smithy.api#required": {} - } - }, - "startTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The start of the time interval from which to get metric data.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "endTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The end of the time interval from which to get metric data.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "unit": { - "target": "com.amazonaws.lightsail#MetricUnit", - "traits": { - "smithy.api#documentation": "

The unit for the metric data request. Valid units depend on the metric data being\n requested. For the valid units with each available metric, see the metricName\n parameter.

", - "smithy.api#required": {} - } - }, - "statistics": { - "target": "com.amazonaws.lightsail#MetricStatisticList", - "traits": { - "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseMetricDataResult": { - "type": "structure", - "members": { - "metricName": { - "target": "com.amazonaws.lightsail#RelationalDatabaseMetricName", - "traits": { - "smithy.api#documentation": "

The name of the metric returned.

" - } - }, - "metricData": { - "target": "com.amazonaws.lightsail#MetricDatapointList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseParameters": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseParametersRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseParametersResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns all of the runtime parameters offered by the underlying database software, or\n engine, for a specific database in Amazon Lightsail.

\n

In addition to the parameter names and values, this operation returns other information\n about each parameter. This information includes whether changes require a reboot, whether the\n parameter is modifiable, the allowed values, and the data types.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetRelationalDatabaseParameters", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseParametersRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your database for which to get parameters.

", - "smithy.api#required": {} - } - }, - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseParameters\n request. If your results are paginated, the response will return a next page token that you\n can specify as the page token in a subsequent request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseParametersResult": { - "type": "structure", - "members": { - "parameters": { - "target": "com.amazonaws.lightsail#RelationalDatabaseParameterList", - "traits": { - "smithy.api#documentation": "

An object describing the result of your get relational database parameters request.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another\n GetRelationalDatabaseParameters request and specify the next page token using\n the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the database that you are looking up.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseResult": { - "type": "structure", - "members": { - "relationalDatabase": { - "target": "com.amazonaws.lightsail#RelationalDatabase", - "traits": { - "smithy.api#documentation": "

An object describing the specified database.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a specific database snapshot in Amazon Lightsail.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetRelationalDatabaseSnapshot", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotRequest": { - "type": "structure", - "members": { - "relationalDatabaseSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the database snapshot for which to get information.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotResult": { - "type": "structure", - "members": { - "relationalDatabaseSnapshot": { - "target": "com.amazonaws.lightsail#RelationalDatabaseSnapshot", - "traits": { - "smithy.api#documentation": "

An object describing the specified database snapshot.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseSnapshots": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about all of your database snapshots in Amazon Lightsail.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetRelationalDatabaseSnapshots", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotsRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseSnapshots\n request. If your results are paginated, the response will return a next page token that you\n can specify as the page token in a subsequent request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotsResult": { - "type": "structure", - "members": { - "relationalDatabaseSnapshots": { - "target": "com.amazonaws.lightsail#RelationalDatabaseSnapshotList", - "traits": { - "smithy.api#documentation": "

An object describing the result of your get relational database snapshots request.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another\n GetRelationalDatabaseSnapshots request and specify the next page token using\n the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabases": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetRelationalDatabasesRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetRelationalDatabasesResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about all of your databases in Amazon Lightsail.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetRelationalDatabases", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabasesRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabases request. If\n your results are paginated, the response will return a next page token that you can specify as\n the page token in a subsequent request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetRelationalDatabasesResult": { - "type": "structure", - "members": { - "relationalDatabases": { - "target": "com.amazonaws.lightsail#RelationalDatabaseList", - "traits": { - "smithy.api#documentation": "

An object describing the result of your get relational databases request.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetRelationalDatabases\n request and specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#GetStaticIp": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetStaticIpRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetStaticIpResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about an Amazon Lightsail static IP.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetStaticIp", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetStaticIpRequest": { - "type": "structure", - "members": { - "staticIpName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the static IP in Lightsail.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#GetStaticIpResult": { - "type": "structure", - "members": { - "staticIp": { - "target": "com.amazonaws.lightsail#StaticIp", - "traits": { - "smithy.api#documentation": "

An array of key-value pairs containing information about the requested static IP.

" - } - } - } - }, - "com.amazonaws.lightsail#GetStaticIps": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#GetStaticIpsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#GetStaticIpsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about all static IPs in the user's account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/GetStaticIps", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#GetStaticIpsRequest": { - "type": "structure", - "members": { - "pageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetStaticIps request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" - } - } - } - }, - "com.amazonaws.lightsail#GetStaticIpsResult": { - "type": "structure", - "members": { - "staticIps": { - "target": "com.amazonaws.lightsail#StaticIpList", - "traits": { - "smithy.api#documentation": "

An array of key-value pairs containing information about your get static IPs\n request.

" - } - }, - "nextPageToken": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetStaticIps request and\n specify the next page token using the pageToken parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#HeaderEnum": { - "type": "enum", - "members": { - "accept": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Accept" - } - }, - "acceptCharset": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Accept-Charset" - } - }, - "acceptDatetime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Accept-Datetime" - } - }, - "acceptEncoding": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Accept-Encoding" - } - }, - "acceptLanguage": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Accept-Language" - } - }, - "authorization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Authorization" - } - }, - "cloudFrontForwardedProto": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CloudFront-Forwarded-Proto" - } - }, - "cloudFrontIsDesktopViewer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CloudFront-Is-Desktop-Viewer" - } - }, - "cloudFrontIsMobileViewer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CloudFront-Is-Mobile-Viewer" - } - }, - "cloudFrontIsSmartTVViewer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CloudFront-Is-SmartTV-Viewer" - } - }, - "cloudFrontIsTabletViewer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CloudFront-Is-Tablet-Viewer" - } - }, - "cloudFrontViewerCountry": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CloudFront-Viewer-Country" - } - }, - "host": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Host" - } - }, - "origin": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Origin" - } - }, - "referer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Referer" - } - } - } - }, - "com.amazonaws.lightsail#HeaderForwardList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#HeaderEnum" - } - }, - "com.amazonaws.lightsail#HeaderObject": { - "type": "structure", - "members": { - "option": { - "target": "com.amazonaws.lightsail#ForwardValues", - "traits": { - "smithy.api#documentation": "

The headers that you want your distribution to forward to your origin and base caching\n on.

\n

You can configure your distribution to do one of the following:

\n " - } - }, - "headersAllowList": { - "target": "com.amazonaws.lightsail#HeaderForwardList", - "traits": { - "smithy.api#documentation": "

The specific headers to forward to your distribution's origin.

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

Describes the request headers that a Lightsail distribution bases caching on.

\n

For the headers that you specify, your distribution caches separate versions of the\n specified content based on the header values in viewer requests. For example, suppose viewer\n requests for logo.jpg contain a custom product header that has a\n value of either acme or apex, and you configure your distribution to\n cache your content based on values in the product header. Your distribution\n forwards the product header to the origin and caches the response from the origin\n once for each header value.\n

" - } - }, - "com.amazonaws.lightsail#HostKeyAttributes": { - "type": "structure", - "members": { - "algorithm": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The SSH host key algorithm or the RDP certificate format.

\n

For SSH host keys, the algorithm may be ssh-rsa,\n ecdsa-sha2-nistp256, ssh-ed25519, etc. For RDP certificates, the\n algorithm is always x509-cert.

" - } - }, - "publicKey": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The public SSH host key or the RDP certificate.

" - } - }, - "witnessedAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The time that the SSH host key or RDP certificate was recorded by Lightsail.

" - } - }, - "fingerprintSHA1": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The SHA-1 fingerprint of the returned SSH host key or RDP certificate.

\n " - } - }, - "fingerprintSHA256": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The SHA-256 fingerprint of the returned SSH host key or RDP certificate.

\n " - } - }, - "notValidBefore": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The returned RDP certificate is valid after this point in time.

\n

This value is listed only for RDP certificates.

" - } - }, - "notValidAfter": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The returned RDP certificate is not valid after this point in time.

\n

This value is listed only for RDP certificates.

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

Describes the public SSH host keys or the RDP certificate.

" - } - }, - "com.amazonaws.lightsail#HostKeysList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#HostKeyAttributes" - } - }, - "com.amazonaws.lightsail#HttpEndpoint": { - "type": "enum", - "members": { - "disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabled" - } - }, - "enabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabled" - } - } - } - }, - "com.amazonaws.lightsail#HttpProtocolIpv6": { - "type": "enum", - "members": { - "disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabled" - } - }, - "enabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabled" - } - } - } - }, - "com.amazonaws.lightsail#HttpTokens": { - "type": "enum", - "members": { - "optional": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "optional" - } - }, - "required": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "required" - } - } - } - }, - "com.amazonaws.lightsail#IAMAccessKeyId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 20 - }, - "smithy.api#pattern": "^[A-Z0-9]{20}$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.lightsail#ImportKeyPair": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#ImportKeyPairRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#ImportKeyPairResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Imports a public SSH key from a specific key pair.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/ImportKeyPair", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#ImportKeyPairRequest": { - "type": "structure", - "members": { - "keyPairName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the key pair for which you want to import the public key.

", - "smithy.api#required": {} - } - }, - "publicKeyBase64": { - "target": "com.amazonaws.lightsail#Base64", - "traits": { - "smithy.api#documentation": "

A base64-encoded public key of the ssh-rsa type.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#ImportKeyPairResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#InUseResourceCount": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.lightsail#IncludeCertificateDetails": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.lightsail#InputOrigin": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the origin resource.

" - } - }, - "regionName": { - "target": "com.amazonaws.lightsail#RegionName", - "traits": { - "smithy.api#documentation": "

The AWS Region name of the origin resource.

" - } - }, - "protocolPolicy": { - "target": "com.amazonaws.lightsail#OriginProtocolPolicyEnum", - "traits": { - "smithy.api#documentation": "

The protocol that your Amazon Lightsail distribution uses when establishing a connection\n with your origin to pull content.

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

Describes the origin resource of an Amazon Lightsail content delivery network (CDN)\n distribution.

\n

An origin can be a Lightsail instance, bucket, or load balancer. A distribution pulls\n content from an origin, caches it, and serves it to viewers via a worldwide network of edge\n servers.

" - } - }, - "com.amazonaws.lightsail#Instance": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1).

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance (e.g.,\n arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the instance was created (e.g., 1479734909.17) in Unix\n time format.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

The region name and Availability Zone where the instance is located.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The type of resource (usually Instance).

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "blueprintId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The blueprint ID (e.g., os_amlinux_2016_03).

" - } - }, - "blueprintName": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The friendly name of the blueprint (e.g., Amazon Linux).

" - } - }, - "bundleId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The bundle for the instance (e.g., micro_1_0).

" - } - }, - "addOns": { - "target": "com.amazonaws.lightsail#AddOnList", - "traits": { - "smithy.api#documentation": "

An array of objects representing the add-ons enabled on the instance.

" - } - }, - "isStaticIp": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether this instance has a static IP assigned to it.

" - } - }, - "privateIpAddress": { - "target": "com.amazonaws.lightsail#IpAddress", - "traits": { - "smithy.api#documentation": "

The private IP address of the instance.

" - } - }, - "publicIpAddress": { - "target": "com.amazonaws.lightsail#IpAddress", - "traits": { - "smithy.api#documentation": "

The public IP address of the instance.

" - } - }, - "ipv6Addresses": { - "target": "com.amazonaws.lightsail#Ipv6AddressList", - "traits": { - "smithy.api#documentation": "

The IPv6 addresses of the instance.

" - } - }, - "ipAddressType": { - "target": "com.amazonaws.lightsail#IpAddressType", - "traits": { - "smithy.api#documentation": "

The IP address type of the instance.

\n\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

" - } - }, - "hardware": { - "target": "com.amazonaws.lightsail#InstanceHardware", - "traits": { - "smithy.api#documentation": "

The size of the vCPU and the amount of RAM for the instance.

" - } - }, - "networking": { - "target": "com.amazonaws.lightsail#InstanceNetworking", - "traits": { - "smithy.api#documentation": "

Information about the public ports and monthly data transfer rates for the\n instance.

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#InstanceState", - "traits": { - "smithy.api#documentation": "

The status code and the state (e.g., running) for the instance.

" - } - }, - "username": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The user name for connecting to the instance (e.g., ec2-user).

" - } - }, - "sshKeyName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the SSH key being used to connect to the instance (e.g.,\n LightsailDefaultKeyPair).

" - } - }, - "metadataOptions": { - "target": "com.amazonaws.lightsail#InstanceMetadataOptions", - "traits": { - "smithy.api#documentation": "

The metadata options for the Amazon Lightsail instance.

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

Describes an instance (a virtual private server).

" - } - }, - "com.amazonaws.lightsail#InstanceAccessDetails": { - "type": "structure", - "members": { - "certKey": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

For SSH access, the public key to use when accessing your instance For OpenSSH clients\n (e.g., command line SSH), you should save this value to tempkey-cert.pub.

" - } - }, - "expiresAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

For SSH access, the date on which the temporary keys expire.

" - } - }, - "ipAddress": { - "target": "com.amazonaws.lightsail#IpAddress", - "traits": { - "smithy.api#documentation": "

The public IP address of the Amazon Lightsail instance.

" - } - }, - "password": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

For RDP access, the password for your Amazon Lightsail instance. Password will be an empty\n string if the password for your new instance is not ready yet. When you create an instance, it\n can take up to 15 minutes for the instance to be ready.

\n \n

If you create an instance using any key pair other than the default\n (LightsailDefaultKeyPair), password will always be an empty\n string.

\n

If you change the Administrator password on the instance, Lightsail will continue to\n return the original password value. When accessing the instance using RDP, you need to\n manually enter the Administrator password after changing it from the default.

\n " - } - }, - "passwordData": { - "target": "com.amazonaws.lightsail#PasswordData", - "traits": { - "smithy.api#documentation": "

For a Windows Server-based instance, an object with the data you can use to retrieve your\n password. This is only needed if password is empty and the instance is not new\n (and therefore the password is not ready yet). When you create an instance, it can take up to\n 15 minutes for the instance to be ready.

" - } - }, - "privateKey": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH),\n you should save this value to tempkey).

" - } - }, - "protocol": { - "target": "com.amazonaws.lightsail#InstanceAccessProtocol", - "traits": { - "smithy.api#documentation": "

The protocol for these Amazon Lightsail instance access details.

" - } - }, - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of this Amazon Lightsail instance.

" - } - }, - "username": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The user name to use when logging in to the Amazon Lightsail instance.

" - } - }, - "hostKeys": { - "target": "com.amazonaws.lightsail#HostKeysList", - "traits": { - "smithy.api#documentation": "

Describes the public SSH host keys or the RDP certificate.

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

The parameters for gaining temporary access to one of your Amazon Lightsail\n instances.

" - } - }, - "com.amazonaws.lightsail#InstanceAccessProtocol": { - "type": "enum", - "members": { - "ssh": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ssh" - } - }, - "rdp": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "rdp" - } - } - } - }, - "com.amazonaws.lightsail#InstanceEntry": { - "type": "structure", - "members": { - "sourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the export snapshot record, which contains the exported Lightsail instance\n snapshot that will be used as the source of the new Amazon EC2 instance.

\n

Use the get export snapshot records operation to get a list of export\n snapshot records that you can use to create a CloudFormation stack.

", - "smithy.api#required": {} - } - }, - "instanceType": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The instance type (e.g., t2.micro) to use for the new Amazon EC2 instance.

", - "smithy.api#required": {} - } - }, - "portInfoSource": { - "target": "com.amazonaws.lightsail#PortInfoSourceType", - "traits": { - "smithy.api#documentation": "

The port configuration to use for the new Amazon EC2 instance.

\n \n

The following configuration options are available:

\n \n \n

If you configured lightsail-connect as a cidrListAliases on\n your instance, or if you chose to allow the Lightsail browser-based SSH or RDP clients to\n connect to your instance, that configuration is not carried over to your new Amazon EC2\n instance.

\n ", - "smithy.api#required": {} - } - }, - "userData": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

A launch script you can create that configures a server with additional user data. For\n example, you might want to run apt-get -y update.

\n \n

Depending on the machine image you choose, the command to get software on your instance\n varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use\n apt-get, and FreeBSD uses pkg.

\n " - } - }, - "availabilityZone": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The Availability Zone for the new Amazon EC2 instance.

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

Describes the Amazon Elastic Compute Cloud instance and related resources to be created using the\n create cloud formation stack operation.

" - } - }, - "com.amazonaws.lightsail#InstanceEntryList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#InstanceEntry" - } - }, - "com.amazonaws.lightsail#InstanceHardware": { - "type": "structure", - "members": { - "cpuCount": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The number of vCPUs the instance has.

" - } - }, - "disks": { - "target": "com.amazonaws.lightsail#DiskList", - "traits": { - "smithy.api#documentation": "

The disks attached to the instance.

" - } - }, - "ramSizeInGb": { - "target": "com.amazonaws.lightsail#float", - "traits": { - "smithy.api#documentation": "

The amount of RAM in GB on the instance (e.g., 1.0).

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

Describes the hardware for the instance.

" - } - }, - "com.amazonaws.lightsail#InstanceHealthReason": { - "type": "enum", - "members": { - "LbRegistrationInProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Lb.RegistrationInProgress" - } - }, - "LbInitialHealthChecking": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Lb.InitialHealthChecking" - } - }, - "LbInternalError": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Lb.InternalError" - } - }, - "InstanceResponseCodeMismatch": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Instance.ResponseCodeMismatch" - } - }, - "InstanceTimeout": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Instance.Timeout" - } - }, - "InstanceFailedHealthChecks": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Instance.FailedHealthChecks" - } - }, - "InstanceNotRegistered": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Instance.NotRegistered" - } - }, - "InstanceNotInUse": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Instance.NotInUse" - } - }, - "InstanceDeregistrationInProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Instance.DeregistrationInProgress" - } - }, - "InstanceInvalidState": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Instance.InvalidState" - } - }, - "InstanceIpUnusable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Instance.IpUnusable" - } - } - } - }, - "com.amazonaws.lightsail#InstanceHealthState": { - "type": "enum", - "members": { - "Initial": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "initial" - } - }, - "Healthy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "healthy" - } - }, - "Unhealthy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unhealthy" - } - }, - "Unused": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unused" - } - }, - "Draining": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "draining" - } - }, - "Unavailable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unavailable" - } - } - } - }, - "com.amazonaws.lightsail#InstanceHealthSummary": { - "type": "structure", - "members": { - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the Lightsail instance for which you are requesting health check\n data.

" - } - }, - "instanceHealth": { - "target": "com.amazonaws.lightsail#InstanceHealthState", - "traits": { - "smithy.api#documentation": "

Describes the overall instance health. Valid values are below.

" - } - }, - "instanceHealthReason": { - "target": "com.amazonaws.lightsail#InstanceHealthReason", - "traits": { - "smithy.api#documentation": "

More information about the instance health. If the instanceHealth is\n healthy, then an instanceHealthReason value is not\n provided.

\n

If \n instanceHealth\n is initial,\n the \n instanceHealthReason\n value can be one of the\n following:

\n \n

If \n instanceHealth\n is unhealthy,\n the \n instanceHealthReason\n value can be one of the\n following:

\n \n

If \n instanceHealth\n is unused,\n the \n instanceHealthReason\n value can be one of the\n following:

\n \n

If \n instanceHealth\n is draining,\n the \n instanceHealthReason\n value can be one of the\n following:

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

Describes information about the health of the instance.

" - } - }, - "com.amazonaws.lightsail#InstanceHealthSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#InstanceHealthSummary" - } - }, - "com.amazonaws.lightsail#InstanceList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Instance" - } - }, - "com.amazonaws.lightsail#InstanceMetadataOptions": { - "type": "structure", - "members": { - "state": { - "target": "com.amazonaws.lightsail#InstanceMetadataState", - "traits": { - "smithy.api#documentation": "

The state of the metadata option changes.

\n

The following states are possible:

\n " - } - }, - "httpTokens": { - "target": "com.amazonaws.lightsail#HttpTokens", - "traits": { - "smithy.api#documentation": "

The state of token usage for your instance metadata requests.

\n\n

If the state is optional, you can choose whether to retrieve instance\n metadata with a signed token header on your request. If you retrieve the IAM role credentials\n without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role\n credentials by using a valid signed token, the version 2.0 role credentials are\n returned.

\n\n

If the state is required, you must send a signed token header with all\n instance metadata retrieval requests. In this state, retrieving the IAM role credential always\n returns the version 2.0 credentials. The version 1.0 credentials are not available.

\n\n\n \n

Not all instance blueprints in Lightsail support version 2.0 credentials.\n Use the MetadataNoToken instance metric to track the number of calls to the\n instance metadata service that are using version 1.0 credentials. For more information, see\n Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.

\n " - } - }, - "httpEndpoint": { - "target": "com.amazonaws.lightsail#HttpEndpoint", - "traits": { - "smithy.api#documentation": "

Indicates whether the HTTP metadata endpoint on your instances is enabled or\n disabled.

\n\n

If the value is disabled, you cannot access your instance metadata.

" - } - }, - "httpPutResponseHopLimit": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. A larger number\n means that the instance metadata requests can travel farther.

" - } - }, - "httpProtocolIpv6": { - "target": "com.amazonaws.lightsail#HttpProtocolIpv6", - "traits": { - "smithy.api#documentation": "

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or\n disabled.

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

The metadata options for the instance.

" - } - }, - "com.amazonaws.lightsail#InstanceMetadataState": { - "type": "enum", - "members": { - "pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "applied": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "applied" - } - } - } - }, - "com.amazonaws.lightsail#InstanceMetricName": { - "type": "enum", - "members": { - "CPUUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CPUUtilization" - } - }, - "NetworkIn": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NetworkIn" - } - }, - "NetworkOut": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NetworkOut" - } - }, - "StatusCheckFailed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StatusCheckFailed" - } - }, - "StatusCheckFailed_Instance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StatusCheckFailed_Instance" - } - }, - "StatusCheckFailed_System": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StatusCheckFailed_System" - } - }, - "BurstCapacityTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BurstCapacityTime" - } - }, - "BurstCapacityPercentage": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BurstCapacityPercentage" - } - }, - "MetadataNoToken": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MetadataNoToken" - } - } - } - }, - "com.amazonaws.lightsail#InstanceNetworking": { - "type": "structure", - "members": { - "monthlyTransfer": { - "target": "com.amazonaws.lightsail#MonthlyTransfer", - "traits": { - "smithy.api#documentation": "

The amount of data in GB allocated for monthly data transfers.

" - } - }, - "ports": { - "target": "com.amazonaws.lightsail#InstancePortInfoList", - "traits": { - "smithy.api#documentation": "

An array of key-value pairs containing information about the ports on the instance.

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

Describes monthly data transfer rates and port information for an instance.

" - } - }, - "com.amazonaws.lightsail#InstancePlatform": { - "type": "enum", - "members": { - "LinuxUnix": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LINUX_UNIX" - } - }, - "Windows": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WINDOWS" - } - } - } - }, - "com.amazonaws.lightsail#InstancePlatformList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#InstancePlatform" - } - }, - "com.amazonaws.lightsail#InstancePortInfo": { - "type": "structure", - "members": { - "fromPort": { - "target": "com.amazonaws.lightsail#Port", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The first port in a range of open ports on an instance.

\n

Allowed ports:

\n " - } - }, - "toPort": { - "target": "com.amazonaws.lightsail#Port", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The last port in a range of open ports on an instance.

\n

Allowed ports:

\n " - } - }, - "protocol": { - "target": "com.amazonaws.lightsail#NetworkProtocol", - "traits": { - "smithy.api#documentation": "

The IP protocol name.

\n

The name can be one of the following:

\n " - } - }, - "accessFrom": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The location from which access is allowed. For example, Anywhere (0.0.0.0/0),\n or Custom if a specific IP address or range of IP addresses is allowed.

" - } - }, - "accessType": { - "target": "com.amazonaws.lightsail#PortAccessType", - "traits": { - "smithy.api#documentation": "

The type of access (Public or Private).

" - } - }, - "commonName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The common name of the port information.

" - } - }, - "accessDirection": { - "target": "com.amazonaws.lightsail#AccessDirection", - "traits": { - "smithy.api#documentation": "

The access direction (inbound or outbound).

\n \n

Lightsail currently supports only inbound access direction.

\n " - } - }, - "cidrs": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol.

\n \n

The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to\n connect to an instance.

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" - } - }, - "ipv6Cidrs": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol. Only devices with an IPv6 address\n can connect to an instance through IPv6; otherwise, IPv4 should be used.

\n \n

The cidrs parameter lists the IPv4 addresses that are allowed to connect to\n an instance.

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" - } - }, - "cidrListAliases": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

An alias that defines access for a preconfigured range of IP addresses.

\n

The only alias currently supported is lightsail-connect, which allows IP\n addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your\n instance.

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

Describes information about ports for an Amazon Lightsail instance.

" - } - }, - "com.amazonaws.lightsail#InstancePortInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#InstancePortInfo" - } - }, - "com.amazonaws.lightsail#InstancePortState": { - "type": "structure", - "members": { - "fromPort": { - "target": "com.amazonaws.lightsail#Port", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The first port in a range of open ports on an instance.

\n

Allowed ports:

\n " - } - }, - "toPort": { - "target": "com.amazonaws.lightsail#Port", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The last port in a range of open ports on an instance.

\n

Allowed ports:

\n " - } - }, - "protocol": { - "target": "com.amazonaws.lightsail#NetworkProtocol", - "traits": { - "smithy.api#documentation": "

The IP protocol name.

\n

The name can be one of the following:

\n " - } - }, - "state": { - "target": "com.amazonaws.lightsail#PortState", - "traits": { - "smithy.api#documentation": "

Specifies whether the instance port is open or closed.

\n \n

The port state for Lightsail instances is always open.

\n " - } - }, - "cidrs": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol.

\n \n

The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to\n connect to an instance.

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" - } - }, - "ipv6Cidrs": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol. Only devices with an IPv6 address\n can connect to an instance through IPv6; otherwise, IPv4 should be used.

\n \n

The cidrs parameter lists the IPv4 addresses that are allowed to connect to\n an instance.

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" - } - }, - "cidrListAliases": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

An alias that defines access for a preconfigured range of IP addresses.

\n

The only alias currently supported is lightsail-connect, which allows IP\n addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your\n instance.

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

Describes open ports on an instance, the IP addresses allowed to connect to the instance\n through the ports, and the protocol.

" - } - }, - "com.amazonaws.lightsail#InstancePortStateList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#InstancePortState" - } - }, - "com.amazonaws.lightsail#InstanceSnapshot": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the snapshot.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot (e.g.,\n arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the snapshot was created (e.g., 1479907467.024).

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

The region name and Availability Zone where you created the snapshot.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The type of resource (usually InstanceSnapshot).

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#InstanceSnapshotState", - "traits": { - "smithy.api#documentation": "

The state the snapshot is in.

" - } - }, - "progress": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The progress of the snapshot.

\n \n

This is populated only for disk snapshots, and is null for instance\n snapshots.

\n " - } - }, - "fromAttachedDisks": { - "target": "com.amazonaws.lightsail#DiskList", - "traits": { - "smithy.api#documentation": "

An array of disk objects containing information about all block storage disks.

" - } - }, - "fromInstanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The instance from which the snapshot was created.

" - } - }, - "fromInstanceArn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g.,\n arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).

" - } - }, - "fromBlueprintId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The blueprint ID from which you created the snapshot (e.g., os_debian_8_3). A\n blueprint is a virtual private server (or instance) image used to create\n instances quickly.

" - } - }, - "fromBundleId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The bundle ID from which you created the snapshot (e.g., micro_1_0).

" - } - }, - "isFromAutoSnapshot": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the snapshot was created from an automatic\n snapshot.

" - } - }, - "sizeInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The size in GB of the SSD.

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

Describes an instance snapshot.

" - } - }, - "com.amazonaws.lightsail#InstanceSnapshotInfo": { - "type": "structure", - "members": { - "fromBundleId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The bundle ID from which the source instance was created (e.g.,\n micro_1_0).

" - } - }, - "fromBlueprintId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The blueprint ID from which the source instance (e.g., os_debian_8_3).

" - } - }, - "fromDiskInfo": { - "target": "com.amazonaws.lightsail#DiskInfoList", - "traits": { - "smithy.api#documentation": "

A list of objects describing the disks that were attached to the source instance.

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

Describes an instance snapshot.

" - } - }, - "com.amazonaws.lightsail#InstanceSnapshotList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#InstanceSnapshot" - } - }, - "com.amazonaws.lightsail#InstanceSnapshotState": { - "type": "enum", - "members": { - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "Error": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "error" - } - }, - "Available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - } - } - }, - "com.amazonaws.lightsail#InstanceState": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The status code for the instance.

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The state of the instance (e.g., running or pending).

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

Describes the virtual private server (or instance) status.

" - } - }, - "com.amazonaws.lightsail#InvalidInputException": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#AccessKeyLastUsed": { + "type": "structure", + "members": { + "lastUsedDate": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The date and time when the access key was most recently used.

\n

This value is null if the access key has not been used.

" + } + }, + "region": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region where this access key was most recently used.

\n

This value is N/A if the access key has not been used.

" + } + }, + "serviceName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Web Services service with which this access key was most recently\n used.

\n

This value is N/A if the access key has not been used.

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

Describes the last time an access key was used.

\n \n

This object does not include data in the response of a CreateBucketAccessKey action.

\n " + } + }, + "com.amazonaws.lightsail#AccessKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#AccessKey" + } + }, + "com.amazonaws.lightsail#AccessReceiverList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#ResourceReceivingAccess" + } + }, + "com.amazonaws.lightsail#AccessRules": { + "type": "structure", + "members": { + "getObject": { + "target": "com.amazonaws.lightsail#AccessType", + "traits": { + "smithy.api#documentation": "

Specifies the anonymous access to all objects in a bucket.

\n

The following options can be specified:

\n " + } + }, + "allowPublicOverrides": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether the access control list (ACL) permissions that are\n applied to individual objects override the getObject option that is currently\n specified.

\n

When this is true, you can use the PutObjectAcl Amazon S3 API action to set\n individual objects to public (read-only) using the public-read ACL, or to private\n using the private ACL.

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

Describes the anonymous access permissions for an Amazon Lightsail bucket and its\n objects.

\n

For more information about bucket access permissions, see Understanding bucket permissions in Amazon Lightsail in the

\n

\n Amazon Lightsail Developer Guide.

" + } + }, + "com.amazonaws.lightsail#AccessType": { + "type": "enum", + "members": { + "Public": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "public" + } + }, + "Private": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "private" + } + } + } + }, + "com.amazonaws.lightsail#AccountLevelBpaSync": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.lightsail#AccountLevelBpaSyncStatus", + "traits": { + "smithy.api#documentation": "

The status of the account-level BPA synchronization.

\n

The following statuses are possible:

\n \n \n

You might need to complete further actions if the status is Failed or\n Defaulted. The message parameter provides more information for\n those statuses.

\n " + } + }, + "lastSyncedAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp of when the account-level BPA configuration was last synchronized. This\n value is null when the account-level BPA configuration has not been synchronized.

" + } + }, + "message": { + "target": "com.amazonaws.lightsail#BPAStatusMessage", + "traits": { + "smithy.api#documentation": "

A message that provides a reason for a Failed or Defaulted\n synchronization status.

\n

The following messages are possible:

\n " + } + }, + "bpaImpactsLightsail": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether account-level block public access is affecting your\n Lightsail buckets.

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

Describes the synchronization status of the Amazon Simple Storage Service (Amazon S3)\n account-level block public access (BPA) feature for your Lightsail buckets.

\n

The account-level BPA feature of Amazon S3 provides centralized controls to limit\n public access to all Amazon S3 buckets in an account. BPA can make all Amazon S3 buckets in an Amazon Web Services account private regardless of the individual bucket and\n object permissions that are configured. Lightsail buckets take into account the\n Amazon S3 account-level BPA configuration when allowing or denying public access. To\n do this, Lightsail periodically fetches the account-level BPA configuration\n from Amazon S3. When the account-level BPA status is InSync, the Amazon S3 account-level BPA configuration is synchronized and it applies to your Lightsail\n buckets. For more information about Amazon Simple Storage Service account-level BPA and how it affects\n Lightsail buckets, see Block public access for buckets in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

" + } + }, + "com.amazonaws.lightsail#AccountLevelBpaSyncStatus": { + "type": "enum", + "members": { + "InSync": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InSync" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "NeverSynced": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NeverSynced" + } + }, + "Defaulted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Defaulted" + } + } + } + }, + "com.amazonaws.lightsail#AccountSetupInProgressException": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#string" + }, + "docs": { + "target": "com.amazonaws.lightsail#string" + }, + "message": { + "target": "com.amazonaws.lightsail#string" + }, + "tip": { + "target": "com.amazonaws.lightsail#string" + } + }, + "traits": { + "smithy.api#documentation": "

Lightsail throws this exception when an account is still in the setup in progress\n state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 428 + } + }, + "com.amazonaws.lightsail#AddOn": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the add-on.

" + } + }, + "status": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The status of the add-on.

" + } + }, + "snapshotTimeOfDay": { + "target": "com.amazonaws.lightsail#TimeOfDay", + "traits": { + "smithy.api#documentation": "

The daily time when an automatic snapshot is created.

\n

The time shown is in HH:00 format, and in Coordinated Universal Time\n (UTC).

\n

The snapshot is automatically created between the time shown and up to 45 minutes\n after.

" + } + }, + "nextSnapshotTimeOfDay": { + "target": "com.amazonaws.lightsail#TimeOfDay", + "traits": { + "smithy.api#documentation": "

The next daily time an automatic snapshot will be created.

\n

The time shown is in HH:00 format, and in Coordinated Universal Time\n (UTC).

\n

The snapshot is automatically created between the time shown and up to 45 minutes\n after.

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

Describes an add-on that is enabled for an Amazon Lightsail resource.

" + } + }, + "com.amazonaws.lightsail#AddOnList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#AddOn" + } + }, + "com.amazonaws.lightsail#AddOnRequest": { + "type": "structure", + "members": { + "addOnType": { + "target": "com.amazonaws.lightsail#AddOnType", + "traits": { + "smithy.api#documentation": "

The add-on type.

", + "smithy.api#required": {} + } + }, + "autoSnapshotAddOnRequest": { + "target": "com.amazonaws.lightsail#AutoSnapshotAddOnRequest", + "traits": { + "smithy.api#documentation": "

An object that represents additional parameters when enabling or modifying the automatic\n snapshot add-on.

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

Describes a request to enable, modify, or disable an add-on for an Amazon Lightsail\n resource.

\n \n

An additional cost may be associated with enabling add-ons. For more information, see\n the Lightsail pricing\n page.

\n " + } + }, + "com.amazonaws.lightsail#AddOnRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#AddOnRequest" + } + }, + "com.amazonaws.lightsail#AddOnType": { + "type": "enum", + "members": { + "AutoSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AutoSnapshot" + } + } + } + }, + "com.amazonaws.lightsail#Alarm": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the alarm.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the alarm.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the alarm was created.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

An object that lists information about the location of the alarm.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type (e.g., Alarm).

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail alarm. This code enables our support team to look up your Lightsail\n information more easily.

" + } + }, + "monitoredResourceInfo": { + "target": "com.amazonaws.lightsail#MonitoredResourceInfo", + "traits": { + "smithy.api#documentation": "

An object that lists information about the resource monitored by the alarm.

" + } + }, + "comparisonOperator": { + "target": "com.amazonaws.lightsail#ComparisonOperator", + "traits": { + "smithy.api#documentation": "

The arithmetic operation used when comparing the specified statistic and threshold.

" + } + }, + "evaluationPeriods": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The number of periods over which data is compared to the specified threshold.

" + } + }, + "period": { + "target": "com.amazonaws.lightsail#MetricPeriod", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The period, in seconds, over which the statistic is applied.

" + } + }, + "threshold": { + "target": "com.amazonaws.lightsail#double", + "traits": { + "smithy.api#documentation": "

The value against which the specified statistic is compared.

" + } + }, + "datapointsToAlarm": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The number of data points that must not within the specified threshold to trigger the\n alarm.

" + } + }, + "treatMissingData": { + "target": "com.amazonaws.lightsail#TreatMissingData", + "traits": { + "smithy.api#documentation": "

Specifies how the alarm handles missing data points.

\n

An alarm can treat missing data in the following ways:

\n " + } + }, + "statistic": { + "target": "com.amazonaws.lightsail#MetricStatistic", + "traits": { + "smithy.api#documentation": "

The statistic for the metric associated with the alarm.

\n

The following statistics are available:

\n " + } + }, + "metricName": { + "target": "com.amazonaws.lightsail#MetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric associated with the alarm.

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#AlarmState", + "traits": { + "smithy.api#documentation": "

The current state of the alarm.

\n

An alarm has the following possible states:

\n " + } + }, + "unit": { + "target": "com.amazonaws.lightsail#MetricUnit", + "traits": { + "smithy.api#documentation": "

The unit of the metric associated with the alarm.

" + } + }, + "contactProtocols": { + "target": "com.amazonaws.lightsail#ContactProtocolsList", + "traits": { + "smithy.api#documentation": "

The contact protocols for the alarm, such as Email, SMS (text\n messaging), or both.

" + } + }, + "notificationTriggers": { + "target": "com.amazonaws.lightsail#NotificationTriggerList", + "traits": { + "smithy.api#documentation": "

The alarm states that trigger a notification.

" + } + }, + "notificationEnabled": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the alarm is enabled.

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

Describes an alarm.

\n

An alarm is a way to monitor your Lightsail resource metrics. For more information, see\n Alarms in Amazon Lightsail.

" + } + }, + "com.amazonaws.lightsail#AlarmState": { + "type": "enum", + "members": { + "OK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OK" + } + }, + "ALARM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALARM" + } + }, + "INSUFFICIENT_DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSUFFICIENT_DATA" + } + } + } + }, + "com.amazonaws.lightsail#AlarmsList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Alarm" + } + }, + "com.amazonaws.lightsail#AllocateStaticIp": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#AllocateStaticIpRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#AllocateStaticIpResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Allocates a static IP address.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/AllocateStaticIp", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#AllocateStaticIpRequest": { + "type": "structure", + "members": { + "staticIpName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the static IP address.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#AllocateStaticIpResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#AttachCertificateToDistribution": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#AttachCertificateToDistributionRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#AttachCertificateToDistributionResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

After the certificate is attached, your distribution accepts HTTPS traffic for all of the\n domains that are associated with the certificate.

\n

Use the CreateCertificate action to create a certificate that you can attach\n to your distribution.

\n \n

Only certificates created in the us-east-1\n Amazon Web Services Region can be attached to Lightsail distributions. Lightsail\n distributions are global resources that can reference an origin in any Amazon Web Services\n Region, and distribute its content globally. However, all distributions are located in the\n us-east-1 Region.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/AttachCertificateToDistribution", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#AttachCertificateToDistributionRequest": { + "type": "structure", + "members": { + "distributionName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the distribution that the certificate will be attached to.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

", + "smithy.api#required": {} + } + }, + "certificateName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the certificate to attach to a distribution.

\n

Only certificates with a status of ISSUED can be attached to a\n distribution.

\n

Use the GetCertificates action to get a list of certificate names that you\n can specify.

\n \n

This is the name of the certificate resource type and is used only to reference the\n certificate in other API actions. It can be different than the domain name of the\n certificate. For example, your certificate name might be\n WordPress-Blog-Certificate and the domain name of the certificate might be\n example.com.

\n ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#AttachCertificateToDistributionResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#AttachDisk": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#AttachDiskRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#AttachDiskResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Attaches a block storage disk to a running or stopped Lightsail instance and exposes it\n to the instance with the specified disk name.

\n

The attach disk operation supports tag-based access control via resource tags\n applied to the resource identified by disk name. For more information, see the\n Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/AttachDisk", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#AttachDiskRequest": { + "type": "structure", + "members": { + "diskName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The unique Lightsail disk name (e.g., my-disk).

", + "smithy.api#required": {} + } + }, + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Lightsail instance where you want to utilize the storage disk.

", + "smithy.api#required": {} + } + }, + "diskPath": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The disk path to expose to the instance (e.g., /dev/xvdf).

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#AttachDiskResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#AttachInstancesToLoadBalancer": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#AttachInstancesToLoadBalancerRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#AttachInstancesToLoadBalancerResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Attaches one or more Lightsail instances to a load balancer.

\n

After some time, the instances are attached to the load balancer and the health check\n status is available.

\n

The attach instances to load balancer operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/AttachInstancesToLoadBalancer", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#AttachInstancesToLoadBalancerRequest": { + "type": "structure", + "members": { + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the load balancer.

", + "smithy.api#required": {} + } + }, + "instanceNames": { + "target": "com.amazonaws.lightsail#ResourceNameList", + "traits": { + "smithy.api#documentation": "

An array of strings representing the instance name(s) you want to attach to your load\n balancer.

\n

An instance must be running before you can attach it to your load\n balancer.

\n

There are no additional limits on the number of instances you can attach to your load\n balancer, aside from the limit of Lightsail instances you can create in your account\n (20).

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#AttachInstancesToLoadBalancerResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificateRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificateResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just\n an updated, more secure version of Secure Socket Layer (SSL).

\n

Once you create and validate your certificate, you can attach it to your load balancer.\n You can also use this API to rotate the certificates on your account. Use the\n AttachLoadBalancerTlsCertificate action with the non-attached certificate, and\n it will replace the existing one and become the attached certificate.

\n

The AttachLoadBalancerTlsCertificate operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/AttachLoadBalancerTlsCertificate", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificateRequest": { + "type": "structure", + "members": { + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the load balancer to which you want to associate the SSL/TLS\n certificate.

", + "smithy.api#required": {} + } + }, + "certificateName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your SSL/TLS certificate.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificateResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

\n

These SSL/TLS certificates are only usable by Lightsail load balancers. You can't get\n the certificate and use it for another purpose.

" + } + } + } + }, + "com.amazonaws.lightsail#AttachStaticIp": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#AttachStaticIpRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#AttachStaticIpResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Attaches a static IP address to a specific Amazon Lightsail instance.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/AttachStaticIp", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#AttachStaticIpRequest": { + "type": "structure", + "members": { + "staticIpName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the static IP.

", + "smithy.api#required": {} + } + }, + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The instance name to which you want to attach the static IP address.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#AttachStaticIpResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#AttachedDisk": { + "type": "structure", + "members": { + "path": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The path of the disk (e.g., /dev/xvdf).

" + } + }, + "sizeInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The size of the disk in GB.

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

Describes a block storage disk that is attached to an instance, and is included in an\n automatic snapshot.

" + } + }, + "com.amazonaws.lightsail#AttachedDiskList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#AttachedDisk" + } + }, + "com.amazonaws.lightsail#AttachedDiskMap": { + "type": "map", + "key": { + "target": "com.amazonaws.lightsail#ResourceName" + }, + "value": { + "target": "com.amazonaws.lightsail#DiskMapList" + } + }, + "com.amazonaws.lightsail#AutoSnapshotAddOnRequest": { + "type": "structure", + "members": { + "snapshotTimeOfDay": { + "target": "com.amazonaws.lightsail#TimeOfDay", + "traits": { + "smithy.api#documentation": "

The daily time when an automatic snapshot will be created.

\n

Constraints:

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

Describes a request to enable or modify the automatic snapshot add-on for an\n Amazon Lightsail instance or disk.

\n

When you modify the automatic snapshot time for a resource, it is typically effective\n immediately except under the following conditions:

\n " + } + }, + "com.amazonaws.lightsail#AutoSnapshotDate": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + } + }, + "com.amazonaws.lightsail#AutoSnapshotDetails": { + "type": "structure", + "members": { + "date": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The date of the automatic snapshot in YYYY-MM-DD format.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the automatic snapshot was created.

" + } + }, + "status": { + "target": "com.amazonaws.lightsail#AutoSnapshotStatus", + "traits": { + "smithy.api#documentation": "

The status of the automatic snapshot.

" + } + }, + "fromAttachedDisks": { + "target": "com.amazonaws.lightsail#AttachedDiskList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the block storage disks attached to the instance when\n the automatic snapshot was created.

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

Describes an automatic snapshot.

" + } + }, + "com.amazonaws.lightsail#AutoSnapshotDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#AutoSnapshotDetails" + } + }, + "com.amazonaws.lightsail#AutoSnapshotStatus": { + "type": "enum", + "members": { + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Success" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotFound" + } + } + } + }, + "com.amazonaws.lightsail#AvailabilityZone": { + "type": "structure", + "members": { + "zoneName": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the Availability Zone. The format is us-east-2a\n (case-sensitive).

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The state of the Availability Zone.

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

Describes an Availability Zone.

" + } + }, + "com.amazonaws.lightsail#AvailabilityZoneList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#AvailabilityZone" + } + }, + "com.amazonaws.lightsail#BPAStatusMessage": { + "type": "enum", + "members": { + "DEFAULTED_FOR_SLR_MISSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULTED_FOR_SLR_MISSING" + } + }, + "SYNC_ON_HOLD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYNC_ON_HOLD" + } + }, + "DEFAULTED_FOR_SLR_MISSING_ON_HOLD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULTED_FOR_SLR_MISSING_ON_HOLD" + } + }, + "Unknown": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unknown" + } + } + } + }, + "com.amazonaws.lightsail#Base64": { + "type": "string" + }, + "com.amazonaws.lightsail#BehaviorEnum": { + "type": "enum", + "members": { + "DontCacheSetting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dont-cache" + } + }, + "CacheSetting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cache" + } + } + } + }, + "com.amazonaws.lightsail#Blueprint": { + "type": "structure", + "members": { + "blueprintId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID for the virtual private server image (e.g., app_wordpress_4_4 or\n app_lamp_7_0).

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The friendly name of the blueprint (e.g., Amazon Linux).

" + } + }, + "group": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The group name of the blueprint (e.g., amazon-linux).

" + } + }, + "type": { + "target": "com.amazonaws.lightsail#BlueprintType", + "traits": { + "smithy.api#documentation": "

The type of the blueprint (e.g., os or app).

" + } + }, + "description": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The description of the blueprint.

" + } + }, + "isActive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the blueprint is active. Inactive blueprints are listed\n to support customers with existing instances but are not necessarily available for launch of\n new instances. Blueprints are marked inactive when they become outdated due to operating\n system updates or new application releases.

" + } + }, + "minPower": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The minimum bundle power required to run this blueprint. For example, you need a bundle\n with a power value of 500 or more to create an instance that uses a blueprint with a minimum\n power value of 500. 0 indicates that the blueprint runs on all instance sizes.\n

" + } + }, + "version": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The version number of the operating system, application, or stack (e.g.,\n 2016.03.0).

" + } + }, + "versionCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The version code.

" + } + }, + "productUrl": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The product URL to learn more about the image or blueprint.

" + } + }, + "licenseUrl": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The end-user license agreement URL for the image or blueprint.

" + } + }, + "platform": { + "target": "com.amazonaws.lightsail#InstancePlatform", + "traits": { + "smithy.api#documentation": "

The operating system platform (either Linux/Unix-based or Windows Server-based) of the\n blueprint.

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

Describes a blueprint (a virtual private server image).

" + } + }, + "com.amazonaws.lightsail#BlueprintList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Blueprint" + } + }, + "com.amazonaws.lightsail#BlueprintType": { + "type": "enum", + "members": { + "os": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "os" + } + }, + "app": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "app" + } + } + } + }, + "com.amazonaws.lightsail#Bucket": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type of the bucket (for example, Bucket).

" + } + }, + "accessRules": { + "target": "com.amazonaws.lightsail#AccessRules", + "traits": { + "smithy.api#documentation": "

An object that describes the access rules of the bucket.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the bucket.

" + } + }, + "bundleId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the bundle currently applied to the bucket.

\n

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\n bucket.

\n

Use the UpdateBucketBundle action to change the\n bundle of a bucket.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the distribution was created.

" + } + }, + "url": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The URL of the bucket.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

An object that describes the location of the bucket, such as the Amazon Web Services Region\n and Availability Zone.

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket.

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The support code for a bucket. Include this code in your email to support when you have\n questions about a Lightsail bucket. This code enables our support team to look up your\n Lightsail information more easily.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the bucket. For more information, see Tags in\n Amazon Lightsail in the Amazon Lightsail Developer Guide.

" + } + }, + "objectVersioning": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates whether object versioning is enabled for the bucket.

\n

The following options can be configured:

\n " + } + }, + "ableToUpdateBundle": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the bundle that is currently applied to a bucket can be changed to\n another bundle.

\n

You can update a bucket's bundle only one time within a monthly Amazon Web Services billing\n cycle.

\n

Use the UpdateBucketBundle action to change a\n bucket's bundle.

" + } + }, + "readonlyAccessAccounts": { + "target": "com.amazonaws.lightsail#PartnerIdList", + "traits": { + "smithy.api#documentation": "

An array of strings that specify the Amazon Web Services account IDs that have read-only\n access to the bucket.

" + } + }, + "resourcesReceivingAccess": { + "target": "com.amazonaws.lightsail#AccessReceiverList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe Lightsail instances that have access to the\n bucket.

\n

Use the SetResourceAccessForBucket\n action to update the instances that have access to a bucket.

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#BucketState", + "traits": { + "smithy.api#documentation": "

An object that describes the state of the bucket.

" + } + }, + "accessLogConfig": { + "target": "com.amazonaws.lightsail#BucketAccessLogConfig", + "traits": { + "smithy.api#documentation": "

An object that describes the access log configuration for the bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Amazon Lightsail bucket.

" + } + }, + "com.amazonaws.lightsail#BucketAccessLogConfig": { + "type": "structure", + "members": { + "enabled": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether bucket access logging is enabled for the\n bucket.

", + "smithy.api#required": {} + } + }, + "destination": { + "target": "com.amazonaws.lightsail#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket where the access logs are saved. The destination can be a\n Lightsail bucket in the same account, and in the same Amazon Web Services Region as the\n source bucket.

\n \n

This parameter is required when enabling the access log for a bucket, and should be\n omitted when disabling the access log.

\n " + } + }, + "prefix": { + "target": "com.amazonaws.lightsail#BucketAccessLogPrefix", + "traits": { + "smithy.api#documentation": "

The optional object prefix for the bucket access log.

\n

The prefix is an optional addition to the object key that organizes your access log files\n in the destination bucket. For example, if you specify a logs/ prefix, then each\n log object will begin with the logs/ prefix in its key (for example,\n logs/2021-11-01-21-32-16-E568B2907131C0C0).

\n \n

This parameter can be optionally specified when enabling the access log for a bucket,\n and should be omitted when disabling the access log.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the access log configuration for a bucket in the Amazon Lightsail object storage\n service.

\n

For more information about bucket access logs, see Logging bucket requests using access logging in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

" + } + }, + "com.amazonaws.lightsail#BucketAccessLogPrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[\\w/!.*')(-]+$" + } + }, + "com.amazonaws.lightsail#BucketBundle": { + "type": "structure", + "members": { + "bundleId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the bundle.

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the bundle.

" + } + }, + "price": { + "target": "com.amazonaws.lightsail#float", + "traits": { + "smithy.api#documentation": "

The monthly price of the bundle, in US dollars.

" + } + }, + "storagePerMonthInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The storage size of the bundle, in GB.

" + } + }, + "transferPerMonthInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The monthly network transfer quota of the bundle.

" + } + }, + "isActive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the bundle is active. Use for a new or existing bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the specifications of a bundle that can be applied to an Amazon Lightsail\n bucket.

\n

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\n bucket.

" + } + }, + "com.amazonaws.lightsail#BucketBundleList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#BucketBundle" + } + }, + "com.amazonaws.lightsail#BucketList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Bucket" + } + }, + "com.amazonaws.lightsail#BucketMetricName": { + "type": "enum", + "members": { + "BucketSizeBytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BucketSizeBytes" + } + }, + "NumberOfObjects": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NumberOfObjects" + } + } + } + }, + "com.amazonaws.lightsail#BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 54 + }, + "smithy.api#pattern": "^[a-z0-9][a-z0-9-]{1,52}[a-z0-9]$" + } + }, + "com.amazonaws.lightsail#BucketState": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The state code of the bucket.

\n

The following codes are possible:

\n " + } + }, + "message": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

A message that describes the state of the bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of an Amazon Lightsail bucket.

" + } + }, + "com.amazonaws.lightsail#Bundle": { + "type": "structure", + "members": { + "price": { + "target": "com.amazonaws.lightsail#float", + "traits": { + "smithy.api#documentation": "

The price in US dollars (e.g., 5.0) of the bundle.

" + } + }, + "cpuCount": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The number of vCPUs included in the bundle (e.g., 2).

" + } + }, + "diskSizeInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The size of the SSD (e.g., 30).

" + } + }, + "bundleId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The bundle ID (e.g., micro_1_0).

" + } + }, + "instanceType": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 instance type (e.g., t2.micro).

" + } + }, + "isActive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the bundle is active.

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

A friendly name for the bundle (e.g., Micro).

" + } + }, + "power": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

A numeric value that represents the power of the bundle (e.g., 500). You can\n use the bundle's power value in conjunction with a blueprint's minimum power value to\n determine whether the blueprint will run on the bundle. For example, you need a bundle with a\n power value of 500 or more to create an instance that uses a blueprint with a minimum power\n value of 500.

" + } + }, + "ramSizeInGb": { + "target": "com.amazonaws.lightsail#float", + "traits": { + "smithy.api#documentation": "

The amount of RAM in GB (e.g., 2.0).

" + } + }, + "transferPerMonthInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The data transfer rate per month in GB (e.g., 2000).

" + } + }, + "supportedPlatforms": { + "target": "com.amazonaws.lightsail#InstancePlatformList", + "traits": { + "smithy.api#documentation": "

The operating system platform (Linux/Unix-based or Windows Server-based) that the bundle\n supports. You can only launch a WINDOWS bundle on a blueprint that supports the\n WINDOWS platform. LINUX_UNIX blueprints require a\n LINUX_UNIX bundle.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a bundle, which is a set of specs describing your virtual private server (or\n instance).

" + } + }, + "com.amazonaws.lightsail#BundleList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Bundle" + } + }, + "com.amazonaws.lightsail#CacheBehavior": { + "type": "structure", + "members": { + "behavior": { + "target": "com.amazonaws.lightsail#BehaviorEnum", + "traits": { + "smithy.api#documentation": "

The cache behavior of the distribution.

\n

The following cache behaviors can be specified:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the default cache behavior of an Amazon Lightsail content delivery network (CDN)\n distribution.

" + } + }, + "com.amazonaws.lightsail#CacheBehaviorList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#CacheBehaviorPerPath" + } + }, + "com.amazonaws.lightsail#CacheBehaviorPerPath": { + "type": "structure", + "members": { + "path": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify\n wildcard directories (path/to/assets/*), and file types (*.html, *jpg,\n *js). Directories and file paths are case-sensitive.

\n

Examples:

\n " + } + }, + "behavior": { + "target": "com.amazonaws.lightsail#BehaviorEnum", + "traits": { + "smithy.api#documentation": "

The cache behavior for the specified path.

\n

You can specify one of the following per-path cache behaviors:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN)\n distribution.

\n

A per-path cache behavior is used to override, or add an exception to, the default cache\n behavior of a distribution. For example, if the cacheBehavior is set to\n cache, then a per-path cache behavior can be used to specify a directory, file,\n or file type that your distribution will cache. Alternately, if the distribution's\n cacheBehavior is dont-cache, then a per-path cache behavior can be\n used to specify a directory, file, or file type that your distribution will not cache.

" + } + }, + "com.amazonaws.lightsail#CacheSettings": { + "type": "structure", + "members": { + "defaultTTL": { + "target": "com.amazonaws.lightsail#long", + "traits": { + "smithy.api#documentation": "

The default amount of time that objects stay in the distribution's cache before the\n distribution forwards another request to the origin to determine whether the content has been\n updated.

\n \n

The value specified applies only when the origin does not add HTTP headers such as\n Cache-Control max-age, Cache-Control s-maxage, and\n Expires to objects.

\n " + } + }, + "minimumTTL": { + "target": "com.amazonaws.lightsail#long", + "traits": { + "smithy.api#documentation": "

The minimum amount of time that objects stay in the distribution's cache before the\n distribution forwards another request to the origin to determine whether the object has been\n updated.

\n

A value of 0 must be specified for minimumTTL if the\n distribution is configured to forward all headers to the origin.

" + } + }, + "maximumTTL": { + "target": "com.amazonaws.lightsail#long", + "traits": { + "smithy.api#documentation": "

The maximum amount of time that objects stay in the distribution's cache before the\n distribution forwards another request to the origin to determine whether the object has been\n updated.

\n

The value specified applies only when the origin adds HTTP headers such as\n Cache-Control max-age, Cache-Control s-maxage, and\n Expires to objects.

" + } + }, + "allowedHTTPMethods": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The HTTP methods that are processed and forwarded to the distribution's origin.

\n

You can specify the following options:

\n \n

If you specify the third option, you might need to restrict access to your distribution's\n origin so users can't perform operations that you don't want them to. For example, you might\n not want users to have permission to delete objects from your origin.

" + } + }, + "cachedHTTPMethods": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The HTTP method responses that are cached by your distribution.

\n

You can specify the following options:

\n " + } + }, + "forwardedCookies": { + "target": "com.amazonaws.lightsail#CookieObject", + "traits": { + "smithy.api#documentation": "

An object that describes the cookies that are forwarded to the origin. Your content is\n cached based on the cookies that are forwarded.

" + } + }, + "forwardedHeaders": { + "target": "com.amazonaws.lightsail#HeaderObject", + "traits": { + "smithy.api#documentation": "

An object that describes the headers that are forwarded to the origin. Your content is\n cached based on the headers that are forwarded.

" + } + }, + "forwardedQueryStrings": { + "target": "com.amazonaws.lightsail#QueryStringObject", + "traits": { + "smithy.api#documentation": "

An object that describes the query strings that are forwarded to the origin. Your content\n is cached based on the query strings that are forwarded.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the cache settings of an Amazon Lightsail content delivery network (CDN)\n distribution.

\n

These settings apply only to your distribution's cacheBehaviors (including\n the defaultCacheBehavior) that have a behavior of\n cache.

" + } + }, + "com.amazonaws.lightsail#Certificate": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate.

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#CertificateName", + "traits": { + "smithy.api#documentation": "

The name of the certificate (e.g., my-certificate).

" + } + }, + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name of the certificate.

" + } + }, + "status": { + "target": "com.amazonaws.lightsail#CertificateStatus", + "traits": { + "smithy.api#documentation": "

The validation status of the certificate.

" + } + }, + "serialNumber": { + "target": "com.amazonaws.lightsail#SerialNumber", + "traits": { + "smithy.api#documentation": "

The serial number of the certificate.

" + } + }, + "subjectAlternativeNames": { + "target": "com.amazonaws.lightsail#SubjectAlternativeNameList", + "traits": { + "smithy.api#documentation": "

An array of strings that specify the alternate domains (e.g., example2.com)\n and subdomains (e.g., blog.example.com) of the certificate.

" + } + }, + "domainValidationRecords": { + "target": "com.amazonaws.lightsail#DomainValidationRecordList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the domain validation records of the certificate.

" + } + }, + "requestFailureReason": { + "target": "com.amazonaws.lightsail#RequestFailureReason", + "traits": { + "smithy.api#documentation": "

The validation failure reason, if any, of the certificate.

\n

The following failure reasons are possible:

\n " + } + }, + "inUseResourceCount": { + "target": "com.amazonaws.lightsail#InUseResourceCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of Lightsail resources that the certificate is attached to.

" + } + }, + "keyAlgorithm": { + "target": "com.amazonaws.lightsail#KeyAlgorithm", + "traits": { + "smithy.api#documentation": "

The algorithm used to generate the key pair (the public and private key) of the\n certificate.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the certificate was created.

" + } + }, + "issuedAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the certificate was issued.

" + } + }, + "issuerCA": { + "target": "com.amazonaws.lightsail#IssuerCA", + "traits": { + "smithy.api#documentation": "

The certificate authority that issued the certificate.

" + } + }, + "notBefore": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the certificate is first valid.

" + } + }, + "notAfter": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the certificate expires.

" + } + }, + "eligibleToRenew": { + "target": "com.amazonaws.lightsail#EligibleToRenew", + "traits": { + "smithy.api#documentation": "

The renewal eligibility of the certificate.

" + } + }, + "renewalSummary": { + "target": "com.amazonaws.lightsail#RenewalSummary", + "traits": { + "smithy.api#documentation": "

An object that describes the status of the certificate renewal managed by\n Lightsail.

" + } + }, + "revokedAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the certificate was revoked. This value is present only when the\n certificate status is REVOKED.

" + } + }, + "revocationReason": { + "target": "com.amazonaws.lightsail#RevocationReason", + "traits": { + "smithy.api#documentation": "

The reason the certificate was revoked. This value is present only when the certificate\n status is REVOKED.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail certificate. This code enables our support team to look up your Lightsail\n information more easily.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the full details of an Amazon Lightsail SSL/TLS certificate.

\n \n

To get a summary of a certificate, use the GetCertificates action and ommit\n includeCertificateDetails from your request. The response will include only\n the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.

\n " + } + }, + "com.amazonaws.lightsail#CertificateDomainValidationStatus": { + "type": "enum", + "members": { + "PendingValidation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_VALIDATION" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "Success": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + } + } + }, + "com.amazonaws.lightsail#CertificateName": { + "type": "string" + }, + "com.amazonaws.lightsail#CertificateStatus": { + "type": "enum", + "members": { + "PendingValidation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_VALIDATION" + } + }, + "Issued": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ISSUED" + } + }, + "Inactive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, + "Expired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } + }, + "ValidationTimedOut": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_TIMED_OUT" + } + }, + "Revoked": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVOKED" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.lightsail#CertificateStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#CertificateStatus" + } + }, + "com.amazonaws.lightsail#CertificateSummary": { + "type": "structure", + "members": { + "certificateArn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate.

" + } + }, + "certificateName": { + "target": "com.amazonaws.lightsail#CertificateName", + "traits": { + "smithy.api#documentation": "

The name of the certificate.

" + } + }, + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name of the certificate.

" + } + }, + "certificateDetail": { + "target": "com.amazonaws.lightsail#Certificate", + "traits": { + "smithy.api#documentation": "

An object that describes a certificate in detail.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Amazon Lightsail SSL/TLS certificate.

" + } + }, + "com.amazonaws.lightsail#CertificateSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#CertificateSummary" + } + }, + "com.amazonaws.lightsail#CloseInstancePublicPorts": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CloseInstancePublicPortsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CloseInstancePublicPortsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Closes ports for a specific Amazon Lightsail instance.

\n

The CloseInstancePublicPorts action supports tag-based access control via\n resource tags applied to the resource identified by instanceName. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CloseInstancePublicPorts", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CloseInstancePublicPortsRequest": { + "type": "structure", + "members": { + "portInfo": { + "target": "com.amazonaws.lightsail#PortInfo", + "traits": { + "smithy.api#documentation": "

An object to describe the ports to close for the specified instance.

", + "smithy.api#required": {} + } + }, + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance for which to close ports.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#CloseInstancePublicPortsResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#CloudFormationStackRecord": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the CloudFormation stack record. It starts with\n CloudFormationStackRecord followed by a GUID.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudFormation stack record.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The date when the CloudFormation stack record was created.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

A list of objects describing the Availability Zone and Amazon Web Services Region of the\n CloudFormation stack record.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type (e.g., CloudFormationStackRecord).

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#RecordState", + "traits": { + "smithy.api#documentation": "

The current state of the CloudFormation stack record.

" + } + }, + "sourceInfo": { + "target": "com.amazonaws.lightsail#CloudFormationStackRecordSourceInfoList", + "traits": { + "smithy.api#documentation": "

A list of objects describing the source of the CloudFormation stack record.

" + } + }, + "destinationInfo": { + "target": "com.amazonaws.lightsail#DestinationInfo", + "traits": { + "smithy.api#documentation": "

A list of objects describing the destination service, which is AWS CloudFormation, and the Amazon\n Resource Name (ARN) of the AWS CloudFormation stack.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a CloudFormation stack record created as a result of the create cloud\n formation stack action.

\n

A CloudFormation stack record provides information about the AWS CloudFormation stack used to\n create a new Amazon Elastic Compute Cloud instance from an exported Lightsail instance snapshot.

" + } + }, + "com.amazonaws.lightsail#CloudFormationStackRecordList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#CloudFormationStackRecord" + } + }, + "com.amazonaws.lightsail#CloudFormationStackRecordSourceInfo": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.lightsail#CloudFormationStackRecordSourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type (e.g., ExportSnapshotRecord).

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the record.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the export snapshot record.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the source of a CloudFormation stack record (i.e., the export snapshot\n record).

" + } + }, + "com.amazonaws.lightsail#CloudFormationStackRecordSourceInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#CloudFormationStackRecordSourceInfo" + } + }, + "com.amazonaws.lightsail#CloudFormationStackRecordSourceType": { + "type": "enum", + "members": { + "ExportSnapshotRecord": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExportSnapshotRecord" + } + } + } + }, + "com.amazonaws.lightsail#ComparisonOperator": { + "type": "enum", + "members": { + "GreaterThanOrEqualToThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThanOrEqualToThreshold" + } + }, + "GreaterThanThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThanThreshold" + } + }, + "LessThanThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThanThreshold" + } + }, + "LessThanOrEqualToThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThanOrEqualToThreshold" + } + } + } + }, + "com.amazonaws.lightsail#ContactMethod": { + "type": "structure", + "members": { + "contactEndpoint": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The destination of the contact method, such as an email address or a mobile phone\n number.

" + } + }, + "status": { + "target": "com.amazonaws.lightsail#ContactMethodStatus", + "traits": { + "smithy.api#documentation": "

The current status of the contact method.

\n

A contact method has the following possible status:

\n " + } + }, + "protocol": { + "target": "com.amazonaws.lightsail#ContactProtocol", + "traits": { + "smithy.api#documentation": "

The protocol of the contact method, such as email or SMS (text messaging).

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the contact method.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the contact method.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the contact method was created.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

An object that describes the location of the contact method, such as the Amazon Web Services Region and Availability Zone.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type (e.g., ContactMethod).

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail contact method. This code enables our support team to look up your\n Lightsail information more easily.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a contact method.

\n

A contact method is a way to send you notifications. For more information, see Notifications in Amazon Lightsail.

" + } + }, + "com.amazonaws.lightsail#ContactMethodStatus": { + "type": "enum", + "members": { + "PendingVerification": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PendingVerification" + } + }, + "Valid": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Valid" + } + }, + "Invalid": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Invalid" + } + } + } + }, + "com.amazonaws.lightsail#ContactMethodVerificationProtocol": { + "type": "enum", + "members": { + "Email": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Email" + } + } + } + }, + "com.amazonaws.lightsail#ContactMethodsList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#ContactMethod" + } + }, + "com.amazonaws.lightsail#ContactProtocol": { + "type": "enum", + "members": { + "Email": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Email" + } + }, + "SMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMS" + } + } + } + }, + "com.amazonaws.lightsail#ContactProtocolsList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#ContactProtocol" + } + }, + "com.amazonaws.lightsail#Container": { + "type": "structure", + "members": { + "image": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the image used for the container.

\n

Container images sourced from your Lightsail container service, that are registered and\n stored on your service, start with a colon (:). For example, if your container\n service name is container-service-1, the container image label is\n mystaticsite, and you want to use the third (3) version of the\n registered container image, then you should specify\n :container-service-1.mystaticsite.3. To use the latest version of a container\n image, specify latest instead of a version number (for example,\n :container-service-1.mystaticsite.latest). Lightsail will automatically use\n the highest numbered version of the registered container image.

\n

Container images sourced from a public registry like Docker Hub don't start with a colon.\n For example, nginx:latest or nginx.

" + } + }, + "command": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The launch command for the container.

" + } + }, + "environment": { + "target": "com.amazonaws.lightsail#Environment", + "traits": { + "smithy.api#documentation": "

The environment variables of the container.

" + } + }, + "ports": { + "target": "com.amazonaws.lightsail#PortMap", + "traits": { + "smithy.api#documentation": "

The open firewall ports of the container.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the settings of a container that will be launched, or that is launched, to an\n Amazon Lightsail container service.

" + } + }, + "com.amazonaws.lightsail#ContainerImage": { + "type": "structure", + "members": { + "image": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the container image.

" + } + }, + "digest": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The digest of the container image.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the container image was created.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a container image that is registered to an Amazon Lightsail container\n service.

" + } + }, + "com.amazonaws.lightsail#ContainerImageList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#ContainerImage" + } + }, + "com.amazonaws.lightsail#ContainerLabel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 53 + }, + "smithy.api#pattern": "^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$" + } + }, + "com.amazonaws.lightsail#ContainerMap": { + "type": "map", + "key": { + "target": "com.amazonaws.lightsail#ContainerName" + }, + "value": { + "target": "com.amazonaws.lightsail#Container" + } + }, + "com.amazonaws.lightsail#ContainerName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 53 + }, + "smithy.api#pattern": "^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$" + } + }, + "com.amazonaws.lightsail#ContainerService": { + "type": "structure", + "members": { + "containerServiceName": { + "target": "com.amazonaws.lightsail#ContainerServiceName", + "traits": { + "smithy.api#documentation": "

The name of the container service.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container service.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the container service was created.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

An object that describes the location of the container service, such as the Amazon Web Services Region and Availability Zone.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type of the container service (i.e.,\n ContainerService).

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + }, + "power": { + "target": "com.amazonaws.lightsail#ContainerServicePowerName", + "traits": { + "smithy.api#documentation": "

The power specification of the container service.

\n

The power specifies the amount of RAM, the number of vCPUs, and the base price of the\n container service.

" + } + }, + "powerId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The ID of the power of the container service.

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#ContainerServiceState", + "traits": { + "smithy.api#documentation": "

The current state of the container service.

\n

The following container service states are possible:

\n " + } + }, + "stateDetail": { + "target": "com.amazonaws.lightsail#ContainerServiceStateDetail", + "traits": { + "smithy.api#documentation": "

An object that describes the current state of the container service.

\n \n

The state detail is populated only when a container service is in a\n PENDING, DEPLOYING, or UPDATING state.

\n " + } + }, + "scale": { + "target": "com.amazonaws.lightsail#ContainerServiceScale", + "traits": { + "smithy.api#documentation": "

The scale specification of the container service.

\n

The scale specifies the allocated compute nodes of the container service.

" + } + }, + "currentDeployment": { + "target": "com.amazonaws.lightsail#ContainerServiceDeployment", + "traits": { + "smithy.api#documentation": "

An object that describes the current container deployment of the container service.

" + } + }, + "nextDeployment": { + "target": "com.amazonaws.lightsail#ContainerServiceDeployment", + "traits": { + "smithy.api#documentation": "

An object that describes the next deployment of the container service.

\n

This value is null when there is no deployment in a pending\n state.

" + } + }, + "isDisabled": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the container service is disabled.

" + } + }, + "principalArn": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The principal ARN of the container service.

\n

The principal ARN can be used to create a trust relationship between your standard Amazon Web Services account and your Lightsail container service. This allows you to give your\n service permission to access resources in your standard Amazon Web Services account.

" + } + }, + "privateDomainName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The private domain name of the container service.

\n

The private domain name is accessible only by other resources within the default virtual\n private cloud (VPC) of your Lightsail account.

" + } + }, + "publicDomainNames": { + "target": "com.amazonaws.lightsail#ContainerServicePublicDomains", + "traits": { + "smithy.api#documentation": "

The public domain name of the container service, such as example.com and\n www.example.com.

\n

You can specify up to four public domain names for a container service. The domain names\n that you specify are used when you create a deployment with a container configured as the\n public endpoint of your container service.

\n

If you don't specify public domain names, then you can use the default domain of the\n container service.

\n \n

You must create and validate an SSL/TLS certificate before you can use public domain\n names with your container service. Use the CreateCertificate action to create a\n certificate for the public domain names you want to use with your container service.

\n \n

See CreateContainerService or UpdateContainerService for\n information about how to specify public domain names for your Lightsail container\n service.

" + } + }, + "url": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The publicly accessible URL of the container service.

\n

If no public endpoint is specified in the currentDeployment, this URL returns\n a 404 response.

" + } + }, + "privateRegistryAccess": { + "target": "com.amazonaws.lightsail#PrivateRegistryAccess", + "traits": { + "smithy.api#documentation": "

An object that describes the configuration for the container service to access private\n container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private\n repositories.

\n

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Amazon Lightsail container service.

" + } + }, + "com.amazonaws.lightsail#ContainerServiceDeployment": { + "type": "structure", + "members": { + "version": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The version number of the deployment.

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#ContainerServiceDeploymentState", + "traits": { + "smithy.api#documentation": "

The state of the deployment.

\n

A deployment can be in one of the following states:

\n " + } + }, + "containers": { + "target": "com.amazonaws.lightsail#ContainerMap", + "traits": { + "smithy.api#documentation": "

An object that describes the configuration for the containers of the deployment.

" + } + }, + "publicEndpoint": { + "target": "com.amazonaws.lightsail#ContainerServiceEndpoint", + "traits": { + "smithy.api#documentation": "

An object that describes the endpoint of the deployment.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the deployment was created.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a container deployment configuration of an Amazon Lightsail container\n service.

\n

A deployment specifies the settings, such as the ports and launch command, of containers\n that are deployed to your container service.

" + } + }, + "com.amazonaws.lightsail#ContainerServiceDeploymentList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#ContainerServiceDeployment" + } + }, + "com.amazonaws.lightsail#ContainerServiceDeploymentRequest": { + "type": "structure", + "members": { + "containers": { + "target": "com.amazonaws.lightsail#ContainerMap", + "traits": { + "smithy.api#documentation": "

An object that describes the configuration for the containers of the deployment.

" + } + }, + "publicEndpoint": { + "target": "com.amazonaws.lightsail#EndpointRequest", + "traits": { + "smithy.api#documentation": "

An object that describes the endpoint of the deployment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a container deployment configuration of an Amazon Lightsail container\n service.

\n

A deployment specifies the settings, such as the ports and launch command, of containers\n that are deployed to your container service.

" + } + }, + "com.amazonaws.lightsail#ContainerServiceDeploymentState": { + "type": "enum", + "members": { + "ACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.lightsail#ContainerServiceECRImagePullerRole": { + "type": "structure", + "members": { + "isActive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether the role is activated.

" + } + }, + "principalArn": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role, if it is activated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the activation status of the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR)\n private repositories.

\n

When activated, Lightsail creates an Identity and Access Management (IAM) role\n for the specified Lightsail container service. You can use the ARN of the role to create a\n trust relationship between your Lightsail container service and an Amazon ECR private repository in your Amazon Web Services account. This allows your container\n service to pull images from Amazon ECR private repositories. For more information, see\n Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" + } + }, + "com.amazonaws.lightsail#ContainerServiceECRImagePullerRoleRequest": { + "type": "structure", + "members": { + "isActive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether to activate the role.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a request to activate or deactivate the role that you can use to grant an\n Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.

\n

When activated, Lightsail creates an Identity and Access Management (IAM) role\n for the specified Lightsail container service. You can use the ARN of the role to create a\n trust relationship between your Lightsail container service and an Amazon ECR private repository in your Amazon Web Services account. This allows your container\n service to pull images from Amazon ECR private repositories. For more information, see\n Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" + } + }, + "com.amazonaws.lightsail#ContainerServiceEndpoint": { + "type": "structure", + "members": { + "containerName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the container entry of the deployment that the endpoint configuration applies\n to.

" + } + }, + "containerPort": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The port of the specified container to which traffic is forwarded to.

" + } + }, + "healthCheck": { + "target": "com.amazonaws.lightsail#ContainerServiceHealthCheckConfig", + "traits": { + "smithy.api#documentation": "

An object that describes the health check configuration of the container.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the public endpoint configuration of a deployment of an Amazon Lightsail\n container service.

" + } + }, + "com.amazonaws.lightsail#ContainerServiceHealthCheckConfig": { + "type": "structure", + "members": { + "healthyThreshold": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The number of consecutive health checks successes required before moving the container to\n the Healthy state. The default value is 2.

" + } + }, + "unhealthyThreshold": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The number of consecutive health check failures required before moving the container to\n the Unhealthy state. The default value is 2.

" + } + }, + "timeoutSeconds": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, during which no response means a failed health check. You\n can specify between 2 and 60 seconds. The default value is 2.

" + } + }, + "intervalSeconds": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The approximate interval, in seconds, between health checks of an individual container.\n You can specify between 5 and 300 seconds. The default value is 5.

" + } + }, + "path": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The path on the container on which to perform the health check. The default value is\n /.

" + } + }, + "successCodes": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The HTTP codes to use when checking for a successful response from a container. You can\n specify values between 200 and 499. You can specify multiple values\n (for example, 200,202) or a range of values (for example,\n 200-299).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the health check configuration of an Amazon Lightsail container service.

" + } + }, + "com.amazonaws.lightsail#ContainerServiceList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#ContainerService" + } + }, + "com.amazonaws.lightsail#ContainerServiceLogEvent": { + "type": "structure", + "members": { + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the container service log event was created.

" + } + }, + "message": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The message of the container service log event.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the log events of a container of an Amazon Lightsail container service.

" + } + }, + "com.amazonaws.lightsail#ContainerServiceLogEventList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#ContainerServiceLogEvent" + } + }, + "com.amazonaws.lightsail#ContainerServiceMetadataEntry": { + "type": "map", + "key": { + "target": "com.amazonaws.lightsail#string" + }, + "value": { + "target": "com.amazonaws.lightsail#string" + } + }, + "com.amazonaws.lightsail#ContainerServiceMetadataEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#ContainerServiceMetadataEntry" + } + }, + "com.amazonaws.lightsail#ContainerServiceMetricName": { + "type": "enum", + "members": { + "CPUUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CPUUtilization" + } + }, + "MemoryUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MemoryUtilization" + } + } + } + }, + "com.amazonaws.lightsail#ContainerServiceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$" + } + }, + "com.amazonaws.lightsail#ContainerServicePower": { + "type": "structure", + "members": { + "powerId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The ID of the power (e.g., nano-1).

" + } + }, + "price": { + "target": "com.amazonaws.lightsail#float", + "traits": { + "smithy.api#documentation": "

The monthly price of the power in USD.

" + } + }, + "cpuCount": { + "target": "com.amazonaws.lightsail#float", + "traits": { + "smithy.api#documentation": "

The number of vCPUs included in the power.

" + } + }, + "ramSizeInGb": { + "target": "com.amazonaws.lightsail#float", + "traits": { + "smithy.api#documentation": "

The amount of RAM (in GB) of the power.

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The friendly name of the power (e.g., nano).

" + } + }, + "isActive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the power is active and can be specified for container\n services.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the powers that can be specified for an Amazon Lightsail container\n service.

\n

The power specifies the amount of RAM, the number of vCPUs, and the base price of the\n container service.

" + } + }, + "com.amazonaws.lightsail#ContainerServicePowerList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#ContainerServicePower" + } + }, + "com.amazonaws.lightsail#ContainerServicePowerName": { + "type": "enum", + "members": { + "nano": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nano" + } + }, + "micro": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "micro" + } + }, + "small": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "small" + } + }, + "medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "medium" + } + }, + "large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "large" + } + }, + "xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "xlarge" + } + } + } + }, + "com.amazonaws.lightsail#ContainerServiceProtocol": { + "type": "enum", + "members": { + "HTTP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP" + } + }, + "HTTPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPS" + } + }, + "TCP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TCP" + } + }, + "UDP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UDP" + } + } + } + }, + "com.amazonaws.lightsail#ContainerServicePublicDomains": { + "type": "map", + "key": { + "target": "com.amazonaws.lightsail#string" + }, + "value": { + "target": "com.amazonaws.lightsail#ContainerServicePublicDomainsList" + } + }, + "com.amazonaws.lightsail#ContainerServicePublicDomainsList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#string" + } + }, + "com.amazonaws.lightsail#ContainerServiceRegistryLogin": { + "type": "structure", + "members": { + "username": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The container service registry username to use to push container images to the container\n image registry of a Lightsail account.

" + } + }, + "password": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The container service registry password to use to push container images to the container\n image registry of a Lightsail account

" + } + }, + "expiresAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp of when the container image registry username and password expire.

\n

The log in credentials expire 12 hours after they are created, at which point you will\n need to create a new set of log in credentials using the\n CreateContainerServiceRegistryLogin action.

" + } + }, + "registry": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The address to use to push container images to the container image registry of a\n Lightsail account.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the login information for the container image registry of an Amazon Lightsail\n account.

" + } + }, + "com.amazonaws.lightsail#ContainerServiceScale": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.lightsail#ContainerServiceState": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "DEPLOYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPLOYING" + } + } + } + }, + "com.amazonaws.lightsail#ContainerServiceStateDetail": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#ContainerServiceStateDetailCode", + "traits": { + "smithy.api#documentation": "

The state code of the container service.

\n

The following state codes are possible:

\n " + } + }, + "message": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

A message that provides more information for the state code.

\n \n

The state detail is populated only when a container service is in a\n PENDING, DEPLOYING, or UPDATING state.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the current state of a container service.

" + } + }, + "com.amazonaws.lightsail#ContainerServiceStateDetailCode": { + "type": "enum", + "members": { + "CREATING_SYSTEM_RESOURCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING_SYSTEM_RESOURCES" + } + }, + "CREATING_NETWORK_INFRASTRUCTURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING_NETWORK_INFRASTRUCTURE" + } + }, + "PROVISIONING_CERTIFICATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROVISIONING_CERTIFICATE" + } + }, + "PROVISIONING_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROVISIONING_SERVICE" + } + }, + "CREATING_DEPLOYMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING_DEPLOYMENT" + } + }, + "EVALUATING_HEALTH_CHECK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVALUATING_HEALTH_CHECK" + } + }, + "ACTIVATING_DEPLOYMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATING_DEPLOYMENT" + } + }, + "CERTIFICATE_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CERTIFICATE_LIMIT_EXCEEDED" + } + }, + "UNKNOWN_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN_ERROR" + } + } + } + }, + "com.amazonaws.lightsail#ContainerServicesListResult": { + "type": "structure", + "members": { + "containerServices": { + "target": "com.amazonaws.lightsail#ContainerServiceList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe one or more container services.

" + } + } + } + }, + "com.amazonaws.lightsail#CookieObject": { + "type": "structure", + "members": { + "option": { + "target": "com.amazonaws.lightsail#ForwardValues", + "traits": { + "smithy.api#documentation": "

Specifies which cookies to forward to the distribution's origin for a cache behavior:\n all, none, or allow-list to forward only the cookies\n specified in the cookiesAllowList parameter.

" + } + }, + "cookiesAllowList": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The specific cookies to forward to your distribution's origin.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes whether an Amazon Lightsail content delivery network (CDN) distribution forwards\n cookies to the origin and, if so, which ones.

\n

For the cookies that you specify, your distribution caches separate versions of the\n specified content based on the cookie values in viewer\n requests.

" + } + }, + "com.amazonaws.lightsail#CopySnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CopySnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CopySnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an\n automatic snapshot of an instance or disk as a manual snapshot. This operation can also be\n used to copy a manual or automatic snapshot of an instance or a disk from one Amazon Web Services Region to another in Amazon Lightsail.

\n

When copying a manual snapshot, be sure to define the source\n region, source snapshot name, and target snapshot name\n parameters.

\n

When copying an automatic snapshot, be sure to define the\n source region, source resource name, target snapshot\n name, and either the restore date or the use latest restorable\n auto snapshot parameters.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CopySnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CopySnapshotRequest": { + "type": "structure", + "members": { + "sourceSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the source manual snapshot to copy.

\n

Constraint:

\n " + } + }, + "sourceResourceName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the source instance or disk from which the source automatic snapshot was\n created.

\n

Constraint:

\n " + } + }, + "restoreDate": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The date of the source automatic snapshot to copy. Use the get auto snapshots\n operation to identify the dates of the available automatic snapshots.

\n

Constraints:

\n " + } + }, + "useLatestRestorableAutoSnapshot": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value to indicate whether to use the latest available automatic snapshot of the\n specified source instance or disk.

\n

Constraints:

\n " + } + }, + "targetSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the new manual snapshot to be created as a copy.

", + "smithy.api#required": {} + } + }, + "sourceRegion": { + "target": "com.amazonaws.lightsail#RegionName", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region where the source manual or automatic snapshot is\n located.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#CopySnapshotResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateBucket": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateBucketRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateBucketResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon Lightsail bucket.

\n

A bucket is a cloud storage resource available in the Lightsail object storage service.\n Use buckets to store objects such as data and its descriptive metadata. For more information\n about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer\n Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateBucket", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateBucketAccessKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateBucketAccessKeyRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateBucketAccessKeyResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of\n an access key ID and corresponding secret access key.

\n

Access keys grant full programmatic access to the specified bucket and its objects. You\n can have a maximum of two access keys per bucket. Use the GetBucketAccessKeys action to get a list of current access keys for a specific bucket. For more\n information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

\n \n

The secretAccessKey value is returned only in response to the\n CreateBucketAccessKey action. You can get a secret access key only when you\n first create an access key; you cannot get the secret access key later. If you lose the\n secret access key, you must create a new access key.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateBucketAccessKey", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateBucketAccessKeyRequest": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.lightsail#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket that the new access key will belong to, and grant access to.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#CreateBucketAccessKeyResult": { + "type": "structure", + "members": { + "accessKey": { + "target": "com.amazonaws.lightsail#AccessKey", + "traits": { + "smithy.api#documentation": "

An object that describes the access key that is created.

" + } + }, + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateBucketRequest": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.lightsail#BucketName", + "traits": { + "smithy.api#documentation": "

The name for the bucket.

\n

For more information about bucket names, see Bucket naming rules in Amazon Lightsail in the Amazon Lightsail Developer\n Guide.

", + "smithy.api#required": {} + } + }, + "bundleId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the bundle to use for the bucket.

\n

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\n bucket.

\n

Use the GetBucketBundles action to get a list of\n bundle IDs that you can specify.

\n

Use the UpdateBucketBundle action to change the\n bundle after the bucket is created.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the bucket during creation.

\n

Use the TagResource action to tag the bucket after it's\n created.

" + } + }, + "enableObjectVersioning": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether to enable versioning of objects in the\n bucket.

\n

For more information about versioning, see Enabling and suspending object versioning in a bucket in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateBucketResult": { + "type": "structure", + "members": { + "bucket": { + "target": "com.amazonaws.lightsail#Bucket", + "traits": { + "smithy.api#documentation": "

An object that describes the bucket that is created.

" + } + }, + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateCertificateRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateCertificateResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN)\n distribution and a container service.

\n

After the certificate is valid, use the AttachCertificateToDistribution\n action to use the certificate and its domains with your distribution. Or use the\n UpdateContainerService action to use the certificate and its domains with your\n container service.

\n \n

Only certificates created in the us-east-1\n Amazon Web Services Region can be attached to Lightsail distributions. Lightsail\n distributions are global resources that can reference an origin in any Amazon Web Services\n Region, and distribute its content globally. However, all distributions are located in the\n us-east-1 Region.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateCertificate", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateCertificateRequest": { + "type": "structure", + "members": { + "certificateName": { + "target": "com.amazonaws.lightsail#CertificateName", + "traits": { + "smithy.api#documentation": "

The name for the certificate.

", + "smithy.api#required": {} + } + }, + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name (e.g., example.com) for the certificate.

", + "smithy.api#required": {} + } + }, + "subjectAlternativeNames": { + "target": "com.amazonaws.lightsail#SubjectAlternativeNameList", + "traits": { + "smithy.api#documentation": "

An array of strings that specify the alternate domains (e.g., example2.com)\n and subdomains (e.g., blog.example.com) for the certificate.

\n

You can specify a maximum of nine alternate domains (in addition to the primary domain\n name).

\n

Wildcard domain entries (e.g., *.example.com) are not supported.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the certificate during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateCertificateResult": { + "type": "structure", + "members": { + "certificate": { + "target": "com.amazonaws.lightsail#CertificateSummary", + "traits": { + "smithy.api#documentation": "

An object that describes the certificate created.

" + } + }, + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateCloudFormationStack": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateCloudFormationStackRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateCloudFormationStackResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported\n Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be\n used to track the AWS CloudFormation stack created. Use the get cloud formation stack\n records operation to get a list of the CloudFormation stacks created.

\n \n

Wait until after your new Amazon EC2 instance is created before running the create\n cloud formation stack operation again with the same export snapshot record.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateCloudFormationStack", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateCloudFormationStackRequest": { + "type": "structure", + "members": { + "instances": { + "target": "com.amazonaws.lightsail#InstanceEntryList", + "traits": { + "smithy.api#documentation": "

An array of parameters that will be used to create the new Amazon EC2 instance. You can only\n pass one instance entry at a time in this array. You will get an invalid parameter error if\n you pass more than one instance entry in this array.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#CreateCloudFormationStackResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateContactMethod": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateContactMethodRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateContactMethodResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an email or SMS text message contact method.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services\n Regions, and SMS text messages cannot be sent to some countries/regions. For more information,\n see Notifications in Amazon Lightsail.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateContactMethod", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateContactMethodRequest": { + "type": "structure", + "members": { + "protocol": { + "target": "com.amazonaws.lightsail#ContactProtocol", + "traits": { + "smithy.api#documentation": "

The protocol of the contact method, such as Email or SMS (text\n messaging).

\n

The SMS protocol is supported only in the following Amazon Web Services\n Regions.

\n \n

For a list of countries/regions where SMS text messages can be sent, and the latest\n Amazon Web Services Regions where SMS text messaging is supported, see Supported Regions and Countries in the Amazon SNS Developer\n Guide.

\n

For more information about notifications in Amazon Lightsail, see Notifications in Amazon Lightsail.

", + "smithy.api#required": {} + } + }, + "contactEndpoint": { + "target": "com.amazonaws.lightsail#StringMax256", + "traits": { + "smithy.api#documentation": "

The destination of the contact method, such as an email address or a mobile phone\n number.

\n

Use the E.164 format when specifying a mobile phone number. E.164 is a standard for the\n phone number structure used for international telecommunication. Phone numbers that follow\n this format can have a maximum of 15 digits, and they are prefixed with the plus character (+)\n and the country code. For example, a U.S. phone number in E.164 format would be specified as\n +1XXX5550100. For more information, see E.164 on Wikipedia.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#CreateContactMethodResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateContainerService": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateContainerServiceRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateContainerServiceResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon Lightsail container service.

\n

A Lightsail container service is a compute resource to which you can deploy containers.\n For more information, see Container services in Amazon Lightsail in the Lightsail Dev\n Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/container-services", + "code": 201 + } + } + }, + "com.amazonaws.lightsail#CreateContainerServiceDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateContainerServiceDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateContainerServiceDeploymentResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a deployment for your Amazon Lightsail container service.

\n

A deployment specifies the containers that will be launched on the container service and\n their settings, such as the ports to open, the environment variables to apply, and the launch\n command to run. It also specifies the container that will serve as the public endpoint of the\n deployment and its settings, such as the HTTP or HTTPS port to use, and the health check\n configuration.

\n

You can deploy containers to your container service using container images from a public\n registry such as Amazon ECR Public, or from your local machine. For more information, see\n Creating container images for your Amazon Lightsail container services in the\n Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/container-services/{serviceName}/deployments", + "code": 201 + } + } + }, + "com.amazonaws.lightsail#CreateContainerServiceDeploymentRequest": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.lightsail#ContainerServiceName", + "traits": { + "smithy.api#documentation": "

The name of the container service for which to create the deployment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "containers": { + "target": "com.amazonaws.lightsail#ContainerMap", + "traits": { + "smithy.api#documentation": "

An object that describes the settings of the containers that will be launched on the\n container service.

" + } + }, + "publicEndpoint": { + "target": "com.amazonaws.lightsail#EndpointRequest", + "traits": { + "smithy.api#documentation": "

An object that describes the settings of the public endpoint for the container\n service.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateContainerServiceDeploymentResult": { + "type": "structure", + "members": { + "containerService": { + "target": "com.amazonaws.lightsail#ContainerService", + "traits": { + "smithy.api#documentation": "

An object that describes a container service.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateContainerServiceRegistryLogin": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateContainerServiceRegistryLoginRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateContainerServiceRegistryLoginResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a temporary set of log in credentials that you can use to log in to the Docker\n process on your local machine. After you're logged in, you can use the native Docker commands\n to push your local container images to the container image registry of your Amazon Lightsail\n account so that you can use them with your Lightsail container service. The log in\n credentials expire 12 hours after they are created, at which point you will need to create a\n new set of log in credentials.

\n \n

You can only push container images to the container service registry of your Lightsail\n account. You cannot pull container images or perform any other container image management\n actions on the container service registry.

\n \n

After you push your container images to the container image registry of your Lightsail\n account, use the RegisterContainerImage action to register the pushed images to a\n specific Lightsail container service.

\n \n

This action is not required if you install and use the Lightsail Control\n (lightsailctl) plugin to push container images to your Lightsail container service. For\n more information, see Pushing and managing container images on your Amazon Lightsail container services\n in the Amazon Lightsail Developer Guide.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/container-registry-login", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateContainerServiceRegistryLoginRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.lightsail#CreateContainerServiceRegistryLoginResult": { + "type": "structure", + "members": { + "registryLogin": { + "target": "com.amazonaws.lightsail#ContainerServiceRegistryLogin", + "traits": { + "smithy.api#documentation": "

An object that describes the log in information for the container service registry of your\n Lightsail account.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateContainerServiceRequest": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.lightsail#ContainerServiceName", + "traits": { + "smithy.api#documentation": "

The name for the container service.

\n

The name that you specify for your container service will make up part of its default\n domain. The default domain of a container service is typically\n https://...cs.amazonlightsail.com.\n If the name of your container service is container-service-1, and it's located in\n the US East (Ohio) Amazon Web Services Region (us-east-2), then the domain for\n your container service will be like the following example:\n https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com\n

\n

The following are the requirements for container service names:

\n ", + "smithy.api#required": {} + } + }, + "power": { + "target": "com.amazonaws.lightsail#ContainerServicePowerName", + "traits": { + "smithy.api#documentation": "

The power specification for the container service.

\n

The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the\n container service. The power and scale of a container service makes\n up its configured capacity. To determine the monthly price of your container service, multiply\n the base price of the power with the scale (the number of nodes) of\n the service.

\n

Use the GetContainerServicePowers action to get a list of power options that\n you can specify using this parameter, and their base monthly cost.

", + "smithy.api#required": {} + } + }, + "scale": { + "target": "com.amazonaws.lightsail#ContainerServiceScale", + "traits": { + "smithy.api#documentation": "

The scale specification for the container service.

\n

The scale specifies the allocated compute nodes of the container service. The\n power and scale of a container service makes up its configured\n capacity. To determine the monthly price of your container service, multiply the base price of\n the power with the scale (the number of nodes) of the\n service.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the container service during create.

\n

Use the TagResource action to tag a resource after it's created.

\n

For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

" + } + }, + "publicDomainNames": { + "target": "com.amazonaws.lightsail#ContainerServicePublicDomains", + "traits": { + "smithy.api#documentation": "

The public domain names to use with the container service, such as\n example.com and www.example.com.

\n

You can specify up to four public domain names for a container service. The domain names\n that you specify are used when you create a deployment with a container configured as the\n public endpoint of your container service.

\n

If you don't specify public domain names, then you can use the default domain of the\n container service.

\n \n

You must create and validate an SSL/TLS certificate before you can use public domain\n names with your container service. Use the CreateCertificate action to create a\n certificate for the public domain names you want to use with your container service.

\n \n

You can specify public domain names using a string to array map as shown in the example\n later on this page.

" + } + }, + "deployment": { + "target": "com.amazonaws.lightsail#ContainerServiceDeploymentRequest", + "traits": { + "smithy.api#documentation": "

An object that describes a deployment for the container service.

\n

A deployment specifies the containers that will be launched on the container service and\n their settings, such as the ports to open, the environment variables to apply, and the launch\n command to run. It also specifies the container that will serve as the public endpoint of the\n deployment and its settings, such as the HTTP or HTTPS port to use, and the health check\n configuration.

" + } + }, + "privateRegistryAccess": { + "target": "com.amazonaws.lightsail#PrivateRegistryAccessRequest", + "traits": { + "smithy.api#documentation": "

An object to describe the configuration for the container service to access private\n container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private\n repositories.

\n

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateContainerServiceResult": { + "type": "structure", + "members": { + "containerService": { + "target": "com.amazonaws.lightsail#ContainerService", + "traits": { + "smithy.api#documentation": "

An object that describes a container service.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateDisk": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateDiskRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateDiskResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a block storage disk that can be attached to an Amazon Lightsail instance in the\n same Availability Zone (e.g., us-east-2a).

\n

The create disk operation supports tag-based access control via request tags.\n For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateDisk", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateDiskFromSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateDiskFromSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateDiskFromSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting\n disk can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g.,\n us-east-2a).

\n

The create disk from snapshot operation supports tag-based access control via\n request tags and resource tags applied to the resource identified by disk snapshot\n name. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateDiskFromSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateDiskFromSnapshotRequest": { + "type": "structure", + "members": { + "diskName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The unique Lightsail disk name (e.g., my-disk).

", + "smithy.api#required": {} + } + }, + "diskSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the disk snapshot (e.g., my-snapshot) from which to create the\n new storage disk.

\n

Constraint:

\n " + } + }, + "availabilityZone": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Availability Zone where you want to create the disk (e.g., us-east-2a).\n Choose the same Availability Zone as the Lightsail instance where you want to create the\n disk.

\n

Use the GetRegions operation to list the Availability Zones where Lightsail is currently\n available.

", + "smithy.api#required": {} + } + }, + "sizeInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The size of the disk in GB (e.g., 32).

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + }, + "addOns": { + "target": "com.amazonaws.lightsail#AddOnRequestList", + "traits": { + "smithy.api#documentation": "

An array of objects that represent the add-ons to enable for the new disk.

" + } + }, + "sourceDiskName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the source disk from which the source automatic snapshot was created.

\n

Constraints:

\n " + } + }, + "restoreDate": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The date of the automatic snapshot to use for the new disk. Use the get auto\n snapshots operation to identify the dates of the available automatic\n snapshots.

\n

Constraints:

\n " + } + }, + "useLatestRestorableAutoSnapshot": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value to indicate whether to use the latest available automatic snapshot.

\n

Constraints:

\n " + } + } + } + }, + "com.amazonaws.lightsail#CreateDiskFromSnapshotResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateDiskRequest": { + "type": "structure", + "members": { + "diskName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The unique Lightsail disk name (e.g., my-disk).

", + "smithy.api#required": {} + } + }, + "availabilityZone": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Availability Zone where you want to create the disk (e.g., us-east-2a).\n Use the same Availability Zone as the Lightsail instance to which you want to attach the\n disk.

\n

Use the get regions operation to list the Availability Zones where\n Lightsail is currently available.

", + "smithy.api#required": {} + } + }, + "sizeInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The size of the disk in GB (e.g., 32).

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + }, + "addOns": { + "target": "com.amazonaws.lightsail#AddOnRequestList", + "traits": { + "smithy.api#documentation": "

An array of objects that represent the add-ons to enable for the new disk.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateDiskResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateDiskSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateDiskSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateDiskSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a snapshot of a block storage disk. You can use snapshots for backups, to make\n copies of disks, and to save data before shutting down a Lightsail instance.

\n

You can take a snapshot of an attached disk that is in use; however, snapshots only\n capture data that has been written to your disk at the time the snapshot command is issued.\n This may exclude any data that has been cached by any applications or the operating system. If\n you can pause any file systems on the disk long enough to take a snapshot, your snapshot\n should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should\n unmount the disk from within the Lightsail instance, issue the create disk snapshot command,\n and then remount the disk to ensure a consistent and complete snapshot. You may remount and\n use your disk while the snapshot status is pending.

\n

You can also use this operation to create a snapshot of an instance's system volume. You\n might want to do this, for example, to recover data from the system volume of a botched\n instance or to create a backup of the system volume like you would for a block storage disk.\n To create a snapshot of a system volume, just define the instance name parameter\n when issuing the snapshot command, and a snapshot of the defined instance's system volume will\n be created. After the snapshot is available, you can create a block storage disk from the\n snapshot and attach it to a running instance to access the data on the disk.

\n

The create disk snapshot operation supports tag-based access control via\n request tags. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateDiskSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateDiskSnapshotRequest": { + "type": "structure", + "members": { + "diskName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The unique name of the source disk (e.g., Disk-Virginia-1).

\n \n

This parameter cannot be defined together with the instance name parameter.\n The disk name and instance name parameters are mutually\n exclusive.

\n " + } + }, + "diskSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the destination disk snapshot (e.g., my-disk-snapshot) based on\n the source disk.

", + "smithy.api#required": {} + } + }, + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The unique name of the source instance (e.g., Amazon_Linux-512MB-Virginia-1).\n When this is defined, a snapshot of the instance's system volume is created.

\n \n

This parameter cannot be defined together with the disk name parameter. The\n instance name and disk name parameters are mutually\n exclusive.

\n " + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateDiskSnapshotResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateDistribution": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateDistributionRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateDistributionResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon Lightsail content delivery network (CDN) distribution.

\n

A distribution is a globally distributed network of caching servers that improve the\n performance of your website or web application hosted on a Lightsail instance. For more\n information, see Content delivery networks in Amazon Lightsail.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateDistribution", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateDistributionRequest": { + "type": "structure", + "members": { + "distributionName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name for the distribution.

", + "smithy.api#required": {} + } + }, + "origin": { + "target": "com.amazonaws.lightsail#InputOrigin", + "traits": { + "smithy.api#documentation": "

An object that describes the origin resource for the distribution, such as a Lightsail\n instance, bucket, or load balancer.

\n

The distribution pulls, caches, and serves content from the origin.

", + "smithy.api#required": {} + } + }, + "defaultCacheBehavior": { + "target": "com.amazonaws.lightsail#CacheBehavior", + "traits": { + "smithy.api#documentation": "

An object that describes the default cache behavior for the distribution.

", + "smithy.api#required": {} + } + }, + "cacheBehaviorSettings": { + "target": "com.amazonaws.lightsail#CacheSettings", + "traits": { + "smithy.api#documentation": "

An object that describes the cache behavior settings for the distribution.

" + } + }, + "cacheBehaviors": { + "target": "com.amazonaws.lightsail#CacheBehaviorList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the per-path cache behavior for the distribution.

" + } + }, + "bundleId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The bundle ID to use for the distribution.

\n

A distribution bundle describes the specifications of your distribution, such as the\n monthly cost and monthly network transfer quota.

\n

Use the GetDistributionBundles action to get a list of distribution bundle\n IDs that you can specify.

", + "smithy.api#required": {} + } + }, + "ipAddressType": { + "target": "com.amazonaws.lightsail#IpAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type for the distribution.

\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

\n

The default value is dualstack.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the distribution during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateDistributionResult": { + "type": "structure", + "members": { + "distribution": { + "target": "com.amazonaws.lightsail#LightsailDistribution", + "traits": { + "smithy.api#documentation": "

An object that describes the distribution created.

" + } + }, + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateDomainRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateDomainResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a domain resource for the specified domain (e.g., example.com).

\n

The create domain operation supports tag-based access control via request\n tags. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateDomain", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateDomainEntry": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateDomainEntryRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateDomainEntryResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates one of the following domain name system (DNS) records in a domain DNS zone:\n Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority\n (SOA), service locator (SRV), or text (TXT).

\n

The create domain entry operation supports tag-based access control via\n resource tags applied to the resource identified by domain name. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateDomainEntry", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateDomainEntryRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name (e.g., example.com) for which you want to create the domain\n entry.

", + "smithy.api#required": {} + } + }, + "domainEntry": { + "target": "com.amazonaws.lightsail#DomainEntry", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs containing information about the domain entry request.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#CreateDomainEntryResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateDomainRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name to manage (e.g., example.com).

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateDomainResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateInstanceSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateInstanceSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateInstanceSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a snapshot of a specific virtual private server, or instance.\n You can use a snapshot to create a new instance that is based on that snapshot.

\n

The create instance snapshot operation supports tag-based access control via\n request tags. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateInstanceSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateInstanceSnapshotRequest": { + "type": "structure", + "members": { + "instanceSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name for your new snapshot.

", + "smithy.api#required": {} + } + }, + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The Lightsail instance on which to base your snapshot.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateInstanceSnapshotResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateInstancesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateInstancesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates one or more Amazon Lightsail instances.

\n

The create instances operation supports tag-based access control via request\n tags. For more information, see the Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateInstances", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateInstancesFromSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateInstancesFromSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateInstancesFromSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates one or more new instances from a manual or automatic snapshot of an\n instance.

\n

The create instances from snapshot operation supports tag-based access\n control via request tags and resource tags applied to the resource identified by\n instance snapshot name. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateInstancesFromSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateInstancesFromSnapshotRequest": { + "type": "structure", + "members": { + "instanceNames": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The names for your new instances.

", + "smithy.api#required": {} + } + }, + "attachedDiskMapping": { + "target": "com.amazonaws.lightsail#AttachedDiskMap", + "traits": { + "smithy.api#documentation": "

An object containing information about one or more disk mappings.

" + } + }, + "availabilityZone": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The Availability Zone where you want to create your instances. Use the following\n formatting: us-east-2a (case sensitive). You can get a list of Availability Zones\n by using the get\n regions operation. Be sure to add the include Availability Zones\n parameter to your request.

", + "smithy.api#required": {} + } + }, + "instanceSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance snapshot on which you are basing your new instances. Use the get\n instance snapshots operation to return information about your existing snapshots.

\n

Constraint:

\n " + } + }, + "bundleId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The bundle of specification information for your virtual private server (or\n instance), including the pricing plan (e.g.,\n micro_1_0).

", + "smithy.api#required": {} + } + }, + "userData": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

You can create a launch script that configures a server with additional user data. For\n example, apt-get -y update.

\n \n

Depending on the machine image you choose, the command to get software on your instance\n varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use\n apt-get, and FreeBSD uses pkg. For a complete list, see the\n Amazon Lightsail Developer Guide.

\n " + } + }, + "keyPairName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name for your key pair.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + }, + "addOns": { + "target": "com.amazonaws.lightsail#AddOnRequestList", + "traits": { + "smithy.api#documentation": "

An array of objects representing the add-ons to enable for the new instance.

" + } + }, + "ipAddressType": { + "target": "com.amazonaws.lightsail#IpAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type for the instance.

\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

\n

The default value is dualstack.

" + } + }, + "sourceInstanceName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the source instance from which the source automatic snapshot was\n created.

\n

Constraints:

\n " + } + }, + "restoreDate": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The date of the automatic snapshot to use for the new instance. Use the get auto\n snapshots operation to identify the dates of the available automatic\n snapshots.

\n

Constraints:

\n " + } + }, + "useLatestRestorableAutoSnapshot": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value to indicate whether to use the latest available automatic snapshot.

\n

Constraints:

\n " + } + } + } + }, + "com.amazonaws.lightsail#CreateInstancesFromSnapshotResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateInstancesRequest": { + "type": "structure", + "members": { + "instanceNames": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The names to use for your new Lightsail instances. Separate multiple values using\n quotation marks and commas, for example:\n [\"MyFirstInstance\",\"MySecondInstance\"]\n

", + "smithy.api#required": {} + } + }, + "availabilityZone": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The Availability Zone in which to create your instance. Use the following format:\n us-east-2a (case sensitive). You can get a list of Availability Zones by using\n the get\n regions operation. Be sure to add the include Availability Zones\n parameter to your request.

", + "smithy.api#required": {} + } + }, + "customImageName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

(Deprecated) The name for your custom image.

\n \n

In releases prior to June 12, 2017, this parameter was ignored by the API. It is now\n deprecated.

\n " + } + }, + "blueprintId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID for a virtual private server image (e.g., app_wordpress_4_4 or\n app_lamp_7_0). Use the get blueprints operation to return a list\n of available images (or blueprints).

\n \n

Use active blueprints when creating new instances. Inactive blueprints are listed to\n support customers with existing instances and are not necessarily available to create new\n instances. Blueprints are marked inactive when they become outdated due to operating system\n updates or new application releases.

\n ", + "smithy.api#required": {} + } + }, + "bundleId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The bundle of specification information for your virtual private server (or\n instance), including the pricing plan (e.g.,\n micro_1_0).

", + "smithy.api#required": {} + } + }, + "userData": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

A launch script you can create that configures a server with additional user data. For\n example, you might want to run apt-get -y update.

\n \n

Depending on the machine image you choose, the command to get software on your instance\n varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use\n apt-get, and FreeBSD uses pkg. For a complete list, see the\n Amazon Lightsail Developer Guide.

\n " + } + }, + "keyPairName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your key pair.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + }, + "addOns": { + "target": "com.amazonaws.lightsail#AddOnRequestList", + "traits": { + "smithy.api#documentation": "

An array of objects representing the add-ons to enable for the new instance.

" + } + }, + "ipAddressType": { + "target": "com.amazonaws.lightsail#IpAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type for the instance.

\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

\n

The default value is dualstack.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateInstancesResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateKeyPair": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateKeyPairRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateKeyPairResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a custom SSH key pair that you can use with an Amazon Lightsail\n instance.

\n \n

Use the DownloadDefaultKeyPair action to create a Lightsail default key\n pair in an Amazon Web Services Region where a default key pair does not currently\n exist.

\n \n

The create key pair operation supports tag-based access control via request\n tags. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateKeyPair", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateKeyPairRequest": { + "type": "structure", + "members": { + "keyPairName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name for your new key pair.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateKeyPairResult": { + "type": "structure", + "members": { + "keyPair": { + "target": "com.amazonaws.lightsail#KeyPair", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs containing information about the new key pair you just\n created.

" + } + }, + "publicKeyBase64": { + "target": "com.amazonaws.lightsail#Base64", + "traits": { + "smithy.api#documentation": "

A base64-encoded public key of the ssh-rsa type.

" + } + }, + "privateKeyBase64": { + "target": "com.amazonaws.lightsail#Base64", + "traits": { + "smithy.api#documentation": "

A base64-encoded RSA private key.

" + } + }, + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateLoadBalancer": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateLoadBalancerRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateLoadBalancerResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a Lightsail load balancer. To learn more about deciding whether to load balance\n your application, see Configure your Lightsail instances for load balancing. You can create up to 5\n load balancers per AWS Region in your account.

\n

When you create a load balancer, you can specify a unique name and port settings. To\n change additional load balancer settings, use the UpdateLoadBalancerAttribute\n operation.

\n

The create load balancer operation supports tag-based access control via\n request tags. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateLoadBalancer", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateLoadBalancerRequest": { + "type": "structure", + "members": { + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your load balancer.

", + "smithy.api#required": {} + } + }, + "instancePort": { + "target": "com.amazonaws.lightsail#Port", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The instance port where you're creating your load balancer.

", + "smithy.api#required": {} + } + }, + "healthCheckPath": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The path you provided to perform the load balancer health check. If you didn't specify a\n health check path, Lightsail uses the root path of your website (e.g.,\n \"/\").

\n

You may want to specify a custom health check path other than the root of your application\n if your home page loads slowly or has a lot of media or scripting on it.

" + } + }, + "certificateName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the SSL/TLS certificate.

\n

If you specify certificateName, then certificateDomainName is\n required (and vice-versa).

" + } + }, + "certificateDomainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name with which your certificate is associated (e.g.,\n example.com).

\n

If you specify certificateDomainName, then certificateName is\n required (and vice-versa).

" + } + }, + "certificateAlternativeNames": { + "target": "com.amazonaws.lightsail#DomainNameList", + "traits": { + "smithy.api#documentation": "

The optional alternative domains and subdomains to use with your SSL/TLS certificate\n (e.g., www.example.com, example.com, m.example.com,\n blog.example.com).

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + }, + "ipAddressType": { + "target": "com.amazonaws.lightsail#IpAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type for the load balancer.

\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

\n

The default value is dualstack.

" + } + }, + "tlsPolicyName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the TLS policy to apply to the load balancer.

\n

Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can\n specify.

\n

For more information about load balancer TLS policies, see Configuring TLS security policies on your Amazon Lightsail load\n balancers in the Amazon Lightsail Developer Guide.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateLoadBalancerResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificateRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificateResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.

\n

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

\n

The CreateLoadBalancerTlsCertificate operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateLoadBalancerTlsCertificate", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificateRequest": { + "type": "structure", + "members": { + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The load balancer name where you want to create the SSL/TLS certificate.

", + "smithy.api#required": {} + } + }, + "certificateName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The SSL/TLS certificate name.

\n

You can have up to 10 certificates in your account at one time. Each Lightsail load\n balancer can have up to 2 certificates associated with it at one time. There is also an\n overall limit to the number of certificates that can be issue in a 365-day period. For more\n information, see Limits.

", + "smithy.api#required": {} + } + }, + "certificateDomainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name (e.g., example.com) for your SSL/TLS certificate.

", + "smithy.api#required": {} + } + }, + "certificateAlternativeNames": { + "target": "com.amazonaws.lightsail#DomainNameList", + "traits": { + "smithy.api#documentation": "

An array of strings listing alternative domains and subdomains for your SSL/TLS\n certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9\n alternative names (in addition to the 1 primary domain). We do not support wildcards (e.g.,\n *.example.com).

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificateResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateRelationalDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateRelationalDatabaseRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateRelationalDatabaseResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new database in Amazon Lightsail.

\n

The create relational database operation supports tag-based access control\n via request tags. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateRelationalDatabase", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new database from an existing database snapshot in Amazon Lightsail.

\n

You can create a new database from a snapshot in if something goes wrong with your\n original database, or to change it to a different plan, such as a high availability or\n standard plan.

\n

The create relational database from snapshot operation supports tag-based\n access control via request tags and resource tags applied to the resource identified by\n relationalDatabaseSnapshotName. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateRelationalDatabaseFromSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshotRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name to use for your new Lightsail database resource.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "availabilityZone": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The Availability Zone in which to create your new database. Use the\n us-east-2a case-sensitive format.

\n

You can get a list of Availability Zones by using the get regions operation.\n Be sure to add the include relational database Availability Zones parameter to\n your request.

" + } + }, + "publiclyAccessible": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Specifies the accessibility options for your new database. A value of true\n specifies a database that is available to resources outside of your Lightsail account. A\n value of false specifies a database that is available only to your Lightsail\n resources in the same region as your database.

" + } + }, + "relationalDatabaseSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the database snapshot from which to create your new database.

" + } + }, + "relationalDatabaseBundleId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The bundle ID for your new database. A bundle describes the performance specifications for\n your database.

\n

You can get a list of database bundle IDs by using the get relational database\n bundles operation.

\n

When creating a new database from a snapshot, you cannot choose a bundle that is smaller\n than the bundle of the source database.

" + } + }, + "sourceRelationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the source database.

" + } + }, + "restoreTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The date and time to restore your database from.

\n

Constraints:

\n " + } + }, + "useLatestRestorableTime": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether your database is restored from the latest backup time. A value of\n true restores from the latest backup time.

\n

Default: false\n

\n

Constraints: Cannot be specified if the restore time parameter is\n provided.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshotResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateRelationalDatabaseRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name to use for your new Lightsail database resource.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "availabilityZone": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The Availability Zone in which to create your new database. Use the\n us-east-2a case-sensitive format.

\n

You can get a list of Availability Zones by using the get regions operation.\n Be sure to add the include relational database Availability Zones parameter to\n your request.

" + } + }, + "relationalDatabaseBlueprintId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The blueprint ID for your new database. A blueprint describes the major engine version of\n a database.

\n

You can get a list of database blueprints IDs by using the get relational database\n blueprints operation.

", + "smithy.api#required": {} + } + }, + "relationalDatabaseBundleId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The bundle ID for your new database. A bundle describes the performance specifications for\n your database.

\n

You can get a list of database bundle IDs by using the get relational database\n bundles operation.

", + "smithy.api#required": {} + } + }, + "masterDatabaseName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The meaning of this parameter differs according to the database engine you use.

\n

\n MySQL\n

\n

The name of the database to create when the Lightsail database resource is created. If\n this parameter isn't specified, no database is created in the database resource.

\n

Constraints:

\n \n

\n PostgreSQL\n

\n

The name of the database to create when the Lightsail database resource is created. If\n this parameter isn't specified, a database named postgres is created in the\n database resource.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "masterUsername": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name for the master user.

\n

\n MySQL\n

\n

Constraints:

\n \n

\n PostgreSQL\n

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "masterUserPassword": { + "target": "com.amazonaws.lightsail#SensitiveString", + "traits": { + "smithy.api#documentation": "

The password for the master user. The password can include any printable ASCII character\n except \"/\", \"\"\", or \"@\". It cannot contain spaces.

\n

\n MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

" + } + }, + "preferredBackupWindow": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are created for your new database if\n automated backups are enabled.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n AWS Region. For more information about the preferred backup window time blocks for each\n region, see the Working With Backups guide in the Amazon Relational Database Service documentation.

\n

Constraints:

\n " + } + }, + "preferredMaintenanceWindow": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur on your new\n database.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n AWS Region, occurring on a random day of the week.

\n

Constraints:

\n " + } + }, + "publiclyAccessible": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Specifies the accessibility options for your new database. A value of true\n specifies a database that is available to resources outside of your Lightsail account. A\n value of false specifies a database that is available only to your Lightsail\n resources in the same region as your database.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateRelationalDatabaseResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups,\n to make copies of a database, and to save data before deleting a database.

\n

The create relational database snapshot operation supports tag-based access\n control via request tags. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/CreateRelationalDatabaseSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshotRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the database on which to base your new snapshot.

", + "smithy.api#required": {} + } + }, + "relationalDatabaseSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name for your new database snapshot.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" + } + } + } + }, + "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshotResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#DeleteAlarm": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteAlarmRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteAlarmResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an alarm.

\n

An alarm is used to monitor a single metric for one of your resources. When a metric\n condition is met, the alarm can notify you by email, SMS text message, and a banner displayed\n on the Amazon Lightsail console. For more information, see Alarms\n in Amazon Lightsail.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/ls/api/2016-11-28/DeleteAlarm", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteAlarmRequest": { + "type": "structure", + "members": { + "alarmName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the alarm to delete.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#DeleteAlarmResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#DeleteAutoSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteAutoSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteAutoSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteAutoSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteAutoSnapshotRequest": { + "type": "structure", + "members": { + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the source instance or disk from which to delete the automatic\n snapshot.

", + "smithy.api#required": {} + } + }, + "date": { + "target": "com.amazonaws.lightsail#AutoSnapshotDate", + "traits": { + "smithy.api#documentation": "

The date of the automatic snapshot to delete in YYYY-MM-DD format. Use the\n get auto snapshots operation to get the available automatic snapshots for a\n resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#DeleteAutoSnapshotResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#DeleteBucket": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteBucketRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteBucketResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a Amazon Lightsail bucket.

\n \n

When you delete your bucket, the bucket name is released and can be reused for a new\n bucket in your account or another Amazon Web Services account.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteBucket", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteBucketAccessKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteBucketAccessKeyRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteBucketAccessKeyResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an access key for the specified Amazon Lightsail bucket.

\n

We recommend that you delete an access key if the secret access key is compromised.

\n

For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteBucketAccessKey", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteBucketAccessKeyRequest": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.lightsail#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket that the access key belongs to.

", + "smithy.api#required": {} + } + }, + "accessKeyId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the access key to delete.

\n

Use the GetBucketAccessKeys action to get a\n list of access key IDs that you can specify.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#DeleteBucketAccessKeyResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#DeleteBucketRequest": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.lightsail#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket to delete.

\n

Use the GetBuckets action to get a list of bucket names\n that you can specify.

", + "smithy.api#required": {} + } + }, + "forceDelete": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether to force delete the bucket.

\n

You must force delete the bucket if it has one of the following conditions:

\n \n \n

Force deleting a bucket might impact other resources that rely on the bucket, such as\n instances, distributions, or software that use the issued access keys.

\n " + } + } + } + }, + "com.amazonaws.lightsail#DeleteBucketResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#DeleteCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteCertificateRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteCertificateResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

Certificates that are currently attached to a distribution cannot be deleted. Use the\n DetachCertificateFromDistribution action to detach a certificate from a\n distribution.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteCertificate", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteCertificateRequest": { + "type": "structure", + "members": { + "certificateName": { + "target": "com.amazonaws.lightsail#CertificateName", + "traits": { + "smithy.api#documentation": "

The name of the certificate to delete.

\n

Use the GetCertificates action to get a list of certificate names that you\n can specify.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#DeleteCertificateResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#DeleteContactMethod": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteContactMethodRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteContactMethodResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a contact method.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services\n Regions, and SMS text messages cannot be sent to some countries/regions. For more information,\n see Notifications in Amazon Lightsail.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteContactMethod", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteContactMethodRequest": { + "type": "structure", + "members": { + "protocol": { + "target": "com.amazonaws.lightsail#ContactProtocol", + "traits": { + "smithy.api#documentation": "

The protocol that will be deleted, such as Email or SMS (text\n messaging).

\n \n

To delete an Email and an SMS contact method if you added\n both, you must run separate DeleteContactMethod actions to delete each\n protocol.

\n ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#DeleteContactMethodResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#DeleteContainerImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteContainerImageRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteContainerImageResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a container image that is registered to your Amazon Lightsail container\n service.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/ls/api/2016-11-28/container-services/{serviceName}/images/{image}", + "code": 204 + } + } + }, + "com.amazonaws.lightsail#DeleteContainerImageRequest": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.lightsail#ContainerServiceName", + "traits": { + "smithy.api#documentation": "

The name of the container service for which to delete a registered container image.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "image": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the container image to delete from the container service.

\n

Use the GetContainerImages action to get the name of the container images\n that are registered to a container service.

\n \n

Container images sourced from your Lightsail container service, that are registered\n and stored on your service, start with a colon (:). For example,\n :container-service-1.mystaticwebsite.1. Container images sourced from a\n public registry like Docker Hub don't start with a colon. For example,\n nginx:latest or nginx.

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#DeleteContainerImageResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.lightsail#DeleteContainerService": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteContainerServiceRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteContainerServiceResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes your Amazon Lightsail container service.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/ls/api/2016-11-28/container-services/{serviceName}", + "code": 204 + } + } + }, + "com.amazonaws.lightsail#DeleteContainerServiceRequest": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.lightsail#ContainerServiceName", + "traits": { + "smithy.api#documentation": "

The name of the container service to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#DeleteContainerServiceResult": { + "type": "structure", + "members": {} + }, + "com.amazonaws.lightsail#DeleteDisk": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteDiskRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteDiskResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified block storage disk. The disk must be in the available\n state (not attached to a Lightsail instance).

\n \n

The disk may remain in the deleting state for several minutes.

\n \n

The delete disk operation supports tag-based access control via resource tags\n applied to the resource identified by disk name. For more information, see the\n Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteDisk", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteDiskRequest": { + "type": "structure", + "members": { + "diskName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The unique name of the disk you want to delete (e.g., my-disk).

", + "smithy.api#required": {} + } + }, + "forceDeleteAddOns": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value to indicate whether to delete all add-ons for the disk.

" + } + } + } + }, + "com.amazonaws.lightsail#DeleteDiskResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#DeleteDiskSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteDiskSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteDiskSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified disk snapshot.

\n

When you make periodic snapshots of a disk, the snapshots are incremental, and only the\n blocks on the device that have changed since your last snapshot are saved in the new snapshot.\n When you delete a snapshot, only the data not needed for any other snapshot is removed. So\n regardless of which prior snapshots have been deleted, all active snapshots will have access\n to all the information needed to restore the disk.

\n

The delete disk snapshot operation supports tag-based access control via\n resource tags applied to the resource identified by disk snapshot name. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteDiskSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteDiskSnapshotRequest": { + "type": "structure", + "members": { + "diskSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the disk snapshot you want to delete (e.g.,\n my-disk-snapshot).

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#DeleteDiskSnapshotResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#DeleteDistribution": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteDistributionRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteDistributionResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes your Amazon Lightsail content delivery network (CDN) distribution.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteDistribution", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteDistributionRequest": { + "type": "structure", + "members": { + "distributionName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the distribution to delete.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

" + } + } + } + }, + "com.amazonaws.lightsail#DeleteDistributionResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#DeleteDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteDomainRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteDomainResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified domain recordset and all of its domain records.

\n

The delete domain operation supports tag-based access control via resource\n tags applied to the resource identified by domain name. For more information, see\n the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteDomain", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteDomainEntry": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteDomainEntryRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteDomainEntryResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a specific domain entry.

\n

The delete domain entry operation supports tag-based access control via\n resource tags applied to the resource identified by domain name. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteDomainEntry", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteDomainEntryRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The name of the domain entry to delete.

", + "smithy.api#required": {} + } + }, + "domainEntry": { + "target": "com.amazonaws.lightsail#DomainEntry", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs containing information about your domain entries.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#DeleteDomainEntryResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#DeleteDomainRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The specific domain name to delete.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#DeleteDomainResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#DeleteInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteInstanceRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Amazon Lightsail instance.

\n

The delete instance operation supports tag-based access control via resource\n tags applied to the resource identified by instance name. For more information,\n see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteInstance", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteInstanceRequest": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance to delete.

", + "smithy.api#required": {} + } + }, + "forceDeleteAddOns": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value to indicate whether to delete all add-ons for the instance.

" + } + } + } + }, + "com.amazonaws.lightsail#DeleteInstanceResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#DeleteInstanceSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteInstanceSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteInstanceSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a specific snapshot of a virtual private server (or\n instance).

\n

The delete instance snapshot operation supports tag-based access control via\n resource tags applied to the resource identified by instance snapshot name. For\n more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteInstanceSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteInstanceSnapshotRequest": { + "type": "structure", + "members": { + "instanceSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the snapshot to delete.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#DeleteInstanceSnapshotResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#DeleteKeyPair": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteKeyPairRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteKeyPairResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified key pair by removing the public key from Amazon Lightsail.

\n

You can delete key pairs that were created using the ImportKeyPair and\n CreateKeyPair actions, as well as the Lightsail default key pair. A new default\n key pair will not be created unless you launch an instance without specifying a custom key\n pair, or you call the DownloadDefaultKeyPair API.

\n

The delete key pair operation supports tag-based access control via resource\n tags applied to the resource identified by key pair name. For more information,\n see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteKeyPair", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteKeyPairRequest": { + "type": "structure", + "members": { + "keyPairName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the key pair to delete.

", + "smithy.api#required": {} + } + }, + "expectedFingerprint": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The RSA fingerprint of the Lightsail default key pair to delete.

\n \n

The expectedFingerprint parameter is required only when specifying to\n delete a Lightsail default key pair.

\n " + } + } + } + }, + "com.amazonaws.lightsail#DeleteKeyPairResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#DeleteKnownHostKeys": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteKnownHostKeysRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteKnownHostKeysResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or\n RDP clients to authenticate an instance. This operation enables the Lightsail browser-based\n SSH or RDP clients to connect to the instance after a host key mismatch.

\n \n

Perform this operation only if you were expecting the host key or certificate mismatch\n or if you are familiar with the new host key or certificate on the instance. For more\n information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP\n client.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteKnownHostKeys", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteKnownHostKeysRequest": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance for which you want to reset the host key or certificate.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#DeleteKnownHostKeysResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#DeleteLoadBalancer": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteLoadBalancerRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteLoadBalancerResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the\n load balancer is deleted, you will need to create a new load balancer, create a new\n certificate, and verify domain ownership again.

\n

The delete load balancer operation supports tag-based access control via\n resource tags applied to the resource identified by load balancer name. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteLoadBalancer", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteLoadBalancerRequest": { + "type": "structure", + "members": { + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the load balancer you want to delete.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#DeleteLoadBalancerResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificateRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificateResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an SSL/TLS certificate associated with a Lightsail load balancer.

\n

The DeleteLoadBalancerTlsCertificate operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteLoadBalancerTlsCertificate", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificateRequest": { + "type": "structure", + "members": { + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The load balancer name.

", + "smithy.api#required": {} + } + }, + "certificateName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The SSL/TLS certificate name.

", + "smithy.api#required": {} + } + }, + "force": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

When true, forces the deletion of an SSL/TLS certificate.

\n

There can be two certificates associated with a Lightsail load balancer: the primary and\n the backup. The force parameter is required when the primary SSL/TLS certificate\n is in use by an instance attached to the load balancer.

" + } + } + } + }, + "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificateResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#DeleteRelationalDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteRelationalDatabaseRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteRelationalDatabaseResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a database in Amazon Lightsail.

\n

The delete relational database operation supports tag-based access control\n via resource tags applied to the resource identified by relationalDatabaseName. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteRelationalDatabase", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteRelationalDatabaseRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the database that you are deleting.

", + "smithy.api#required": {} + } + }, + "skipFinalSnapshot": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Determines whether a final database snapshot is created before your database is deleted.\n If true is specified, no database snapshot is created. If false is\n specified, a database snapshot is created before your database is deleted.

\n

You must specify the final relational database snapshot name parameter if the\n skip final snapshot parameter is false.

\n

Default: false\n

" + } + }, + "finalRelationalDatabaseSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the database snapshot created if skip final snapshot is\n false, which is the default value for that parameter.

\n \n

Specifying this parameter and also specifying the skip final snapshot\n parameter to true results in an error.

\n \n

Constraints:

\n " + } + } + } + }, + "com.amazonaws.lightsail#DeleteRelationalDatabaseResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a database snapshot in Amazon Lightsail.

\n

The delete relational database snapshot operation supports tag-based access\n control via resource tags applied to the resource identified by relationalDatabaseName. For\n more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DeleteRelationalDatabaseSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshotRequest": { + "type": "structure", + "members": { + "relationalDatabaseSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the database snapshot that you are deleting.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshotResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#DestinationInfo": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the resource created at the destination.

" + } + }, + "service": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The destination service of the record.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the destination of a record.

" + } + }, + "com.amazonaws.lightsail#DetachCertificateFromDistribution": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DetachCertificateFromDistributionRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DetachCertificateFromDistributionResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

After the certificate is detached, your distribution stops accepting traffic for all of\n the domains that are associated with the certificate.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DetachCertificateFromDistribution", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DetachCertificateFromDistributionRequest": { + "type": "structure", + "members": { + "distributionName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the distribution from which to detach the certificate.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#DetachCertificateFromDistributionResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#DetachDisk": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DetachDiskRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DetachDiskResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount\n any file systems on the device within your operating system before stopping the instance and\n detaching the disk.

\n

The detach disk operation supports tag-based access control via resource tags\n applied to the resource identified by disk name. For more information, see the\n Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DetachDisk", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DetachDiskRequest": { + "type": "structure", + "members": { + "diskName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The unique name of the disk you want to detach from your instance (e.g.,\n my-disk).

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#DetachDiskResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#DetachInstancesFromLoadBalancer": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DetachInstancesFromLoadBalancerRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DetachInstancesFromLoadBalancerResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Detaches the specified instances from a Lightsail load balancer.

\n

This operation waits until the instances are no longer needed before they are detached\n from the load balancer.

\n

The detach instances from load balancer operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DetachInstancesFromLoadBalancer", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DetachInstancesFromLoadBalancerRequest": { + "type": "structure", + "members": { + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Lightsail load balancer.

", + "smithy.api#required": {} + } + }, + "instanceNames": { + "target": "com.amazonaws.lightsail#ResourceNameList", + "traits": { + "smithy.api#documentation": "

An array of strings containing the names of the instances you want to detach from the load\n balancer.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#DetachInstancesFromLoadBalancerResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#DetachStaticIp": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DetachStaticIpRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DetachStaticIpResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Detaches a static IP from the Amazon Lightsail instance to which it is attached.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DetachStaticIp", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DetachStaticIpRequest": { + "type": "structure", + "members": { + "staticIpName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the static IP to detach from the instance.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#DetachStaticIpResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#DisableAddOn": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DisableAddOnRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DisableAddOnResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Disables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DisableAddOn", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DisableAddOnRequest": { + "type": "structure", + "members": { + "addOnType": { + "target": "com.amazonaws.lightsail#AddOnType", + "traits": { + "smithy.api#documentation": "

The add-on type to disable.

", + "smithy.api#required": {} + } + }, + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the source resource for which to disable the add-on.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#DisableAddOnResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#Disk": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The unique name of the disk.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the disk.

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The date when the disk was created.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

The AWS Region and Availability Zone where the disk is located.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type (e.g., Disk).

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + }, + "addOns": { + "target": "com.amazonaws.lightsail#AddOnList", + "traits": { + "smithy.api#documentation": "

An array of objects representing the add-ons enabled on the disk.

" + } + }, + "sizeInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The size of the disk in GB.

" + } + }, + "isSystemDisk": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether this disk is a system disk (has an operating system\n loaded on it).

" + } + }, + "iops": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The input/output operations per second (IOPS) of the disk.

" + } + }, + "path": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The disk path.

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#DiskState", + "traits": { + "smithy.api#documentation": "

Describes the status of the disk.

" + } + }, + "attachedTo": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The resources to which the disk is attached.

" + } + }, + "isAttached": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the disk is attached.

" + } + }, + "attachmentState": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

(Deprecated) The attachment state of the disk.

\n \n

In releases prior to November 14, 2017, this parameter returned attached\n for system disks in the API response. It is now deprecated, but still included in the\n response. Use isAttached instead.

\n " + } + }, + "gbInUse": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

(Deprecated) The number of GB in use by the disk.

\n \n

In releases prior to November 14, 2017, this parameter was not included in the API\n response. It is now deprecated.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a block storage disk.

" + } + }, + "com.amazonaws.lightsail#DiskInfo": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The disk name.

" + } + }, + "path": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The disk path.

" + } + }, + "sizeInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The size of the disk in GB (e.g., 32).

" + } + }, + "isSystemDisk": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether this disk is a system disk (has an operating system\n loaded on it).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a disk.

" + } + }, + "com.amazonaws.lightsail#DiskInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#DiskInfo" + } + }, + "com.amazonaws.lightsail#DiskList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Disk" + } + }, + "com.amazonaws.lightsail#DiskMap": { + "type": "structure", + "members": { + "originalDiskPath": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The original disk path exposed to the instance (for example,\n /dev/sdh).

" + } + }, + "newDiskName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The new disk name (e.g., my-new-disk).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a block storage disk mapping.

" + } + }, + "com.amazonaws.lightsail#DiskMapList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#DiskMap" + } + }, + "com.amazonaws.lightsail#DiskSnapshot": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the disk snapshot (e.g., my-disk-snapshot).

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the disk snapshot.

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The date when the disk snapshot was created.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

The AWS Region and Availability Zone where the disk snapshot was created.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type (e.g., DiskSnapshot).

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + }, + "sizeInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The size of the disk in GB.

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#DiskSnapshotState", + "traits": { + "smithy.api#documentation": "

The status of the disk snapshot operation.

" + } + }, + "progress": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The progress of the snapshot.

" + } + }, + "fromDiskName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The unique name of the source disk from which the disk snapshot was created.

" + } + }, + "fromDiskArn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was\n created.

" + } + }, + "fromInstanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The unique name of the source instance from which the disk (system volume) snapshot was\n created.

" + } + }, + "fromInstanceArn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source instance from which the disk (system volume)\n snapshot was created.

" + } + }, + "isFromAutoSnapshot": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the snapshot was created from an automatic\n snapshot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a block storage disk snapshot.

" + } + }, + "com.amazonaws.lightsail#DiskSnapshotInfo": { + "type": "structure", + "members": { + "sizeInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The size of the disk in GB (e.g., 32).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a disk snapshot.

" + } + }, + "com.amazonaws.lightsail#DiskSnapshotList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#DiskSnapshot" + } + }, + "com.amazonaws.lightsail#DiskSnapshotState": { + "type": "enum", + "members": { + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "Completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "completed" + } + }, + "Error": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + }, + "Unknown": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknown" + } + } + } + }, + "com.amazonaws.lightsail#DiskState": { + "type": "enum", + "members": { + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "Error": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + }, + "Available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "InUse": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "in-use" + } + }, + "Unknown": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknown" + } + } + } + }, + "com.amazonaws.lightsail#DistributionBundle": { + "type": "structure", + "members": { + "bundleId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The ID of the bundle.

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the distribution bundle.

" + } + }, + "price": { + "target": "com.amazonaws.lightsail#float", + "traits": { + "smithy.api#documentation": "

The monthly price, in US dollars, of the bundle.

" + } + }, + "transferPerMonthInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The monthly network transfer quota of the bundle.

" + } + }, + "isActive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the bundle is active, and can be specified for a new or existing\n distribution.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the specifications of a distribution bundle.

" + } + }, + "com.amazonaws.lightsail#DistributionBundleList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#DistributionBundle" + } + }, + "com.amazonaws.lightsail#DistributionList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#LightsailDistribution" + } + }, + "com.amazonaws.lightsail#DistributionMetricName": { + "type": "enum", + "members": { + "Requests": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Requests" + } + }, + "BytesDownloaded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BytesDownloaded" + } + }, + "BytesUploaded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BytesUploaded" + } + }, + "TotalErrorRate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TotalErrorRate" + } + }, + "Http4xxErrorRate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Http4xxErrorRate" + } + }, + "Http5xxErrorRate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Http5xxErrorRate" + } + } + } + }, + "com.amazonaws.lightsail#DnsRecordCreationState": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#DnsRecordCreationStateCode", + "traits": { + "smithy.api#documentation": "

The status code for the automated DNS record creation.

\n

Following are the possible values:

\n " + } + }, + "message": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The message that describes the reason for the status code.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the creation state of the canonical name (CNAME) records that are automatically\n added by Amazon Lightsail to the DNS of a domain to validate domain ownership for\n an SSL/TLS certificate.

\n

When you create an SSL/TLS certificate for a Lightsail resource, you must\n add a set of CNAME records to the DNS of the domains for the certificate to validate that you\n own the domains. Lightsail can automatically add the CNAME records to the DNS\n of the domain if the DNS zone for the domain exists within your Lightsail\n account. If automatic record addition fails, or if you manage the DNS of your domain using a\n third-party service, then you must manually add the CNAME records to the DNS of your domain.\n For more information, see Verify an SSL/TLS certificate in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

" + } + }, + "com.amazonaws.lightsail#DnsRecordCreationStateCode": { + "type": "enum", + "members": { + "Succeeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "Started": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTED" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.lightsail#Domain": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the domain.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the domain recordset (e.g.,\n arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE).

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The date when the domain recordset was created.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

The AWS Region and Availability Zones where the domain recordset was created.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + }, + "domainEntries": { + "target": "com.amazonaws.lightsail#DomainEntryList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs containing information about the domain entries.

" + } + }, + "registeredDomainDelegationInfo": { + "target": "com.amazonaws.lightsail#RegisteredDomainDelegationInfo", + "traits": { + "smithy.api#documentation": "

An object that describes the state of the RouteĀ 53 domain delegation to a\n Lightsail DNS zone.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a domain where you are storing recordsets.

" + } + }, + "com.amazonaws.lightsail#DomainEntry": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the domain recordset entry.

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The name of the domain.

" + } + }, + "target": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The target IP address (e.g., 192.0.2.0), or AWS name server (e.g.,\n ns-111.awsdns-22.com.).

\n

For Lightsail load balancers, the value looks like\n ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. For\n Lightsail distributions, the value looks like exampled1182ne.cloudfront.net.\n For Lightsail container services, the value looks like\n container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com. Be sure to\n also set isAlias to true when setting up an A record for a\n Lightsail load balancer, distribution, or container service.

" + } + }, + "isAlias": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

When true, specifies whether the domain entry is an alias used by the\n Lightsail load balancer. You can include an alias (A type) record in your request, which\n points to a load balancer DNS name and routes traffic to your load balancer.

" + } + }, + "type": { + "target": "com.amazonaws.lightsail#DomainEntryType", + "traits": { + "smithy.api#documentation": "

The type of domain entry, such as address for IPv4 (A), address for IPv6 (AAAA), canonical\n name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator\n (SRV), or text (TXT).

\n

The following domain entry types can be used:

\n " + } + }, + "options": { + "target": "com.amazonaws.lightsail#DomainEntryOptions", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

(Deprecated) The options for the domain entry.

\n \n

In releases prior to November 29, 2017, this parameter was not included in the API\n response. It is now deprecated.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a domain recordset entry.

" + } + }, + "com.amazonaws.lightsail#DomainEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#DomainEntry" + } + }, + "com.amazonaws.lightsail#DomainEntryOptions": { + "type": "map", + "key": { + "target": "com.amazonaws.lightsail#DomainEntryOptionsKeys" + }, + "value": { + "target": "com.amazonaws.lightsail#string" + } + }, + "com.amazonaws.lightsail#DomainEntryOptionsKeys": { + "type": "string" + }, + "com.amazonaws.lightsail#DomainEntryType": { + "type": "string" + }, + "com.amazonaws.lightsail#DomainList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Domain" + } + }, + "com.amazonaws.lightsail#DomainName": { + "type": "string" + }, + "com.amazonaws.lightsail#DomainNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#DomainName" + } + }, + "com.amazonaws.lightsail#DomainValidationRecord": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name of the certificate validation record. For example,\n example.com or www.example.com.

" + } + }, + "resourceRecord": { + "target": "com.amazonaws.lightsail#ResourceRecord", + "traits": { + "smithy.api#documentation": "

An object that describes the DNS records to add to your domain's DNS to validate it for\n the certificate.

" + } + }, + "dnsRecordCreationState": { + "target": "com.amazonaws.lightsail#DnsRecordCreationState", + "traits": { + "smithy.api#documentation": "

An object that describes the state of the canonical name (CNAME) records that are\n automatically added by Lightsail to the DNS of the domain to validate domain\n ownership.

" + } + }, + "validationStatus": { + "target": "com.amazonaws.lightsail#CertificateDomainValidationStatus", + "traits": { + "smithy.api#documentation": "

The validation status of the record.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the domain name system (DNS) records that you must add to the DNS of your\n registered domain to validate ownership for an Amazon Lightsail SSL/TLS certificate.

" + } + }, + "com.amazonaws.lightsail#DomainValidationRecordList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#DomainValidationRecord" + } + }, + "com.amazonaws.lightsail#DownloadDefaultKeyPair": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#DownloadDefaultKeyPairRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#DownloadDefaultKeyPairResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Downloads the regional Amazon Lightsail default key pair.

\n

This action also creates a Lightsail default key pair if a default key pair\n does not currently exist in the Amazon Web Services Region.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/DownloadDefaultKeyPair", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#DownloadDefaultKeyPairRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.lightsail#DownloadDefaultKeyPairResult": { + "type": "structure", + "members": { + "publicKeyBase64": { + "target": "com.amazonaws.lightsail#Base64", + "traits": { + "smithy.api#documentation": "

A base64-encoded public key of the ssh-rsa type.

" + } + }, + "privateKeyBase64": { + "target": "com.amazonaws.lightsail#Base64", + "traits": { + "smithy.api#documentation": "

A base64-encoded RSA private key.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the default key pair was created.

" + } + } + } + }, + "com.amazonaws.lightsail#EligibleToRenew": { + "type": "string" + }, + "com.amazonaws.lightsail#EnableAddOn": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#EnableAddOnRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#EnableAddOnResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see\n the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/EnableAddOn", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#EnableAddOnRequest": { + "type": "structure", + "members": { + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the source resource for which to enable or modify the add-on.

", + "smithy.api#required": {} + } + }, + "addOnRequest": { + "target": "com.amazonaws.lightsail#AddOnRequest", + "traits": { + "smithy.api#documentation": "

An array of strings representing the add-on to enable or modify.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#EnableAddOnResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#EndpointRequest": { + "type": "structure", + "members": { + "containerName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the container for the endpoint.

", + "smithy.api#required": {} + } + }, + "containerPort": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The port of the container to which traffic is forwarded to.

", + "smithy.api#required": {} + } + }, + "healthCheck": { + "target": "com.amazonaws.lightsail#ContainerServiceHealthCheckConfig", + "traits": { + "smithy.api#documentation": "

An object that describes the health check configuration of the container.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the settings of a public endpoint for an Amazon Lightsail container\n service.

" + } + }, + "com.amazonaws.lightsail#Environment": { + "type": "map", + "key": { + "target": "com.amazonaws.lightsail#string" + }, + "value": { + "target": "com.amazonaws.lightsail#string" + } + }, + "com.amazonaws.lightsail#ExportSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#ExportSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#ExportSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).\n This operation results in an export snapshot record that can be used with the create\n cloud formation stack operation to create new Amazon EC2 instances.

\n

Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the\n instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in\n Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in\n Amazon EC2 as the source Lightsail snapshot.

\n

\n

The export snapshot operation supports tag-based access control via resource\n tags applied to the resource identified by source snapshot name. For more\n information, see the Amazon Lightsail Developer Guide.

\n \n

Use the get instance snapshots or get disk snapshots\n operations to get a list of snapshots that you can export to Amazon EC2.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/ExportSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#ExportSnapshotRecord": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The export snapshot record name.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the export snapshot record.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The date when the export snapshot record was created.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

The AWS Region and Availability Zone where the export snapshot record is located.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type (e.g., ExportSnapshotRecord).

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#RecordState", + "traits": { + "smithy.api#documentation": "

The state of the export snapshot record.

" + } + }, + "sourceInfo": { + "target": "com.amazonaws.lightsail#ExportSnapshotRecordSourceInfo", + "traits": { + "smithy.api#documentation": "

A list of objects describing the source of the export snapshot record.

" + } + }, + "destinationInfo": { + "target": "com.amazonaws.lightsail#DestinationInfo", + "traits": { + "smithy.api#documentation": "

A list of objects describing the destination of the export snapshot record.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an export snapshot record.

" + } + }, + "com.amazonaws.lightsail#ExportSnapshotRecordList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#ExportSnapshotRecord" + } + }, + "com.amazonaws.lightsail#ExportSnapshotRecordSourceInfo": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.lightsail#ExportSnapshotRecordSourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type (e.g., InstanceSnapshot or\n DiskSnapshot).

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The date when the source instance or disk snapshot was created.

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the source instance or disk snapshot.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source instance or disk snapshot.

" + } + }, + "fromResourceName": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the snapshot's source instance or disk.

" + } + }, + "fromResourceArn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot's source instance or disk.

" + } + }, + "instanceSnapshotInfo": { + "target": "com.amazonaws.lightsail#InstanceSnapshotInfo", + "traits": { + "smithy.api#documentation": "

A list of objects describing an instance snapshot.

" + } + }, + "diskSnapshotInfo": { + "target": "com.amazonaws.lightsail#DiskSnapshotInfo", + "traits": { + "smithy.api#documentation": "

A list of objects describing a disk snapshot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the source of an export snapshot record.

" + } + }, + "com.amazonaws.lightsail#ExportSnapshotRecordSourceType": { + "type": "enum", + "members": { + "InstanceSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceSnapshot" + } + }, + "DiskSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DiskSnapshot" + } + } + } + }, + "com.amazonaws.lightsail#ExportSnapshotRequest": { + "type": "structure", + "members": { + "sourceSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance or disk snapshot to be exported to Amazon EC2.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#ExportSnapshotResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#ForwardValues": { + "type": "enum", + "members": { + "none": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "none" + } + }, + "allowList": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "allow-list" + } + }, + "all": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "all" + } + } + } + }, + "com.amazonaws.lightsail#GetActiveNames": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetActiveNamesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetActiveNamesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the names of all active (not deleted) resources.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetActiveNames", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetActiveNamesRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetActiveNames request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetActiveNamesResult": { + "type": "structure", + "members": { + "activeNames": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The list of active names returned by the get active names request.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetActiveNames request and\n specify the next page token using the pageToken parameter.

" + } + } + } + }, + "com.amazonaws.lightsail#GetAlarms": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetAlarmsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetAlarmsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about the configured alarms. Specify an alarm name in your request to\n return information about a specific alarm, or specify a monitored resource name to return\n information about all alarms for a specific resource.

\n

An alarm is used to monitor a single metric for one of your resources. When a metric\n condition is met, the alarm can notify you by email, SMS text message, and a banner displayed\n on the Amazon Lightsail console. For more information, see Alarms\n in Amazon Lightsail.

", + "smithy.api#http": { + "method": "GET", + "uri": "/ls/api/2016-11-28/GetAlarms", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetAlarmsRequest": { + "type": "structure", + "members": { + "alarmName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the alarm.

\n

Specify an alarm name to return information about a specific alarm.

" + } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetAlarms request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" + } + }, + "monitoredResourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Lightsail resource being monitored by the alarm.

\n

Specify a monitored resource name to return information about all alarms for a specific\n resource.

" + } + } + } + }, + "com.amazonaws.lightsail#GetAlarmsResult": { + "type": "structure", + "members": { + "alarms": { + "target": "com.amazonaws.lightsail#AlarmsList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the alarms.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetAlarms request and\n specify the next page token using the pageToken parameter.

" + } + } + } + }, + "com.amazonaws.lightsail#GetAutoSnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetAutoSnapshotsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetAutoSnapshotsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the available automatic snapshots for an instance or disk. For more information,\n see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetAutoSnapshots", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetAutoSnapshotsRequest": { + "type": "structure", + "members": { + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the source instance or disk from which to get automatic snapshot\n information.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#GetAutoSnapshotsResult": { + "type": "structure", + "members": { + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the source instance or disk for the automatic snapshots.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type (e.g., Instance or Disk).

" + } + }, + "autoSnapshots": { + "target": "com.amazonaws.lightsail#AutoSnapshotDetailsList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the automatic snapshots that are available for the\n specified source instance or disk.

" + } + } + } + }, + "com.amazonaws.lightsail#GetBlueprints": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetBlueprintsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetBlueprintsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the list of available instance images, or blueprints. You can\n use a blueprint to create a new instance already running a specific operating system, as well\n as a preinstalled app or development stack. The software each instance is running depends on\n the blueprint image you choose.

\n \n

Use active blueprints when creating new instances. Inactive blueprints are listed to\n support customers with existing instances and are not necessarily available to create new\n instances. Blueprints are marked inactive when they become outdated due to operating system\n updates or new application releases.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetBlueprints", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetBlueprintsRequest": { + "type": "structure", + "members": { + "includeInactive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether to include inactive (unavailable) blueprints in the\n response of your request.

" + } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetBlueprints request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetBlueprintsResult": { + "type": "structure", + "members": { + "blueprints": { + "target": "com.amazonaws.lightsail#BlueprintList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs that contains information about the available\n blueprints.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetBlueprints request and\n specify the next page token using the pageToken parameter.

" + } + } + } + }, + "com.amazonaws.lightsail#GetBucketAccessKeys": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetBucketAccessKeysRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetBucketAccessKeysResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the existing access key IDs for the specified Amazon Lightsail bucket.

\n \n

This action does not return the secret access key value of an access key. You can get a\n secret access key only when you create it from the response of the CreateBucketAccessKey action. If you lose the secret access key, you must create\n a new access key.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetBucketAccessKeys", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetBucketAccessKeysRequest": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.lightsail#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which to return access keys.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#GetBucketAccessKeysResult": { + "type": "structure", + "members": { + "accessKeys": { + "target": "com.amazonaws.lightsail#AccessKeyList", + "traits": { + "smithy.api#documentation": "

An object that describes the access keys for the specified bucket.

" + } + } + } + }, + "com.amazonaws.lightsail#GetBucketBundles": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetBucketBundlesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetBucketBundlesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the bundles that you can apply to a Amazon Lightsail bucket.

\n

The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a\n bucket.

\n

Use the UpdateBucketBundle action to update the\n bundle for a bucket.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetBucketBundles", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetBucketBundlesRequest": { + "type": "structure", + "members": { + "includeInactive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether to include inactive (unavailable) bundles in the\n response of your request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetBucketBundlesResult": { + "type": "structure", + "members": { + "bundles": { + "target": "com.amazonaws.lightsail#BucketBundleList", + "traits": { + "smithy.api#documentation": "

An object that describes bucket bundles.

" + } + } + } + }, + "com.amazonaws.lightsail#GetBucketMetricData": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetBucketMetricDataRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetBucketMetricDataResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the data points of a specific metric for an Amazon Lightsail bucket.

\n

Metrics report the utilization of a bucket. View and collect metric data regularly to\n monitor the number of objects stored in a bucket (including object versions) and the storage\n space used by those objects.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetBucketMetricData", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetBucketMetricDataRequest": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.lightsail#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which to get metric data.

", + "smithy.api#required": {} + } + }, + "metricName": { + "target": "com.amazonaws.lightsail#BucketMetricName", + "traits": { + "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid bucket metric names are listed below, along with the most useful statistics to\n include in your request, and the published unit value.

\n \n

These bucket metrics are reported once per day.

\n \n ", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp indicating the earliest data to be returned.

", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp indicating the latest data to be returned.

", + "smithy.api#required": {} + } + }, + "period": { + "target": "com.amazonaws.lightsail#MetricPeriod", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

\n \n

Bucket storage metrics are reported once per day. Therefore, you should specify a period\n of 86400 seconds, which is the number of seconds in a day.

\n ", + "smithy.api#required": {} + } + }, + "statistics": { + "target": "com.amazonaws.lightsail#MetricStatisticList", + "traits": { + "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", + "smithy.api#required": {} + } + }, + "unit": { + "target": "com.amazonaws.lightsail#MetricUnit", + "traits": { + "smithy.api#documentation": "

The unit for the metric data request.

\n

Valid units depend on the metric data being requested. For the valid units with each\n available metric, see the metricName parameter.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#GetBucketMetricDataResult": { + "type": "structure", + "members": { + "metricName": { + "target": "com.amazonaws.lightsail#BucketMetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric returned.

" + } + }, + "metricData": { + "target": "com.amazonaws.lightsail#MetricDatapointList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" + } + } + } + }, + "com.amazonaws.lightsail#GetBuckets": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetBucketsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetBucketsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about one or more Amazon Lightsail buckets. The information returned\n includes the synchronization status of the Amazon Simple Storage Service (Amazon S3)\n account-level block public access feature for your Lightsail buckets.

\n

For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer\n Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetBuckets", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetBucketsRequest": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.lightsail#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which to return information.

\n

When omitted, the response includes all of your buckets in the Amazon Web Services Region\n where the request is made.

" + } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetBuckets request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" + } + }, + "includeConnectedResources": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether to include Lightsail instances that were given\n access to the bucket using the SetResourceAccessForBucket\n action.

" + } + } + } + }, + "com.amazonaws.lightsail#GetBucketsResult": { + "type": "structure", + "members": { + "buckets": { + "target": "com.amazonaws.lightsail#BucketList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe buckets.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetBuckets request and\n specify the next page token using the pageToken parameter.

" + } + }, + "accountLevelBpaSync": { + "target": "com.amazonaws.lightsail#AccountLevelBpaSync", + "traits": { + "smithy.api#documentation": "

An object that describes the synchronization status of the Amazon S3 account-level\n block public access feature for your Lightsail buckets.

\n

For more information about this feature and how it affects Lightsail buckets, see Block public access for buckets in Amazon Lightsail.

" + } + } + } + }, + "com.amazonaws.lightsail#GetBundles": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetBundlesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetBundlesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the bundles that you can apply to an Amazon Lightsail instance when you create\n it.

\n

A bundle describes the specifications of an instance, such as the monthly cost, amount of\n memory, the number of vCPUs, amount of storage space, and monthly network data transfer\n quota.

\n \n

Bundles are referred to as instance plans in the Lightsail\n console.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetBundles", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetBundlesRequest": { + "type": "structure", + "members": { + "includeInactive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether to include inactive (unavailable) bundles in the\n response of your request.

" + } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetBundles request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetBundlesResult": { + "type": "structure", + "members": { + "bundles": { + "target": "com.amazonaws.lightsail#BundleList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs that contains information about the available bundles.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetBundles request and\n specify the next page token using the pageToken parameter.

" + } + } + } + }, + "com.amazonaws.lightsail#GetCertificates": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetCertificatesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetCertificatesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about one or more Amazon Lightsail SSL/TLS certificates.

\n \n

To get a summary of a certificate, ommit includeCertificateDetails from\n your request. The response will include only the certificate Amazon Resource Name (ARN),\n certificate name, domain name, and tags.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetCertificates", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetCertificatesRequest": { + "type": "structure", + "members": { + "certificateStatuses": { + "target": "com.amazonaws.lightsail#CertificateStatusList", + "traits": { + "smithy.api#documentation": "

The status of the certificates for which to return information.

\n

For example, specify ISSUED to return only certificates with an\n ISSUED status.

\n

When omitted, the response includes all of your certificates in the Amazon Web Services\n Region where the request is made, regardless of their current status.

" + } + }, + "includeCertificateDetails": { + "target": "com.amazonaws.lightsail#IncludeCertificateDetails", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether to include detailed information about the certificates in the\n response.

\n

When omitted, the response includes only the certificate names, Amazon Resource Names\n (ARNs), domain names, and tags.

" + } + }, + "certificateName": { + "target": "com.amazonaws.lightsail#CertificateName", + "traits": { + "smithy.api#documentation": "

The name for the certificate for which to return information.

\n

When omitted, the response includes all of your certificates in the Amazon Web Services\n Region where the request is made.

" + } + } + } + }, + "com.amazonaws.lightsail#GetCertificatesResult": { + "type": "structure", + "members": { + "certificates": { + "target": "com.amazonaws.lightsail#CertificateSummaryList", + "traits": { + "smithy.api#documentation": "

An object that describes certificates.

" + } + } + } + }, + "com.amazonaws.lightsail#GetCloudFormationStackRecords": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetCloudFormationStackRecordsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetCloudFormationStackRecordsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the CloudFormation stack record created as a result of the create cloud\n formation stack operation.

\n

An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail\n snapshot.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetCloudFormationStackRecords", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetCloudFormationStackRecordsRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetClouFormationStackRecords request.\n If your results are paginated, the response will return a next page token that you can specify\n as the page token in a subsequent request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetCloudFormationStackRecordsResult": { + "type": "structure", + "members": { + "cloudFormationStackRecords": { + "target": "com.amazonaws.lightsail#CloudFormationStackRecordList", + "traits": { + "smithy.api#documentation": "

A list of objects describing the CloudFormation stack records.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another\n GetCloudFormationStackRecords request and specify the next page token using the\n pageToken parameter.

" + } + } + } + }, + "com.amazonaws.lightsail#GetContactMethods": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetContactMethodsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetContactMethodsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about the configured contact methods. Specify a protocol in your\n request to return information about a specific contact method.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services\n Regions, and SMS text messages cannot be sent to some countries/regions. For more information,\n see Notifications in Amazon Lightsail.

", + "smithy.api#http": { + "method": "GET", + "uri": "/ls/api/2016-11-28/GetContactMethods", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetContactMethodsRequest": { + "type": "structure", + "members": { + "protocols": { + "target": "com.amazonaws.lightsail#ContactProtocolsList", + "traits": { + "smithy.api#documentation": "

The protocols used to send notifications, such as Email, or SMS\n (text messaging).

\n

Specify a protocol in your request to return information about a specific contact method\n protocol.

" + } + } + } + }, + "com.amazonaws.lightsail#GetContactMethodsResult": { + "type": "structure", + "members": { + "contactMethods": { + "target": "com.amazonaws.lightsail#ContactMethodsList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the contact methods.

" + } + } + } + }, + "com.amazonaws.lightsail#GetContainerAPIMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetContainerAPIMetadataRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetContainerAPIMetadataResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about Amazon Lightsail containers, such as the current version of the\n Lightsail Control (lightsailctl) plugin.

", + "smithy.api#http": { + "method": "GET", + "uri": "/ls/api/2016-11-28/container-api-metadata", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetContainerAPIMetadataRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.lightsail#GetContainerAPIMetadataResult": { + "type": "structure", + "members": { + "metadata": { + "target": "com.amazonaws.lightsail#ContainerServiceMetadataEntryList", + "traits": { + "smithy.api#documentation": "

Metadata about Lightsail containers, such as the current version of the Lightsail\n Control (lightsailctl) plugin.

" + } + } + } + }, + "com.amazonaws.lightsail#GetContainerImages": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetContainerImagesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetContainerImagesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the container images that are registered to your Amazon Lightsail container\n service.

\n \n

If you created a deployment on your Lightsail container service that uses container\n images from a public registry like Docker Hub, those images are not returned as part of this\n action. Those images are not registered to your Lightsail container service.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/ls/api/2016-11-28/container-services/{serviceName}/images", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetContainerImagesRequest": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.lightsail#ContainerServiceName", + "traits": { + "smithy.api#documentation": "

The name of the container service for which to return registered container images.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#GetContainerImagesResult": { + "type": "structure", + "members": { + "containerImages": { + "target": "com.amazonaws.lightsail#ContainerImageList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe container images that are registered to the container\n service.

" + } + } + } + }, + "com.amazonaws.lightsail#GetContainerLog": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetContainerLogRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetContainerLogResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the log events of a container of your Amazon Lightsail container service.

\n

If your container service has more than one node (i.e., a scale greater than 1), then the\n log events that are returned for the specified container are merged from all nodes on your\n container service.

\n \n

Container logs are retained for a certain amount of time. For more information, see\n Amazon Lightsail\n endpoints and quotas in the Amazon Web Services General\n Reference.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/ls/api/2016-11-28/container-services/{serviceName}/containers/{containerName}/log", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetContainerLogRequest": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.lightsail#ContainerServiceName", + "traits": { + "smithy.api#documentation": "

The name of the container service for which to get a container log.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "containerName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the container that is either running or previously ran on the container\n service for which to return a log.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The start of the time interval for which to get log data.

\n

Constraints:

\n \n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", + "smithy.api#httpQuery": "startTime" + } + }, + "endTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The end of the time interval for which to get log data.

\n

Constraints:

\n \n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", + "smithy.api#httpQuery": "endTime" + } + }, + "filterPattern": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The pattern to use to filter the returned log events to a specific term.

\n

The following are a few examples of filter patterns that you can specify:

\n ", + "smithy.api#httpQuery": "filterPattern" + } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetContainerLog request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

", + "smithy.api#httpQuery": "pageToken" + } + } + } + }, + "com.amazonaws.lightsail#GetContainerLogResult": { + "type": "structure", + "members": { + "logEvents": { + "target": "com.amazonaws.lightsail#ContainerServiceLogEventList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the log events of a container.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetContainerLog request and\n specify the next page token using the pageToken parameter.

" + } + } + } + }, + "com.amazonaws.lightsail#GetContainerServiceDeployments": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetContainerServiceDeploymentsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetContainerServiceDeploymentsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the deployments for your Amazon Lightsail container service

\n

A deployment specifies the settings, such as the ports and launch command, of containers\n that are deployed to your container service.

\n

The deployments are ordered by version in ascending order. The newest version is listed at\n the top of the response.

\n \n

A set number of deployments are kept before the oldest one is replaced with the newest\n one. For more information, see Amazon Lightsail\n endpoints and quotas in the Amazon Web Services General\n Reference.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/ls/api/2016-11-28/container-services/{serviceName}/deployments", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetContainerServiceDeploymentsRequest": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.lightsail#ContainerServiceName", + "traits": { + "smithy.api#documentation": "

The name of the container service for which to return deployments.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#GetContainerServiceDeploymentsResult": { + "type": "structure", + "members": { + "deployments": { + "target": "com.amazonaws.lightsail#ContainerServiceDeploymentList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe deployments for a container service.

" + } + } + } + }, + "com.amazonaws.lightsail#GetContainerServiceMetricData": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetContainerServiceMetricDataRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetContainerServiceMetricDataResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the data points of a specific metric of your Amazon Lightsail container\n service.

\n

Metrics report the utilization of your resources. Monitor and collect metric data\n regularly to maintain the reliability, availability, and performance of your resources.

", + "smithy.api#http": { + "method": "GET", + "uri": "/ls/api/2016-11-28/container-services/{serviceName}/metrics", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetContainerServiceMetricDataRequest": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.lightsail#ContainerServiceName", + "traits": { + "smithy.api#documentation": "

The name of the container service for which to get metric data.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "metricName": { + "target": "com.amazonaws.lightsail#ContainerServiceMetricName", + "traits": { + "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid container service metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit value.

\n ", + "smithy.api#httpQuery": "metricName", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The start time of the time period.

", + "smithy.api#httpQuery": "startTime", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The end time of the time period.

", + "smithy.api#httpQuery": "endTime", + "smithy.api#required": {} + } + }, + "period": { + "target": "com.amazonaws.lightsail#MetricPeriod", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

\n

All container service metric data is available in 5-minute (300 seconds)\n granularity.

", + "smithy.api#httpQuery": "period", + "smithy.api#required": {} + } + }, + "statistics": { + "target": "com.amazonaws.lightsail#MetricStatisticList", + "traits": { + "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", + "smithy.api#httpQuery": "statistics", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#GetContainerServiceMetricDataResult": { + "type": "structure", + "members": { + "metricName": { + "target": "com.amazonaws.lightsail#ContainerServiceMetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric returned.

" + } + }, + "metricData": { + "target": "com.amazonaws.lightsail#MetricDatapointList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" + } + } + } + }, + "com.amazonaws.lightsail#GetContainerServicePowers": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetContainerServicePowersRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetContainerServicePowersResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the list of powers that can be specified for your Amazon Lightsail container\n services.

\n

The power specifies the amount of memory, the number of vCPUs, and the base price of the\n container service.

", + "smithy.api#http": { + "method": "GET", + "uri": "/ls/api/2016-11-28/container-service-powers", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetContainerServicePowersRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.lightsail#GetContainerServicePowersResult": { + "type": "structure", + "members": { + "powers": { + "target": "com.amazonaws.lightsail#ContainerServicePowerList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the powers that can be specified for a container\n service.

" + } + } + } + }, + "com.amazonaws.lightsail#GetContainerServices": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetContainerServicesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#ContainerServicesListResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about one or more of your Amazon Lightsail container services.

", + "smithy.api#http": { + "method": "GET", + "uri": "/ls/api/2016-11-28/container-services", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetContainerServicesRequest": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.lightsail#ContainerServiceName", + "traits": { + "smithy.api#documentation": "

The name of the container service for which to return information.

\n

When omitted, the response includes all of your container services in the Amazon Web Services Region where the request is made.

", + "smithy.api#httpQuery": "serviceName" + } + } + } + }, + "com.amazonaws.lightsail#GetDisk": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetDiskRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetDiskResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specific block storage disk.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetDisk", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetDiskRequest": { + "type": "structure", + "members": { + "diskName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the disk (e.g., my-disk).

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#GetDiskResult": { + "type": "structure", + "members": { + "disk": { + "target": "com.amazonaws.lightsail#Disk", + "traits": { + "smithy.api#documentation": "

An object containing information about the disk.

" + } + } + } + }, + "com.amazonaws.lightsail#GetDiskSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetDiskSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetDiskSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specific block storage disk snapshot.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetDiskSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetDiskSnapshotRequest": { + "type": "structure", + "members": { + "diskSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the disk snapshot (e.g., my-disk-snapshot).

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#GetDiskSnapshotResult": { + "type": "structure", + "members": { + "diskSnapshot": { + "target": "com.amazonaws.lightsail#DiskSnapshot", + "traits": { + "smithy.api#documentation": "

An object containing information about the disk snapshot.

" + } + } + } + }, + "com.amazonaws.lightsail#GetDiskSnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetDiskSnapshotsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetDiskSnapshotsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about all block storage disk snapshots in your AWS account and\n region.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetDiskSnapshots", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetDiskSnapshotsRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetDiskSnapshots request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetDiskSnapshotsResult": { + "type": "structure", + "members": { + "diskSnapshots": { + "target": "com.amazonaws.lightsail#DiskSnapshotList", + "traits": { + "smithy.api#documentation": "

An array of objects containing information about all block storage disk snapshots.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetDiskSnapshots request and\n specify the next page token using the pageToken parameter.

" + } + } + } + }, + "com.amazonaws.lightsail#GetDisks": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetDisksRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetDisksResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about all block storage disks in your AWS account and region.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetDisks", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetDisksRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetDisks request. If your results are\n paginated, the response will return a next page token that you can specify as the page token\n in a subsequent request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetDisksResult": { + "type": "structure", + "members": { + "disks": { + "target": "com.amazonaws.lightsail#DiskList", + "traits": { + "smithy.api#documentation": "

An array of objects containing information about all block storage disks.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetDisks request and specify\n the next page token using the pageToken parameter.

" + } + } + } + }, + "com.amazonaws.lightsail#GetDistributionBundles": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetDistributionBundlesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetDistributionBundlesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the bundles that can be applied to your Amazon Lightsail content delivery network\n (CDN) distributions.

\n

A distribution bundle specifies the monthly network transfer quota and monthly cost of\n your distribution.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetDistributionBundles", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetDistributionBundlesRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.lightsail#GetDistributionBundlesResult": { + "type": "structure", + "members": { + "bundles": { + "target": "com.amazonaws.lightsail#DistributionBundleList", + "traits": { + "smithy.api#documentation": "

An object that describes a distribution bundle.

" + } + } + } + }, + "com.amazonaws.lightsail#GetDistributionLatestCacheReset": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetDistributionLatestCacheResetRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetDistributionLatestCacheResetResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail\n content delivery network (CDN) distribution.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetDistributionLatestCacheReset", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetDistributionLatestCacheResetRequest": { + "type": "structure", + "members": { + "distributionName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the distribution for which to return the timestamp of the last cache\n reset.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

\n

When omitted, the response includes the latest cache reset timestamp of all your\n distributions.

" + } + } + } + }, + "com.amazonaws.lightsail#GetDistributionLatestCacheResetResult": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The status of the last cache reset.

" + } + }, + "createTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp of the last cache reset (e.g., 1479734909.17) in Unix time\n format.

" + } + } + } + }, + "com.amazonaws.lightsail#GetDistributionMetricData": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetDistributionMetricDataRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetDistributionMetricDataResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the data points of a specific metric for an Amazon Lightsail content delivery\n network (CDN) distribution.

\n

Metrics report the utilization of your resources, and the error counts generated by them.\n Monitor and collect metric data regularly to maintain the reliability, availability, and\n performance of your resources.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetDistributionMetricData", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetDistributionMetricDataRequest": { + "type": "structure", + "members": { + "distributionName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the distribution for which to get metric data.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

", + "smithy.api#required": {} + } + }, + "metricName": { + "target": "com.amazonaws.lightsail#DistributionMetricName", + "traits": { + "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid distribution metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value.

\n ", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.lightsail#timestamp", + "traits": { + "smithy.api#documentation": "

The start of the time interval for which to get metric data.

\n

Constraints:

\n \n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "com.amazonaws.lightsail#timestamp", + "traits": { + "smithy.api#documentation": "

The end of the time interval for which to get metric data.

\n

Constraints:

\n \n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", + "smithy.api#required": {} + } + }, + "period": { + "target": "com.amazonaws.lightsail#MetricPeriod", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The granularity, in seconds, for the metric data points that will be returned.

", + "smithy.api#required": {} + } + }, + "unit": { + "target": "com.amazonaws.lightsail#MetricUnit", + "traits": { + "smithy.api#documentation": "

The unit for the metric data request.

\n

Valid units depend on the metric data being requested. For the valid units with each\n available metric, see the metricName parameter.

", + "smithy.api#required": {} + } + }, + "statistics": { + "target": "com.amazonaws.lightsail#MetricStatisticList", + "traits": { + "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#GetDistributionMetricDataResult": { + "type": "structure", + "members": { + "metricName": { + "target": "com.amazonaws.lightsail#DistributionMetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric returned.

" + } + }, + "metricData": { + "target": "com.amazonaws.lightsail#MetricDatapointList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" + } + } + } + }, + "com.amazonaws.lightsail#GetDistributions": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetDistributionsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetDistributionsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about one or more of your Amazon Lightsail content delivery network\n (CDN) distributions.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetDistributions", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetDistributionsRequest": { + "type": "structure", + "members": { + "distributionName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the distribution for which to return information.

\n

When omitted, the response includes all of your distributions in the Amazon Web Services\n Region where the request is made.

" + } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetDistributions request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetDistributionsResult": { + "type": "structure", + "members": { + "distributions": { + "target": "com.amazonaws.lightsail#DistributionList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe your distributions.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetDistributions request and\n specify the next page token using the pageToken parameter.

" + } + } + } + }, + "com.amazonaws.lightsail#GetDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetDomainRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetDomainResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specific domain recordset.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetDomain", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetDomainRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name for which your want to return information about.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#GetDomainResult": { + "type": "structure", + "members": { + "domain": { + "target": "com.amazonaws.lightsail#Domain", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs containing information about your get domain request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetDomains": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetDomainsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetDomainsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all domains in the user's account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetDomains", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetDomainsRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetDomains request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetDomainsResult": { + "type": "structure", + "members": { + "domains": { + "target": "com.amazonaws.lightsail#DomainList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs containing information about each of the domain entries in the\n user's account.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetDomains request and\n specify the next page token using the pageToken parameter.

" + } + } + } + }, + "com.amazonaws.lightsail#GetExportSnapshotRecords": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetExportSnapshotRecordsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetExportSnapshotRecordsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns all export snapshot records created as a result of the export\n snapshot operation.

\n

An export snapshot record can be used to create a new Amazon EC2 instance and its related\n resources with the CreateCloudFormationStack\n action.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetExportSnapshotRecords", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetExportSnapshotRecordsRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetExportSnapshotRecords request. If\n your results are paginated, the response will return a next page token that you can specify as\n the page token in a subsequent request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetExportSnapshotRecordsResult": { + "type": "structure", + "members": { + "exportSnapshotRecords": { + "target": "com.amazonaws.lightsail#ExportSnapshotRecordList", + "traits": { + "smithy.api#documentation": "

A list of objects describing the export snapshot records.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetExportSnapshotRecords\n request and specify the next page token using the pageToken parameter.

" + } + } + } + }, + "com.amazonaws.lightsail#GetInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetInstanceRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specific Amazon Lightsail instance, which is a virtual private\n server.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetInstance", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetInstanceAccessDetails": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetInstanceAccessDetailsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetInstanceAccessDetailsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns temporary SSH keys you can use to connect to a specific virtual private server, or\n instance.

\n

The get instance access details operation supports tag-based access control\n via resource tags applied to the resource identified by instance name. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetInstanceAccessDetails", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetInstanceAccessDetailsRequest": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance to access.

", + "smithy.api#required": {} + } + }, + "protocol": { + "target": "com.amazonaws.lightsail#InstanceAccessProtocol", + "traits": { + "smithy.api#documentation": "

The protocol to use to connect to your instance. Defaults to ssh.

" + } + } + } + }, + "com.amazonaws.lightsail#GetInstanceAccessDetailsResult": { + "type": "structure", + "members": { + "accessDetails": { + "target": "com.amazonaws.lightsail#InstanceAccessDetails", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs containing information about a get instance access\n request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetInstanceMetricData": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetInstanceMetricDataRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetInstanceMetricDataResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the data points for the specified Amazon Lightsail instance metric, given an\n instance name.

\n

Metrics report the utilization of your resources, and the error counts generated by them.\n Monitor and collect metric data regularly to maintain the reliability, availability, and\n performance of your resources.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetInstanceMetricData", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetInstanceMetricDataRequest": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance for which you want to get metrics data.

", + "smithy.api#required": {} + } + }, + "metricName": { + "target": "com.amazonaws.lightsail#InstanceMetricName", + "traits": { + "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid instance metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value.

\n ", + "smithy.api#required": {} + } + }, + "period": { + "target": "com.amazonaws.lightsail#MetricPeriod", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

\n

The StatusCheckFailed, StatusCheckFailed_Instance, and\n StatusCheckFailed_System instance metric data is available in 1-minute (60\n seconds) granularity. All other instance metric data is available in 5-minute (300 seconds)\n granularity.

", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.lightsail#timestamp", + "traits": { + "smithy.api#documentation": "

The start time of the time period.

", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "com.amazonaws.lightsail#timestamp", + "traits": { + "smithy.api#documentation": "

The end time of the time period.

", + "smithy.api#required": {} + } + }, + "unit": { + "target": "com.amazonaws.lightsail#MetricUnit", + "traits": { + "smithy.api#documentation": "

The unit for the metric data request. Valid units depend on the metric data being\n requested. For the valid units to specify with each available metric, see the\n metricName parameter.

", + "smithy.api#required": {} + } + }, + "statistics": { + "target": "com.amazonaws.lightsail#MetricStatisticList", + "traits": { + "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#GetInstanceMetricDataResult": { + "type": "structure", + "members": { + "metricName": { + "target": "com.amazonaws.lightsail#InstanceMetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric returned.

" + } + }, + "metricData": { + "target": "com.amazonaws.lightsail#MetricDatapointList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" + } + } + } + }, + "com.amazonaws.lightsail#GetInstancePortStates": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetInstancePortStatesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetInstancePortStatesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses\n allowed to connect to the instance through the ports, and the protocol.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetInstancePortStates", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetInstancePortStatesRequest": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance for which to return firewall port states.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#GetInstancePortStatesResult": { + "type": "structure", + "members": { + "portStates": { + "target": "com.amazonaws.lightsail#InstancePortStateList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the firewall port states for the specified\n instance.

" + } + } + } + }, + "com.amazonaws.lightsail#GetInstanceRequest": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#GetInstanceResult": { + "type": "structure", + "members": { + "instance": { + "target": "com.amazonaws.lightsail#Instance", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs containing information about the specified instance.

" + } + } + } + }, + "com.amazonaws.lightsail#GetInstanceSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetInstanceSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetInstanceSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specific instance snapshot.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetInstanceSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetInstanceSnapshotRequest": { + "type": "structure", + "members": { + "instanceSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the snapshot for which you are requesting information.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#GetInstanceSnapshotResult": { + "type": "structure", + "members": { + "instanceSnapshot": { + "target": "com.amazonaws.lightsail#InstanceSnapshot", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs containing information about the results of your get instance\n snapshot request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetInstanceSnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetInstanceSnapshotsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetInstanceSnapshotsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns all instance snapshots for the user's account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetInstanceSnapshots", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetInstanceSnapshotsRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetInstanceSnapshots request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetInstanceSnapshotsResult": { + "type": "structure", + "members": { + "instanceSnapshots": { + "target": "com.amazonaws.lightsail#InstanceSnapshotList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs containing information about the results of your get instance\n snapshots request.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetInstanceSnapshots request\n and specify the next page token using the pageToken parameter.

" + } + } + } + }, + "com.amazonaws.lightsail#GetInstanceState": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetInstanceStateRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetInstanceStateResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the state of a specific instance. Works on one instance at a time.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetInstanceState", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetInstanceStateRequest": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance to get state information about.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#GetInstanceStateResult": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.lightsail#InstanceState", + "traits": { + "smithy.api#documentation": "

The state of the instance.

" + } + } + } + }, + "com.amazonaws.lightsail#GetInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetInstancesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetInstancesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about all Amazon Lightsail virtual private servers, or\n instances.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetInstances", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetInstancesRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetInstances request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetInstancesResult": { + "type": "structure", + "members": { + "instances": { + "target": "com.amazonaws.lightsail#InstanceList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs containing information about your instances.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetInstances request and\n specify the next page token using the pageToken parameter.

" + } + } + } + }, + "com.amazonaws.lightsail#GetKeyPair": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetKeyPairRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetKeyPairResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specific key pair.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetKeyPair", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetKeyPairRequest": { + "type": "structure", + "members": { + "keyPairName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the key pair for which you are requesting information.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#GetKeyPairResult": { + "type": "structure", + "members": { + "keyPair": { + "target": "com.amazonaws.lightsail#KeyPair", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs containing information about the key pair.

" + } + } + } + }, + "com.amazonaws.lightsail#GetKeyPairs": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetKeyPairsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetKeyPairsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about all key pairs in the user's account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetKeyPairs", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetKeyPairsRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetKeyPairs request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" + } + }, + "includeDefaultKeyPair": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether to include the default key pair in the response of\n your request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetKeyPairsResult": { + "type": "structure", + "members": { + "keyPairs": { + "target": "com.amazonaws.lightsail#KeyPairList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs containing information about the key pairs.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetKeyPairs request and\n specify the next page token using the pageToken parameter.

" + } + } + } + }, + "com.amazonaws.lightsail#GetLoadBalancer": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetLoadBalancerRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetLoadBalancerResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about the specified Lightsail load balancer.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetLoadBalancer", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetLoadBalancerMetricData": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetLoadBalancerMetricDataRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetLoadBalancerMetricDataResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about health metrics for your Lightsail load balancer.

\n

Metrics report the utilization of your resources, and the error counts generated by them.\n Monitor and collect metric data regularly to maintain the reliability, availability, and\n performance of your resources.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetLoadBalancerMetricData", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetLoadBalancerMetricDataRequest": { + "type": "structure", + "members": { + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the load balancer.

", + "smithy.api#required": {} + } + }, + "metricName": { + "target": "com.amazonaws.lightsail#LoadBalancerMetricName", + "traits": { + "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid load balancer metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value.

\n ", + "smithy.api#required": {} + } + }, + "period": { + "target": "com.amazonaws.lightsail#MetricPeriod", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.lightsail#timestamp", + "traits": { + "smithy.api#documentation": "

The start time of the period.

", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "com.amazonaws.lightsail#timestamp", + "traits": { + "smithy.api#documentation": "

The end time of the period.

", + "smithy.api#required": {} + } + }, + "unit": { + "target": "com.amazonaws.lightsail#MetricUnit", + "traits": { + "smithy.api#documentation": "

The unit for the metric data request. Valid units depend on the metric data being\n requested. For the valid units with each available metric, see the metricName\n parameter.

", + "smithy.api#required": {} + } + }, + "statistics": { + "target": "com.amazonaws.lightsail#MetricStatisticList", + "traits": { + "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#GetLoadBalancerMetricDataResult": { + "type": "structure", + "members": { + "metricName": { + "target": "com.amazonaws.lightsail#LoadBalancerMetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric returned.

" + } + }, + "metricData": { + "target": "com.amazonaws.lightsail#MetricDatapointList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" + } + } + } + }, + "com.amazonaws.lightsail#GetLoadBalancerRequest": { + "type": "structure", + "members": { + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the load balancer.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#GetLoadBalancerResult": { + "type": "structure", + "members": { + "loadBalancer": { + "target": "com.amazonaws.lightsail#LoadBalancer", + "traits": { + "smithy.api#documentation": "

An object containing information about your load balancer.

" + } + } + } + }, + "com.amazonaws.lightsail#GetLoadBalancerTlsCertificates": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetLoadBalancerTlsCertificatesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetLoadBalancerTlsCertificatesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about the TLS certificates that are associated with the specified\n Lightsail load balancer.

\n

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

\n

You can have a maximum of 2 certificates associated with a Lightsail load balancer. One\n is active and the other is inactive.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetLoadBalancerTlsCertificates", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetLoadBalancerTlsCertificatesRequest": { + "type": "structure", + "members": { + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the load balancer you associated with your SSL/TLS certificate.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#GetLoadBalancerTlsCertificatesResult": { + "type": "structure", + "members": { + "tlsCertificates": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateList", + "traits": { + "smithy.api#documentation": "

An array of LoadBalancerTlsCertificate objects describing your SSL/TLS\n certificates.

" + } + } + } + }, + "com.amazonaws.lightsail#GetLoadBalancerTlsPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetLoadBalancerTlsPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetLoadBalancerTlsPoliciesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of TLS security policies that you can apply to Lightsail load\n balancers.

\n

For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load\n balancers in the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetLoadBalancerTlsPolicies", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetLoadBalancerTlsPoliciesRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetLoadBalancerTlsPolicies request.\n If your results are paginated, the response will return a next page token that you can specify\n as the page token in a subsequent request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetLoadBalancerTlsPoliciesResult": { + "type": "structure", + "members": { + "tlsPolicies": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsPolicyList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the TLS security policies that are available.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetLoadBalancerTlsPolicies\n request and specify the next page token using the pageToken parameter.

" + } + } + } + }, + "com.amazonaws.lightsail#GetLoadBalancers": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetLoadBalancersRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetLoadBalancersResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about all load balancers in an account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetLoadBalancers", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetLoadBalancersRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetLoadBalancers request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetLoadBalancersResult": { + "type": "structure", + "members": { + "loadBalancers": { + "target": "com.amazonaws.lightsail#LoadBalancerList", + "traits": { + "smithy.api#documentation": "

An array of LoadBalancer objects describing your load balancers.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetLoadBalancers request and\n specify the next page token using the pageToken parameter.

" + } + } + } + }, + "com.amazonaws.lightsail#GetOperation": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetOperationRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetOperationResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specific operation. Operations include events such as when you\n create an instance, allocate a static IP, attach a static IP, and so on.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetOperation", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetOperationRequest": { + "type": "structure", + "members": { + "operationId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A GUID used to identify the operation.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#GetOperationResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetOperations": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetOperationsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetOperationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about all operations.

\n

Results are returned from oldest to newest, up to a maximum of 200. Results can be paged\n by making each subsequent call to GetOperations use the maximum (last)\n statusChangedAt value from the previous request.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetOperations", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetOperationsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetOperationsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetOperationsForResourceResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets operations for a specific resource (e.g., an instance or a static IP).

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetOperationsForResource", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetOperationsForResourceRequest": { + "type": "structure", + "members": { + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the resource for which you are requesting information.

", + "smithy.api#required": {} + } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetOperationsForResource request. If\n your results are paginated, the response will return a next page token that you can specify as\n the page token in a subsequent request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetOperationsForResourceResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + }, + "nextPageCount": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

(Deprecated) Returns the number of pages of results that remain.

\n \n

In releases prior to June 12, 2017, this parameter returned null by the\n API. It is now deprecated, and the API returns the next page token parameter\n instead.

\n " + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetOperationsForResource\n request and specify the next page token using the pageToken parameter.

" + } + } + } + }, + "com.amazonaws.lightsail#GetOperationsRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetOperations request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetOperationsResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetOperations request and\n specify the next page token using the pageToken parameter.

" + } + } + } + }, + "com.amazonaws.lightsail#GetRegions": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetRegionsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetRegionsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all valid regions for Amazon Lightsail. Use the include\n availability zones parameter to also return the Availability Zones in a\n region.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetRegions", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetRegionsRequest": { + "type": "structure", + "members": { + "includeAvailabilityZones": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether to also include Availability Zones in your get regions\n request. Availability Zones are indicated with a letter: e.g., us-east-2a.

" + } + }, + "includeRelationalDatabaseAvailabilityZones": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether to also include Availability Zones for databases in\n your get regions request. Availability Zones are indicated with a letter (e.g.,\n us-east-2a).

" + } + } + } + }, + "com.amazonaws.lightsail#GetRegionsResult": { + "type": "structure", + "members": { + "regions": { + "target": "com.amazonaws.lightsail#RegionList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs containing information about your get regions request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specific database in Amazon Lightsail.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetRelationalDatabase", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseBlueprints": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseBlueprintsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseBlueprintsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes\n the major engine version of a database.

\n

You can use a blueprint ID to create a new database that runs a specific database\n engine.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetRelationalDatabaseBlueprints", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseBlueprintsRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseBlueprints\n request. If your results are paginated, the response will return a next page token that you\n can specify as the page token in a subsequent request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseBlueprintsResult": { + "type": "structure", + "members": { + "blueprints": { + "target": "com.amazonaws.lightsail#RelationalDatabaseBlueprintList", + "traits": { + "smithy.api#documentation": "

An object describing the result of your get relational database blueprints request.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another\n GetRelationalDatabaseBlueprints request and specify the next page token using\n the pageToken parameter.

" + } + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseBundles": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseBundlesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseBundlesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the\n performance specifications for a database.

\n

You can use a bundle ID to create a new database with explicit performance\n specifications.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetRelationalDatabaseBundles", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseBundlesRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseBundles request.\n If your results are paginated, the response will return a next page token that you can specify\n as the page token in a subsequent request.

" + } + }, + "includeInactive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether to include inactive (unavailable) bundles in the\n response of your request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseBundlesResult": { + "type": "structure", + "members": { + "bundles": { + "target": "com.amazonaws.lightsail#RelationalDatabaseBundleList", + "traits": { + "smithy.api#documentation": "

An object describing the result of your get relational database bundles request.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetRelationalDatabaseBundles\n request and specify the next page token using the pageToken parameter.

" + } + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseEventsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseEventsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of events for a specific database in Amazon Lightsail.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetRelationalDatabaseEvents", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseEventsRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the database from which to get events.

", + "smithy.api#required": {} + } + }, + "durationInMinutes": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The number of minutes in the past from which to retrieve events. For example, to get all\n events from the past 2 hours, enter 120.

\n

Default: 60\n

\n

The minimum is 1 and the maximum is 14 days (20160 minutes).

" + } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseEvents request.\n If your results are paginated, the response will return a next page token that you can specify\n as the page token in a subsequent request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseEventsResult": { + "type": "structure", + "members": { + "relationalDatabaseEvents": { + "target": "com.amazonaws.lightsail#RelationalDatabaseEventList", + "traits": { + "smithy.api#documentation": "

An object describing the result of your get relational database events request.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetRelationalDatabaseEvents\n request and specify the next page token using the pageToken parameter.

" + } + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseLogEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogEventsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogEventsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of log events for a database in Amazon Lightsail.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetRelationalDatabaseLogEvents", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseLogEventsRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your database for which to get log events.

", + "smithy.api#required": {} + } + }, + "logStreamName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the log stream.

\n

Use the get relational database log streams operation to get a list of\n available log streams.

", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The start of the time interval from which to get log events.

\n

Constraints:

\n " + } + }, + "endTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The end of the time interval from which to get log events.

\n

Constraints:

\n " + } + }, + "startFromHead": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Parameter to specify if the log should start from head or tail. If true is\n specified, the log event starts from the head of the log. If false is specified,\n the log event starts from the tail of the log.

\n \n

For PostgreSQL, the default value of false is the only option\n available.

\n " + } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next or previous page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseLogEvents\n request. If your results are paginated, the response will return a next forward token and/or\n next backward token that you can specify as the page token in a subsequent request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseLogEventsResult": { + "type": "structure", + "members": { + "resourceLogEvents": { + "target": "com.amazonaws.lightsail#LogEventList", + "traits": { + "smithy.api#documentation": "

An object describing the result of your get relational database log events request.

" + } + }, + "nextBackwardToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

A token used for advancing to the previous page of results from your get relational\n database log events request.

" + } + }, + "nextForwardToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

A token used for advancing to the next page of results from your get relational database\n log events request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseLogStreams": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogStreamsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogStreamsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of available log streams for a specific database in Amazon Lightsail.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetRelationalDatabaseLogStreams", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseLogStreamsRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your database for which to get log streams.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseLogStreamsResult": { + "type": "structure", + "members": { + "logStreams": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

An object describing the result of your get relational database log streams\n request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPassword": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPasswordRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPasswordResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the current, previous, or pending versions of the master user password for a\n Lightsail database.

\n

The GetRelationalDatabaseMasterUserPassword operation supports tag-based\n access control via resource tags applied to the resource identified by\n relationalDatabaseName.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetRelationalDatabaseMasterUserPassword", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPasswordRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your database for which to get the master user password.

", + "smithy.api#required": {} + } + }, + "passwordVersion": { + "target": "com.amazonaws.lightsail#RelationalDatabasePasswordVersion", + "traits": { + "smithy.api#documentation": "

The password version to return.

\n

Specifying CURRENT or PREVIOUS returns the current or previous\n passwords respectively. Specifying PENDING returns the newest version of the\n password that will rotate to CURRENT. After the PENDING password\n rotates to CURRENT, the PENDING password is no longer\n available.

\n

Default: CURRENT\n

" + } + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPasswordResult": { + "type": "structure", + "members": { + "masterUserPassword": { + "target": "com.amazonaws.lightsail#SensitiveString", + "traits": { + "smithy.api#documentation": "

The master user password for the password version specified.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the specified version of the master user password was created.

" + } + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseMetricData": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseMetricDataRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseMetricDataResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the data points of the specified metric for a database in Amazon Lightsail.

\n

Metrics report the utilization of your resources, and the error counts generated by them.\n Monitor and collect metric data regularly to maintain the reliability, availability, and\n performance of your resources.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetRelationalDatabaseMetricData", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseMetricDataRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your database from which to get metric data.

", + "smithy.api#required": {} + } + }, + "metricName": { + "target": "com.amazonaws.lightsail#RelationalDatabaseMetricName", + "traits": { + "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid relational database metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value. All relational database metric data is available in 1-minute (60 seconds)\n granularity.

\n ", + "smithy.api#required": {} + } + }, + "period": { + "target": "com.amazonaws.lightsail#MetricPeriod", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

\n

All relational database metric data is available in 1-minute (60 seconds)\n granularity.

", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The start of the time interval from which to get metric data.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The end of the time interval from which to get metric data.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "unit": { + "target": "com.amazonaws.lightsail#MetricUnit", + "traits": { + "smithy.api#documentation": "

The unit for the metric data request. Valid units depend on the metric data being\n requested. For the valid units with each available metric, see the metricName\n parameter.

", + "smithy.api#required": {} + } + }, + "statistics": { + "target": "com.amazonaws.lightsail#MetricStatisticList", + "traits": { + "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseMetricDataResult": { + "type": "structure", + "members": { + "metricName": { + "target": "com.amazonaws.lightsail#RelationalDatabaseMetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric returned.

" + } + }, + "metricData": { + "target": "com.amazonaws.lightsail#MetricDatapointList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" + } + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseParameters": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseParametersRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseParametersResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns all of the runtime parameters offered by the underlying database software, or\n engine, for a specific database in Amazon Lightsail.

\n

In addition to the parameter names and values, this operation returns other information\n about each parameter. This information includes whether changes require a reboot, whether the\n parameter is modifiable, the allowed values, and the data types.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetRelationalDatabaseParameters", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseParametersRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your database for which to get parameters.

", + "smithy.api#required": {} + } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseParameters\n request. If your results are paginated, the response will return a next page token that you\n can specify as the page token in a subsequent request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseParametersResult": { + "type": "structure", + "members": { + "parameters": { + "target": "com.amazonaws.lightsail#RelationalDatabaseParameterList", + "traits": { + "smithy.api#documentation": "

An object describing the result of your get relational database parameters request.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another\n GetRelationalDatabaseParameters request and specify the next page token using\n the pageToken parameter.

" + } + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the database that you are looking up.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseResult": { + "type": "structure", + "members": { + "relationalDatabase": { + "target": "com.amazonaws.lightsail#RelationalDatabase", + "traits": { + "smithy.api#documentation": "

An object describing the specified database.

" + } + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specific database snapshot in Amazon Lightsail.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetRelationalDatabaseSnapshot", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotRequest": { + "type": "structure", + "members": { + "relationalDatabaseSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the database snapshot for which to get information.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotResult": { + "type": "structure", + "members": { + "relationalDatabaseSnapshot": { + "target": "com.amazonaws.lightsail#RelationalDatabaseSnapshot", + "traits": { + "smithy.api#documentation": "

An object describing the specified database snapshot.

" + } + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseSnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about all of your database snapshots in Amazon Lightsail.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetRelationalDatabaseSnapshots", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotsRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseSnapshots\n request. If your results are paginated, the response will return a next page token that you\n can specify as the page token in a subsequent request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotsResult": { + "type": "structure", + "members": { + "relationalDatabaseSnapshots": { + "target": "com.amazonaws.lightsail#RelationalDatabaseSnapshotList", + "traits": { + "smithy.api#documentation": "

An object describing the result of your get relational database snapshots request.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another\n GetRelationalDatabaseSnapshots request and specify the next page token using\n the pageToken parameter.

" + } + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabases": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetRelationalDatabasesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetRelationalDatabasesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about all of your databases in Amazon Lightsail.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetRelationalDatabases", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabasesRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabases request. If\n your results are paginated, the response will return a next page token that you can specify as\n the page token in a subsequent request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetRelationalDatabasesResult": { + "type": "structure", + "members": { + "relationalDatabases": { + "target": "com.amazonaws.lightsail#RelationalDatabaseList", + "traits": { + "smithy.api#documentation": "

An object describing the result of your get relational databases request.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetRelationalDatabases\n request and specify the next page token using the pageToken parameter.

" + } + } + } + }, + "com.amazonaws.lightsail#GetStaticIp": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetStaticIpRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetStaticIpResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about an Amazon Lightsail static IP.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetStaticIp", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetStaticIpRequest": { + "type": "structure", + "members": { + "staticIpName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the static IP in Lightsail.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#GetStaticIpResult": { + "type": "structure", + "members": { + "staticIp": { + "target": "com.amazonaws.lightsail#StaticIp", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs containing information about the requested static IP.

" + } + } + } + }, + "com.amazonaws.lightsail#GetStaticIps": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetStaticIpsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetStaticIpsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about all static IPs in the user's account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetStaticIps", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetStaticIpsRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetStaticIps request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetStaticIpsResult": { + "type": "structure", + "members": { + "staticIps": { + "target": "com.amazonaws.lightsail#StaticIpList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs containing information about your get static IPs\n request.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetStaticIps request and\n specify the next page token using the pageToken parameter.

" + } + } + } + }, + "com.amazonaws.lightsail#HeaderEnum": { + "type": "enum", + "members": { + "accept": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Accept" + } + }, + "acceptCharset": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Accept-Charset" + } + }, + "acceptDatetime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Accept-Datetime" + } + }, + "acceptEncoding": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Accept-Encoding" + } + }, + "acceptLanguage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Accept-Language" + } + }, + "authorization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Authorization" + } + }, + "cloudFrontForwardedProto": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudFront-Forwarded-Proto" + } + }, + "cloudFrontIsDesktopViewer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudFront-Is-Desktop-Viewer" + } + }, + "cloudFrontIsMobileViewer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudFront-Is-Mobile-Viewer" + } + }, + "cloudFrontIsSmartTVViewer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudFront-Is-SmartTV-Viewer" + } + }, + "cloudFrontIsTabletViewer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudFront-Is-Tablet-Viewer" + } + }, + "cloudFrontViewerCountry": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudFront-Viewer-Country" + } + }, + "host": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Host" + } + }, + "origin": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Origin" + } + }, + "referer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Referer" + } + } + } + }, + "com.amazonaws.lightsail#HeaderForwardList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#HeaderEnum" + } + }, + "com.amazonaws.lightsail#HeaderObject": { + "type": "structure", + "members": { + "option": { + "target": "com.amazonaws.lightsail#ForwardValues", + "traits": { + "smithy.api#documentation": "

The headers that you want your distribution to forward to your origin and base caching\n on.

\n

You can configure your distribution to do one of the following:

\n " + } + }, + "headersAllowList": { + "target": "com.amazonaws.lightsail#HeaderForwardList", + "traits": { + "smithy.api#documentation": "

The specific headers to forward to your distribution's origin.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the request headers that a Lightsail distribution bases caching on.

\n

For the headers that you specify, your distribution caches separate versions of the\n specified content based on the header values in viewer requests. For example, suppose viewer\n requests for logo.jpg contain a custom product header that has a\n value of either acme or apex, and you configure your distribution to\n cache your content based on values in the product header. Your distribution\n forwards the product header to the origin and caches the response from the origin\n once for each header value.\n

" + } + }, + "com.amazonaws.lightsail#HostKeyAttributes": { + "type": "structure", + "members": { + "algorithm": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The SSH host key algorithm or the RDP certificate format.

\n

For SSH host keys, the algorithm may be ssh-rsa,\n ecdsa-sha2-nistp256, ssh-ed25519, etc. For RDP certificates, the\n algorithm is always x509-cert.

" + } + }, + "publicKey": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The public SSH host key or the RDP certificate.

" + } + }, + "witnessedAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The time that the SSH host key or RDP certificate was recorded by Lightsail.

" + } + }, + "fingerprintSHA1": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The SHA-1 fingerprint of the returned SSH host key or RDP certificate.

\n " + } + }, + "fingerprintSHA256": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The SHA-256 fingerprint of the returned SSH host key or RDP certificate.

\n " + } + }, + "notValidBefore": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The returned RDP certificate is valid after this point in time.

\n

This value is listed only for RDP certificates.

" + } + }, + "notValidAfter": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The returned RDP certificate is not valid after this point in time.

\n

This value is listed only for RDP certificates.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the public SSH host keys or the RDP certificate.

" + } + }, + "com.amazonaws.lightsail#HostKeysList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#HostKeyAttributes" + } + }, + "com.amazonaws.lightsail#HttpEndpoint": { + "type": "enum", + "members": { + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + } + } + }, + "com.amazonaws.lightsail#HttpProtocolIpv6": { + "type": "enum", + "members": { + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + } + } + }, + "com.amazonaws.lightsail#HttpTokens": { + "type": "enum", + "members": { + "optional": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "optional" + } + }, + "required": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + } + } + }, + "com.amazonaws.lightsail#IAMAccessKeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 20 + }, + "smithy.api#pattern": "^[A-Z0-9]{20}$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.lightsail#ImportKeyPair": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#ImportKeyPairRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#ImportKeyPairResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Imports a public SSH key from a specific key pair.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/ImportKeyPair", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#ImportKeyPairRequest": { + "type": "structure", + "members": { + "keyPairName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the key pair for which you want to import the public key.

", + "smithy.api#required": {} + } + }, + "publicKeyBase64": { + "target": "com.amazonaws.lightsail#Base64", + "traits": { + "smithy.api#documentation": "

A base64-encoded public key of the ssh-rsa type.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#ImportKeyPairResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#InUseResourceCount": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.lightsail#IncludeCertificateDetails": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.lightsail#InputOrigin": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the origin resource.

" + } + }, + "regionName": { + "target": "com.amazonaws.lightsail#RegionName", + "traits": { + "smithy.api#documentation": "

The AWS Region name of the origin resource.

" + } + }, + "protocolPolicy": { + "target": "com.amazonaws.lightsail#OriginProtocolPolicyEnum", + "traits": { + "smithy.api#documentation": "

The protocol that your Amazon Lightsail distribution uses when establishing a connection\n with your origin to pull content.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the origin resource of an Amazon Lightsail content delivery network (CDN)\n distribution.

\n

An origin can be a Lightsail instance, bucket, or load balancer. A distribution pulls\n content from an origin, caches it, and serves it to viewers via a worldwide network of edge\n servers.

" + } + }, + "com.amazonaws.lightsail#Instance": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1).

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance (e.g.,\n arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the instance was created (e.g., 1479734909.17) in Unix\n time format.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

The region name and Availability Zone where the instance is located.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of resource (usually Instance).

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + }, + "blueprintId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The blueprint ID (e.g., os_amlinux_2016_03).

" + } + }, + "blueprintName": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The friendly name of the blueprint (e.g., Amazon Linux).

" + } + }, + "bundleId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The bundle for the instance (e.g., micro_1_0).

" + } + }, + "addOns": { + "target": "com.amazonaws.lightsail#AddOnList", + "traits": { + "smithy.api#documentation": "

An array of objects representing the add-ons enabled on the instance.

" + } + }, + "isStaticIp": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether this instance has a static IP assigned to it.

" + } + }, + "privateIpAddress": { + "target": "com.amazonaws.lightsail#IpAddress", + "traits": { + "smithy.api#documentation": "

The private IP address of the instance.

" + } + }, + "publicIpAddress": { + "target": "com.amazonaws.lightsail#IpAddress", + "traits": { + "smithy.api#documentation": "

The public IP address of the instance.

" + } + }, + "ipv6Addresses": { + "target": "com.amazonaws.lightsail#Ipv6AddressList", + "traits": { + "smithy.api#documentation": "

The IPv6 addresses of the instance.

" + } + }, + "ipAddressType": { + "target": "com.amazonaws.lightsail#IpAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type of the instance.

\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

" + } + }, + "hardware": { + "target": "com.amazonaws.lightsail#InstanceHardware", + "traits": { + "smithy.api#documentation": "

The size of the vCPU and the amount of RAM for the instance.

" + } + }, + "networking": { + "target": "com.amazonaws.lightsail#InstanceNetworking", + "traits": { + "smithy.api#documentation": "

Information about the public ports and monthly data transfer rates for the\n instance.

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#InstanceState", + "traits": { + "smithy.api#documentation": "

The status code and the state (e.g., running) for the instance.

" + } + }, + "username": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The user name for connecting to the instance (e.g., ec2-user).

" + } + }, + "sshKeyName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the SSH key being used to connect to the instance (e.g.,\n LightsailDefaultKeyPair).

" + } + }, + "metadataOptions": { + "target": "com.amazonaws.lightsail#InstanceMetadataOptions", + "traits": { + "smithy.api#documentation": "

The metadata options for the Amazon Lightsail instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an instance (a virtual private server).

" + } + }, + "com.amazonaws.lightsail#InstanceAccessDetails": { + "type": "structure", + "members": { + "certKey": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

For SSH access, the public key to use when accessing your instance For OpenSSH clients\n (e.g., command line SSH), you should save this value to tempkey-cert.pub.

" + } + }, + "expiresAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

For SSH access, the date on which the temporary keys expire.

" + } + }, + "ipAddress": { + "target": "com.amazonaws.lightsail#IpAddress", + "traits": { + "smithy.api#documentation": "

The public IP address of the Amazon Lightsail instance.

" + } + }, + "password": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

For RDP access, the password for your Amazon Lightsail instance. Password will be an empty\n string if the password for your new instance is not ready yet. When you create an instance, it\n can take up to 15 minutes for the instance to be ready.

\n \n

If you create an instance using any key pair other than the default\n (LightsailDefaultKeyPair), password will always be an empty\n string.

\n

If you change the Administrator password on the instance, Lightsail will continue to\n return the original password value. When accessing the instance using RDP, you need to\n manually enter the Administrator password after changing it from the default.

\n " + } + }, + "passwordData": { + "target": "com.amazonaws.lightsail#PasswordData", + "traits": { + "smithy.api#documentation": "

For a Windows Server-based instance, an object with the data you can use to retrieve your\n password. This is only needed if password is empty and the instance is not new\n (and therefore the password is not ready yet). When you create an instance, it can take up to\n 15 minutes for the instance to be ready.

" + } + }, + "privateKey": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH),\n you should save this value to tempkey).

" + } + }, + "protocol": { + "target": "com.amazonaws.lightsail#InstanceAccessProtocol", + "traits": { + "smithy.api#documentation": "

The protocol for these Amazon Lightsail instance access details.

" + } + }, + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of this Amazon Lightsail instance.

" + } + }, + "username": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The user name to use when logging in to the Amazon Lightsail instance.

" + } + }, + "hostKeys": { + "target": "com.amazonaws.lightsail#HostKeysList", + "traits": { + "smithy.api#documentation": "

Describes the public SSH host keys or the RDP certificate.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for gaining temporary access to one of your Amazon Lightsail\n instances.

" + } + }, + "com.amazonaws.lightsail#InstanceAccessProtocol": { + "type": "enum", + "members": { + "ssh": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ssh" + } + }, + "rdp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rdp" + } + } + } + }, + "com.amazonaws.lightsail#InstanceEntry": { + "type": "structure", + "members": { + "sourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the export snapshot record, which contains the exported Lightsail instance\n snapshot that will be used as the source of the new Amazon EC2 instance.

\n

Use the get export snapshot records operation to get a list of export\n snapshot records that you can use to create a CloudFormation stack.

", + "smithy.api#required": {} + } + }, + "instanceType": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The instance type (e.g., t2.micro) to use for the new Amazon EC2 instance.

", + "smithy.api#required": {} + } + }, + "portInfoSource": { + "target": "com.amazonaws.lightsail#PortInfoSourceType", + "traits": { + "smithy.api#documentation": "

The port configuration to use for the new Amazon EC2 instance.

\n

The following configuration options are available:

\n \n \n

If you configured lightsail-connect as a cidrListAliases on\n your instance, or if you chose to allow the Lightsail browser-based SSH or RDP clients to\n connect to your instance, that configuration is not carried over to your new Amazon EC2\n instance.

\n ", + "smithy.api#required": {} + } + }, + "userData": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

A launch script you can create that configures a server with additional user data. For\n example, you might want to run apt-get -y update.

\n \n

Depending on the machine image you choose, the command to get software on your instance\n varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use\n apt-get, and FreeBSD uses pkg.

\n " + } + }, + "availabilityZone": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The Availability Zone for the new Amazon EC2 instance.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Amazon Elastic Compute Cloud instance and related resources to be created using the\n create cloud formation stack operation.

" + } + }, + "com.amazonaws.lightsail#InstanceEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#InstanceEntry" + } + }, + "com.amazonaws.lightsail#InstanceHardware": { + "type": "structure", + "members": { + "cpuCount": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The number of vCPUs the instance has.

" + } + }, + "disks": { + "target": "com.amazonaws.lightsail#DiskList", + "traits": { + "smithy.api#documentation": "

The disks attached to the instance.

" + } + }, + "ramSizeInGb": { + "target": "com.amazonaws.lightsail#float", + "traits": { + "smithy.api#documentation": "

The amount of RAM in GB on the instance (e.g., 1.0).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the hardware for the instance.

" + } + }, + "com.amazonaws.lightsail#InstanceHealthReason": { + "type": "enum", + "members": { + "LbRegistrationInProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Lb.RegistrationInProgress" + } + }, + "LbInitialHealthChecking": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Lb.InitialHealthChecking" + } + }, + "LbInternalError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Lb.InternalError" + } + }, + "InstanceResponseCodeMismatch": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance.ResponseCodeMismatch" + } + }, + "InstanceTimeout": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance.Timeout" + } + }, + "InstanceFailedHealthChecks": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance.FailedHealthChecks" + } + }, + "InstanceNotRegistered": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance.NotRegistered" + } + }, + "InstanceNotInUse": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance.NotInUse" + } + }, + "InstanceDeregistrationInProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance.DeregistrationInProgress" + } + }, + "InstanceInvalidState": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance.InvalidState" + } + }, + "InstanceIpUnusable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance.IpUnusable" + } + } + } + }, + "com.amazonaws.lightsail#InstanceHealthState": { + "type": "enum", + "members": { + "Initial": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "initial" + } + }, + "Healthy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "healthy" + } + }, + "Unhealthy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unhealthy" + } + }, + "Unused": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unused" + } + }, + "Draining": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "draining" + } + }, + "Unavailable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unavailable" + } + } + } + }, + "com.amazonaws.lightsail#InstanceHealthSummary": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Lightsail instance for which you are requesting health check\n data.

" + } + }, + "instanceHealth": { + "target": "com.amazonaws.lightsail#InstanceHealthState", + "traits": { + "smithy.api#documentation": "

Describes the overall instance health. Valid values are below.

" + } + }, + "instanceHealthReason": { + "target": "com.amazonaws.lightsail#InstanceHealthReason", + "traits": { + "smithy.api#documentation": "

More information about the instance health. If the instanceHealth is\n healthy, then an instanceHealthReason value is not\n provided.

\n

If \n instanceHealth\n is initial,\n the \n instanceHealthReason\n value can be one of the\n following:

\n \n

If \n instanceHealth\n is unhealthy,\n the \n instanceHealthReason\n value can be one of the\n following:

\n \n

If \n instanceHealth\n is unused,\n the \n instanceHealthReason\n value can be one of the\n following:

\n \n

If \n instanceHealth\n is draining,\n the \n instanceHealthReason\n value can be one of the\n following:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes information about the health of the instance.

" + } + }, + "com.amazonaws.lightsail#InstanceHealthSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#InstanceHealthSummary" + } + }, + "com.amazonaws.lightsail#InstanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Instance" + } + }, + "com.amazonaws.lightsail#InstanceMetadataOptions": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.lightsail#InstanceMetadataState", + "traits": { + "smithy.api#documentation": "

The state of the metadata option changes.

\n

The following states are possible:

\n " + } + }, + "httpTokens": { + "target": "com.amazonaws.lightsail#HttpTokens", + "traits": { + "smithy.api#documentation": "

The state of token usage for your instance metadata requests.

\n

If the state is optional, you can choose whether to retrieve instance\n metadata with a signed token header on your request. If you retrieve the IAM role credentials\n without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role\n credentials by using a valid signed token, the version 2.0 role credentials are\n returned.

\n

If the state is required, you must send a signed token header with all\n instance metadata retrieval requests. In this state, retrieving the IAM role credential always\n returns the version 2.0 credentials. The version 1.0 credentials are not available.

\n \n

Not all instance blueprints in Lightsail support version 2.0 credentials.\n Use the MetadataNoToken instance metric to track the number of calls to the\n instance metadata service that are using version 1.0 credentials. For more information, see\n Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.

\n " + } + }, + "httpEndpoint": { + "target": "com.amazonaws.lightsail#HttpEndpoint", + "traits": { + "smithy.api#documentation": "

Indicates whether the HTTP metadata endpoint on your instances is enabled or\n disabled.

\n

If the value is disabled, you cannot access your instance metadata.

" + } + }, + "httpPutResponseHopLimit": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. A larger number\n means that the instance metadata requests can travel farther.

" + } + }, + "httpProtocolIpv6": { + "target": "com.amazonaws.lightsail#HttpProtocolIpv6", + "traits": { + "smithy.api#documentation": "

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or\n disabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metadata options for the instance.

" + } + }, + "com.amazonaws.lightsail#InstanceMetadataState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "applied": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "applied" + } + } + } + }, + "com.amazonaws.lightsail#InstanceMetricName": { + "type": "enum", + "members": { + "CPUUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CPUUtilization" + } + }, + "NetworkIn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetworkIn" + } + }, + "NetworkOut": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetworkOut" + } + }, + "StatusCheckFailed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StatusCheckFailed" + } + }, + "StatusCheckFailed_Instance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StatusCheckFailed_Instance" + } + }, + "StatusCheckFailed_System": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StatusCheckFailed_System" + } + }, + "BurstCapacityTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BurstCapacityTime" + } + }, + "BurstCapacityPercentage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BurstCapacityPercentage" + } + }, + "MetadataNoToken": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MetadataNoToken" + } + } + } + }, + "com.amazonaws.lightsail#InstanceNetworking": { + "type": "structure", + "members": { + "monthlyTransfer": { + "target": "com.amazonaws.lightsail#MonthlyTransfer", + "traits": { + "smithy.api#documentation": "

The amount of data in GB allocated for monthly data transfers.

" + } + }, + "ports": { + "target": "com.amazonaws.lightsail#InstancePortInfoList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs containing information about the ports on the instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes monthly data transfer rates and port information for an instance.

" + } + }, + "com.amazonaws.lightsail#InstancePlatform": { + "type": "enum", + "members": { + "LinuxUnix": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINUX_UNIX" + } + }, + "Windows": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS" + } + } + } + }, + "com.amazonaws.lightsail#InstancePlatformList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#InstancePlatform" + } + }, + "com.amazonaws.lightsail#InstancePortInfo": { + "type": "structure", + "members": { + "fromPort": { + "target": "com.amazonaws.lightsail#Port", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The first port in a range of open ports on an instance.

\n

Allowed ports:

\n " + } + }, + "toPort": { + "target": "com.amazonaws.lightsail#Port", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The last port in a range of open ports on an instance.

\n

Allowed ports:

\n " + } + }, + "protocol": { + "target": "com.amazonaws.lightsail#NetworkProtocol", + "traits": { + "smithy.api#documentation": "

The IP protocol name.

\n

The name can be one of the following:

\n " + } + }, + "accessFrom": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The location from which access is allowed. For example, Anywhere (0.0.0.0/0),\n or Custom if a specific IP address or range of IP addresses is allowed.

" + } + }, + "accessType": { + "target": "com.amazonaws.lightsail#PortAccessType", + "traits": { + "smithy.api#documentation": "

The type of access (Public or Private).

" + } + }, + "commonName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The common name of the port information.

" + } + }, + "accessDirection": { + "target": "com.amazonaws.lightsail#AccessDirection", + "traits": { + "smithy.api#documentation": "

The access direction (inbound or outbound).

\n \n

Lightsail currently supports only inbound access direction.

\n " + } + }, + "cidrs": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol.

\n \n

The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to\n connect to an instance.

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" + } + }, + "ipv6Cidrs": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol. Only devices with an IPv6 address\n can connect to an instance through IPv6; otherwise, IPv4 should be used.

\n \n

The cidrs parameter lists the IPv4 addresses that are allowed to connect to\n an instance.

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" + } + }, + "cidrListAliases": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

An alias that defines access for a preconfigured range of IP addresses.

\n

The only alias currently supported is lightsail-connect, which allows IP\n addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your\n instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes information about ports for an Amazon Lightsail instance.

" + } + }, + "com.amazonaws.lightsail#InstancePortInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#InstancePortInfo" + } + }, + "com.amazonaws.lightsail#InstancePortState": { + "type": "structure", + "members": { + "fromPort": { + "target": "com.amazonaws.lightsail#Port", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The first port in a range of open ports on an instance.

\n

Allowed ports:

\n " + } + }, + "toPort": { + "target": "com.amazonaws.lightsail#Port", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The last port in a range of open ports on an instance.

\n

Allowed ports:

\n " + } + }, + "protocol": { + "target": "com.amazonaws.lightsail#NetworkProtocol", + "traits": { + "smithy.api#documentation": "

The IP protocol name.

\n

The name can be one of the following:

\n " + } + }, + "state": { + "target": "com.amazonaws.lightsail#PortState", + "traits": { + "smithy.api#documentation": "

Specifies whether the instance port is open or closed.

\n \n

The port state for Lightsail instances is always open.

\n " + } + }, + "cidrs": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol.

\n \n

The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to\n connect to an instance.

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" + } + }, + "ipv6Cidrs": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol. Only devices with an IPv6 address\n can connect to an instance through IPv6; otherwise, IPv4 should be used.

\n \n

The cidrs parameter lists the IPv4 addresses that are allowed to connect to\n an instance.

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" + } + }, + "cidrListAliases": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

An alias that defines access for a preconfigured range of IP addresses.

\n

The only alias currently supported is lightsail-connect, which allows IP\n addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your\n instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes open ports on an instance, the IP addresses allowed to connect to the instance\n through the ports, and the protocol.

" + } + }, + "com.amazonaws.lightsail#InstancePortStateList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#InstancePortState" + } + }, + "com.amazonaws.lightsail#InstanceSnapshot": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the snapshot.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot (e.g.,\n arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the snapshot was created (e.g., 1479907467.024).

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

The region name and Availability Zone where you created the snapshot.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of resource (usually InstanceSnapshot).

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#InstanceSnapshotState", + "traits": { + "smithy.api#documentation": "

The state the snapshot is in.

" + } + }, + "progress": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The progress of the snapshot.

\n \n

This is populated only for disk snapshots, and is null for instance\n snapshots.

\n " + } + }, + "fromAttachedDisks": { + "target": "com.amazonaws.lightsail#DiskList", + "traits": { + "smithy.api#documentation": "

An array of disk objects containing information about all block storage disks.

" + } + }, + "fromInstanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The instance from which the snapshot was created.

" + } + }, + "fromInstanceArn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g.,\n arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).

" + } + }, + "fromBlueprintId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The blueprint ID from which you created the snapshot (e.g., os_debian_8_3). A\n blueprint is a virtual private server (or instance) image used to create\n instances quickly.

" + } + }, + "fromBundleId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The bundle ID from which you created the snapshot (e.g., micro_1_0).

" + } + }, + "isFromAutoSnapshot": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the snapshot was created from an automatic\n snapshot.

" + } + }, + "sizeInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The size in GB of the SSD.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an instance snapshot.

" + } + }, + "com.amazonaws.lightsail#InstanceSnapshotInfo": { + "type": "structure", + "members": { + "fromBundleId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The bundle ID from which the source instance was created (e.g.,\n micro_1_0).

" + } + }, + "fromBlueprintId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The blueprint ID from which the source instance (e.g., os_debian_8_3).

" + } + }, + "fromDiskInfo": { + "target": "com.amazonaws.lightsail#DiskInfoList", + "traits": { + "smithy.api#documentation": "

A list of objects describing the disks that were attached to the source instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an instance snapshot.

" + } + }, + "com.amazonaws.lightsail#InstanceSnapshotList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#InstanceSnapshot" + } + }, + "com.amazonaws.lightsail#InstanceSnapshotState": { + "type": "enum", + "members": { + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "Error": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + }, + "Available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + } + } + }, + "com.amazonaws.lightsail#InstanceState": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The status code for the instance.

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The state of the instance (e.g., running or pending).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the virtual private server (or instance) status.

" + } + }, + "com.amazonaws.lightsail#InvalidInputException": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#string" + }, + "docs": { + "target": "com.amazonaws.lightsail#string" + }, + "message": { + "target": "com.amazonaws.lightsail#string" + }, + "tip": { + "target": "com.amazonaws.lightsail#string" + } + }, + "traits": { + "smithy.api#documentation": "

Lightsail throws this exception when user input does not conform to the validation rules\n of an input field.

\n \n

Domain and distribution APIs are only available in the N. Virginia\n (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services\n Region configuration to us-east-1 to create, view, or edit these\n resources.

\n ", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.lightsail#IpAddress": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}$" + } + }, + "com.amazonaws.lightsail#IpAddressType": { + "type": "enum", + "members": { + "DUALSTACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dualstack" + } + }, + "IPV4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv4" + } + } + } + }, + "com.amazonaws.lightsail#Ipv6Address": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([A-F0-9]{1,4}:){7}[A-F0-9]{1,4}$" + } + }, + "com.amazonaws.lightsail#Ipv6AddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Ipv6Address" + } + }, + "com.amazonaws.lightsail#IsVpcPeered": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#IsVpcPeeredRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#IsVpcPeeredResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a Boolean value indicating whether your Lightsail VPC is peered.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/IsVpcPeered", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#IsVpcPeeredRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.lightsail#IsVpcPeeredResult": { + "type": "structure", + "members": { + "isPeered": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Returns true if the Lightsail VPC is peered; otherwise,\n false.

" + } + } + } + }, + "com.amazonaws.lightsail#IsoDate": { + "type": "timestamp" + }, + "com.amazonaws.lightsail#IssuerCA": { + "type": "string" + }, + "com.amazonaws.lightsail#KeyAlgorithm": { + "type": "string" + }, + "com.amazonaws.lightsail#KeyPair": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The friendly name of the SSH key pair.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the key pair (e.g.,\n arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the key pair was created (e.g., 1479816991.349).

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

The region name and Availability Zone where the key pair was created.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type (usually KeyPair).

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + }, + "fingerprint": { + "target": "com.amazonaws.lightsail#Base64", + "traits": { + "smithy.api#documentation": "

The RSA fingerprint of the key pair.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an SSH key pair.

" + } + }, + "com.amazonaws.lightsail#KeyPairList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#KeyPair" + } + }, + "com.amazonaws.lightsail#LightsailDistribution": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the distribution.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution.

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail distribution. This code enables our support team to look up your Lightsail\n information more easily.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the distribution was created.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

An object that describes the location of the distribution, such as the Amazon Web Services\n Region and Availability Zone.

\n \n

Lightsail distributions are global resources that can reference an origin in any\n Amazon Web Services Region, and distribute its content globally. However, all distributions\n are located in the us-east-1 Region.

\n " + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type (e.g., Distribution).

" + } + }, + "alternativeDomainNames": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The alternate domain names of the distribution.

" + } + }, + "status": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The status of the distribution.

" + } + }, + "isEnabled": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the distribution is enabled.

" + } + }, + "domainName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The domain name of the distribution.

" + } + }, + "bundleId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The ID of the bundle currently applied to the distribution.

" + } + }, + "certificateName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the SSL/TLS certificate attached to the distribution, if any.

" + } + }, + "origin": { + "target": "com.amazonaws.lightsail#Origin", + "traits": { + "smithy.api#documentation": "

An object that describes the origin resource of the distribution, such as a Lightsail\n instance, bucket, or load balancer.

\n

The distribution pulls, caches, and serves content from the origin.

" + } + }, + "originPublicDNS": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The public DNS of the origin.

" + } + }, + "defaultCacheBehavior": { + "target": "com.amazonaws.lightsail#CacheBehavior", + "traits": { + "smithy.api#documentation": "

An object that describes the default cache behavior of the distribution.

" + } + }, + "cacheBehaviorSettings": { + "target": "com.amazonaws.lightsail#CacheSettings", + "traits": { + "smithy.api#documentation": "

An object that describes the cache behavior settings of the distribution.

" + } + }, + "cacheBehaviors": { + "target": "com.amazonaws.lightsail#CacheBehaviorList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the per-path cache behavior of the distribution.

" + } + }, + "ableToUpdateBundle": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the bundle that is currently applied to your distribution, specified\n using the distributionName parameter, can be changed to another bundle.

\n

Use the UpdateDistributionBundle action to change your distribution's\n bundle.

" + } + }, + "ipAddressType": { + "target": "com.amazonaws.lightsail#IpAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type of the distribution.

\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Amazon Lightsail content delivery network (CDN) distribution.

" + } + }, + "com.amazonaws.lightsail#Lightsail_20161128": { + "type": "service", + "version": "2016-11-28", + "operations": [ + { + "target": "com.amazonaws.lightsail#AllocateStaticIp" + }, + { + "target": "com.amazonaws.lightsail#AttachCertificateToDistribution" + }, + { + "target": "com.amazonaws.lightsail#AttachDisk" + }, + { + "target": "com.amazonaws.lightsail#AttachInstancesToLoadBalancer" + }, + { + "target": "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificate" + }, + { + "target": "com.amazonaws.lightsail#AttachStaticIp" + }, + { + "target": "com.amazonaws.lightsail#CloseInstancePublicPorts" + }, + { + "target": "com.amazonaws.lightsail#CopySnapshot" + }, + { + "target": "com.amazonaws.lightsail#CreateBucket" + }, + { + "target": "com.amazonaws.lightsail#CreateBucketAccessKey" + }, + { + "target": "com.amazonaws.lightsail#CreateCertificate" + }, + { + "target": "com.amazonaws.lightsail#CreateCloudFormationStack" + }, + { + "target": "com.amazonaws.lightsail#CreateContactMethod" + }, + { + "target": "com.amazonaws.lightsail#CreateContainerService" + }, + { + "target": "com.amazonaws.lightsail#CreateContainerServiceDeployment" + }, + { + "target": "com.amazonaws.lightsail#CreateContainerServiceRegistryLogin" + }, + { + "target": "com.amazonaws.lightsail#CreateDisk" + }, + { + "target": "com.amazonaws.lightsail#CreateDiskFromSnapshot" + }, + { + "target": "com.amazonaws.lightsail#CreateDiskSnapshot" + }, + { + "target": "com.amazonaws.lightsail#CreateDistribution" + }, + { + "target": "com.amazonaws.lightsail#CreateDomain" + }, + { + "target": "com.amazonaws.lightsail#CreateDomainEntry" + }, + { + "target": "com.amazonaws.lightsail#CreateInstances" + }, + { + "target": "com.amazonaws.lightsail#CreateInstancesFromSnapshot" + }, + { + "target": "com.amazonaws.lightsail#CreateInstanceSnapshot" + }, + { + "target": "com.amazonaws.lightsail#CreateKeyPair" + }, + { + "target": "com.amazonaws.lightsail#CreateLoadBalancer" + }, + { + "target": "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificate" + }, + { + "target": "com.amazonaws.lightsail#CreateRelationalDatabase" + }, + { + "target": "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshot" + }, + { + "target": "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshot" + }, + { + "target": "com.amazonaws.lightsail#DeleteAlarm" + }, + { + "target": "com.amazonaws.lightsail#DeleteAutoSnapshot" + }, + { + "target": "com.amazonaws.lightsail#DeleteBucket" + }, + { + "target": "com.amazonaws.lightsail#DeleteBucketAccessKey" + }, + { + "target": "com.amazonaws.lightsail#DeleteCertificate" + }, + { + "target": "com.amazonaws.lightsail#DeleteContactMethod" + }, + { + "target": "com.amazonaws.lightsail#DeleteContainerImage" + }, + { + "target": "com.amazonaws.lightsail#DeleteContainerService" + }, + { + "target": "com.amazonaws.lightsail#DeleteDisk" + }, + { + "target": "com.amazonaws.lightsail#DeleteDiskSnapshot" + }, + { + "target": "com.amazonaws.lightsail#DeleteDistribution" + }, + { + "target": "com.amazonaws.lightsail#DeleteDomain" + }, + { + "target": "com.amazonaws.lightsail#DeleteDomainEntry" + }, + { + "target": "com.amazonaws.lightsail#DeleteInstance" + }, + { + "target": "com.amazonaws.lightsail#DeleteInstanceSnapshot" + }, + { + "target": "com.amazonaws.lightsail#DeleteKeyPair" + }, + { + "target": "com.amazonaws.lightsail#DeleteKnownHostKeys" + }, + { + "target": "com.amazonaws.lightsail#DeleteLoadBalancer" + }, + { + "target": "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificate" + }, + { + "target": "com.amazonaws.lightsail#DeleteRelationalDatabase" + }, + { + "target": "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshot" + }, + { + "target": "com.amazonaws.lightsail#DetachCertificateFromDistribution" + }, + { + "target": "com.amazonaws.lightsail#DetachDisk" + }, + { + "target": "com.amazonaws.lightsail#DetachInstancesFromLoadBalancer" + }, + { + "target": "com.amazonaws.lightsail#DetachStaticIp" + }, + { + "target": "com.amazonaws.lightsail#DisableAddOn" + }, + { + "target": "com.amazonaws.lightsail#DownloadDefaultKeyPair" + }, + { + "target": "com.amazonaws.lightsail#EnableAddOn" + }, + { + "target": "com.amazonaws.lightsail#ExportSnapshot" + }, + { + "target": "com.amazonaws.lightsail#GetActiveNames" + }, + { + "target": "com.amazonaws.lightsail#GetAlarms" + }, + { + "target": "com.amazonaws.lightsail#GetAutoSnapshots" + }, + { + "target": "com.amazonaws.lightsail#GetBlueprints" + }, + { + "target": "com.amazonaws.lightsail#GetBucketAccessKeys" + }, + { + "target": "com.amazonaws.lightsail#GetBucketBundles" + }, + { + "target": "com.amazonaws.lightsail#GetBucketMetricData" + }, + { + "target": "com.amazonaws.lightsail#GetBuckets" + }, + { + "target": "com.amazonaws.lightsail#GetBundles" + }, + { + "target": "com.amazonaws.lightsail#GetCertificates" + }, + { + "target": "com.amazonaws.lightsail#GetCloudFormationStackRecords" + }, + { + "target": "com.amazonaws.lightsail#GetContactMethods" + }, + { + "target": "com.amazonaws.lightsail#GetContainerAPIMetadata" + }, + { + "target": "com.amazonaws.lightsail#GetContainerImages" + }, + { + "target": "com.amazonaws.lightsail#GetContainerLog" + }, + { + "target": "com.amazonaws.lightsail#GetContainerServiceDeployments" + }, + { + "target": "com.amazonaws.lightsail#GetContainerServiceMetricData" + }, + { + "target": "com.amazonaws.lightsail#GetContainerServicePowers" + }, + { + "target": "com.amazonaws.lightsail#GetContainerServices" + }, + { + "target": "com.amazonaws.lightsail#GetDisk" + }, + { + "target": "com.amazonaws.lightsail#GetDisks" + }, + { + "target": "com.amazonaws.lightsail#GetDiskSnapshot" + }, + { + "target": "com.amazonaws.lightsail#GetDiskSnapshots" + }, + { + "target": "com.amazonaws.lightsail#GetDistributionBundles" + }, + { + "target": "com.amazonaws.lightsail#GetDistributionLatestCacheReset" + }, + { + "target": "com.amazonaws.lightsail#GetDistributionMetricData" + }, + { + "target": "com.amazonaws.lightsail#GetDistributions" + }, + { + "target": "com.amazonaws.lightsail#GetDomain" + }, + { + "target": "com.amazonaws.lightsail#GetDomains" + }, + { + "target": "com.amazonaws.lightsail#GetExportSnapshotRecords" + }, + { + "target": "com.amazonaws.lightsail#GetInstance" + }, + { + "target": "com.amazonaws.lightsail#GetInstanceAccessDetails" + }, + { + "target": "com.amazonaws.lightsail#GetInstanceMetricData" + }, + { + "target": "com.amazonaws.lightsail#GetInstancePortStates" + }, + { + "target": "com.amazonaws.lightsail#GetInstances" + }, + { + "target": "com.amazonaws.lightsail#GetInstanceSnapshot" + }, + { + "target": "com.amazonaws.lightsail#GetInstanceSnapshots" + }, + { + "target": "com.amazonaws.lightsail#GetInstanceState" + }, + { + "target": "com.amazonaws.lightsail#GetKeyPair" + }, + { + "target": "com.amazonaws.lightsail#GetKeyPairs" + }, + { + "target": "com.amazonaws.lightsail#GetLoadBalancer" + }, + { + "target": "com.amazonaws.lightsail#GetLoadBalancerMetricData" + }, + { + "target": "com.amazonaws.lightsail#GetLoadBalancers" + }, + { + "target": "com.amazonaws.lightsail#GetLoadBalancerTlsCertificates" + }, + { + "target": "com.amazonaws.lightsail#GetLoadBalancerTlsPolicies" + }, + { + "target": "com.amazonaws.lightsail#GetOperation" + }, + { + "target": "com.amazonaws.lightsail#GetOperations" + }, + { + "target": "com.amazonaws.lightsail#GetOperationsForResource" + }, + { + "target": "com.amazonaws.lightsail#GetRegions" + }, + { + "target": "com.amazonaws.lightsail#GetRelationalDatabase" + }, + { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseBlueprints" + }, + { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseBundles" + }, + { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseEvents" + }, + { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogEvents" + }, + { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogStreams" + }, + { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPassword" + }, + { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseMetricData" + }, + { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseParameters" + }, + { + "target": "com.amazonaws.lightsail#GetRelationalDatabases" + }, + { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshot" + }, + { + "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshots" + }, + { + "target": "com.amazonaws.lightsail#GetStaticIp" + }, + { + "target": "com.amazonaws.lightsail#GetStaticIps" + }, + { + "target": "com.amazonaws.lightsail#ImportKeyPair" + }, + { + "target": "com.amazonaws.lightsail#IsVpcPeered" + }, + { + "target": "com.amazonaws.lightsail#OpenInstancePublicPorts" + }, + { + "target": "com.amazonaws.lightsail#PeerVpc" + }, + { + "target": "com.amazonaws.lightsail#PutAlarm" + }, + { + "target": "com.amazonaws.lightsail#PutInstancePublicPorts" + }, + { + "target": "com.amazonaws.lightsail#RebootInstance" + }, + { + "target": "com.amazonaws.lightsail#RebootRelationalDatabase" + }, + { + "target": "com.amazonaws.lightsail#RegisterContainerImage" + }, + { + "target": "com.amazonaws.lightsail#ReleaseStaticIp" + }, + { + "target": "com.amazonaws.lightsail#ResetDistributionCache" + }, + { + "target": "com.amazonaws.lightsail#SendContactMethodVerification" + }, + { + "target": "com.amazonaws.lightsail#SetIpAddressType" + }, + { + "target": "com.amazonaws.lightsail#SetResourceAccessForBucket" + }, + { + "target": "com.amazonaws.lightsail#StartInstance" + }, + { + "target": "com.amazonaws.lightsail#StartRelationalDatabase" + }, + { + "target": "com.amazonaws.lightsail#StopInstance" + }, + { + "target": "com.amazonaws.lightsail#StopRelationalDatabase" + }, + { + "target": "com.amazonaws.lightsail#TagResource" + }, + { + "target": "com.amazonaws.lightsail#TestAlarm" + }, + { + "target": "com.amazonaws.lightsail#UnpeerVpc" + }, + { + "target": "com.amazonaws.lightsail#UntagResource" + }, + { + "target": "com.amazonaws.lightsail#UpdateBucket" + }, + { + "target": "com.amazonaws.lightsail#UpdateBucketBundle" + }, + { + "target": "com.amazonaws.lightsail#UpdateContainerService" + }, + { + "target": "com.amazonaws.lightsail#UpdateDistribution" + }, + { + "target": "com.amazonaws.lightsail#UpdateDistributionBundle" + }, + { + "target": "com.amazonaws.lightsail#UpdateDomainEntry" + }, + { + "target": "com.amazonaws.lightsail#UpdateInstanceMetadataOptions" + }, + { + "target": "com.amazonaws.lightsail#UpdateLoadBalancerAttribute" + }, + { + "target": "com.amazonaws.lightsail#UpdateRelationalDatabase" + }, + { + "target": "com.amazonaws.lightsail#UpdateRelationalDatabaseParameters" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Lightsail", + "arnNamespace": "lightsail", + "cloudFormationName": "Lightsail", + "cloudTrailEventSource": "lightsail.amazonaws.com", + "endpointPrefix": "lightsail" + }, + "aws.auth#sigv4": { + "name": "lightsail" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "

Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes\n everything you need to launch your project quickly - instances (virtual private servers),\n container services, storage buckets, managed databases, SSD-based block storage, static IP\n addresses, load balancers, content delivery network (CDN) distributions, DNS management of\n registered domains, and resource snapshots (backups) - for a low, predictable monthly\n price.

\n

You can manage your Lightsail resources using the Lightsail console, Lightsail API,\n Command Line Interface (CLI), or SDKs. For more information about Lightsail\n concepts and tasks, see the Amazon Lightsail Developer Guide.

\n

This API Reference provides detailed information about the actions, data types,\n parameters, and errors of the Lightsail service. For more information about the supported\n Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see\n Amazon Lightsail Endpoints\n and Quotas in the Amazon Web Services General Reference.

", + "smithy.api#title": "Amazon Lightsail", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": true, + "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": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "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" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://lightsail-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": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://lightsail-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://lightsail.{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://lightsail.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.ap-south-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail.ap-south-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-south-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-south-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.ca-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ca-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ca-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail.ca-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ca-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ca-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.eu-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail.eu-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.us-west-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail.us-west-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.eu-north-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail.eu-north-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.eu-west-3.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-3", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-3", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail.eu-west-3.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-3", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-3", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.eu-west-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail.eu-west-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.eu-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail.eu-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.ap-northeast-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail.ap-northeast-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail.ap-northeast-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail.ap-southeast-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail.ap-southeast-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.us-east-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-2", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lightsail.us-east-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lightsail.us-east-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-2", + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "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": { + "UseFIPS": true, + "Region": "us-east-1", + "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": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.lightsail#LoadBalancer": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the load balancer (e.g., my-load-balancer).

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail load balancer. This code enables our support team to look up your Lightsail\n information more easily.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The date when your load balancer was created.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

The AWS Region where your load balancer was created (e.g., us-east-2a).\n Lightsail automatically creates your load balancer across Availability Zones.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type (e.g., LoadBalancer.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + }, + "dnsName": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The DNS name of your Lightsail load balancer.

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#LoadBalancerState", + "traits": { + "smithy.api#documentation": "

The status of your load balancer. Valid values are below.

" + } + }, + "protocol": { + "target": "com.amazonaws.lightsail#LoadBalancerProtocol", + "traits": { + "smithy.api#documentation": "

The protocol you have enabled for your load balancer. Valid values are below.

\n

You can't just have HTTP_HTTPS, but you can have just\n HTTP.

" + } + }, + "publicPorts": { + "target": "com.amazonaws.lightsail#PortList", + "traits": { + "smithy.api#documentation": "

An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS,\n use port 443.

" + } + }, + "healthCheckPath": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The path you specified to perform your health checks. If no path is specified, the load\n balancer tries to make a request to the default (root) page.

" + } + }, + "instancePort": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The port where the load balancer will direct traffic to your Lightsail instances. For\n HTTP traffic, it's port 80. For HTTPS traffic, it's port 443.

" + } + }, + "instanceHealthSummary": { + "target": "com.amazonaws.lightsail#InstanceHealthSummaryList", + "traits": { + "smithy.api#documentation": "

An array of InstanceHealthSummary objects describing the health of the load\n balancer.

" + } + }, + "tlsCertificateSummaries": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateSummaryList", + "traits": { + "smithy.api#documentation": "

An array of LoadBalancerTlsCertificateSummary objects that provide additional information\n about the SSL/TLS certificates. For example, if true, the certificate is attached\n to the load balancer.

" + } + }, + "configurationOptions": { + "target": "com.amazonaws.lightsail#LoadBalancerConfigurationOptions", + "traits": { + "smithy.api#documentation": "

A string to string map of the configuration options for your load balancer. Valid values\n are listed below.

" + } + }, + "ipAddressType": { + "target": "com.amazonaws.lightsail#IpAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type of the load balancer.

\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

" + } + }, + "httpsRedirectionEnabled": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether HTTPS redirection is enabled for the load\n balancer.

" + } + }, + "tlsPolicyName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the TLS security policy for the load balancer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a load balancer.

" + } }, - "docs": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#LoadBalancerAttributeName": { + "type": "enum", + "members": { + "HealthCheckPath": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HealthCheckPath" + } + }, + "SessionStickinessEnabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SessionStickinessEnabled" + } + }, + "SessionStickiness_LB_CookieDurationSeconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SessionStickiness_LB_CookieDurationSeconds" + } + }, + "HttpsRedirectionEnabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HttpsRedirectionEnabled" + } + }, + "TlsPolicyName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TlsPolicyName" + } + } + } }, - "message": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#LoadBalancerConfigurationOptions": { + "type": "map", + "key": { + "target": "com.amazonaws.lightsail#LoadBalancerAttributeName" + }, + "value": { + "target": "com.amazonaws.lightsail#string" + } }, - "tip": { - "target": "com.amazonaws.lightsail#string" - } - }, - "traits": { - "smithy.api#documentation": "

Lightsail throws this exception when user input does not conform to the validation rules\n of an input field.

\n \n

Domain and distribution APIs are only available in the N. Virginia\n (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services\n Region configuration to us-east-1 to create, view, or edit these\n resources.

\n ", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.lightsail#IpAddress": { - "type": "string", - "traits": { - "smithy.api#pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}$" - } - }, - "com.amazonaws.lightsail#IpAddressType": { - "type": "enum", - "members": { - "DUALSTACK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "dualstack" - } - }, - "IPV4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ipv4" - } - } - } - }, - "com.amazonaws.lightsail#Ipv6Address": { - "type": "string", - "traits": { - "smithy.api#pattern": "^([A-F0-9]{1,4}:){7}[A-F0-9]{1,4}$" - } - }, - "com.amazonaws.lightsail#Ipv6AddressList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Ipv6Address" - } - }, - "com.amazonaws.lightsail#IsVpcPeered": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#IsVpcPeeredRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#IsVpcPeeredResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a Boolean value indicating whether your Lightsail VPC is peered.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/IsVpcPeered", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#IsVpcPeeredRequest": { - "type": "structure", - "members": {} - }, - "com.amazonaws.lightsail#IsVpcPeeredResult": { - "type": "structure", - "members": { - "isPeered": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Returns true if the Lightsail VPC is peered; otherwise,\n false.

" - } - } - } - }, - "com.amazonaws.lightsail#IsoDate": { - "type": "timestamp" - }, - "com.amazonaws.lightsail#IssuerCA": { - "type": "string" - }, - "com.amazonaws.lightsail#KeyAlgorithm": { - "type": "string" - }, - "com.amazonaws.lightsail#KeyPair": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The friendly name of the SSH key pair.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the key pair (e.g.,\n arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the key pair was created (e.g., 1479816991.349).

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

The region name and Availability Zone where the key pair was created.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The resource type (usually KeyPair).

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "fingerprint": { - "target": "com.amazonaws.lightsail#Base64", - "traits": { - "smithy.api#documentation": "

The RSA fingerprint of the key pair.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an SSH key pair.

" - } - }, - "com.amazonaws.lightsail#KeyPairList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#KeyPair" - } - }, - "com.amazonaws.lightsail#LightsailDistribution": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the distribution.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution.

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail distribution. This code enables our support team to look up your Lightsail\n information more easily.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the distribution was created.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

An object that describes the location of the distribution, such as the Amazon Web Services\n Region and Availability Zone.

\n \n

Lightsail distributions are global resources that can reference an origin in any\n Amazon Web Services Region, and distribute its content globally. However, all distributions\n are located in the us-east-1 Region.

\n " - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type (e.g., Distribution).

" - } - }, - "alternativeDomainNames": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The alternate domain names of the distribution.

" - } - }, - "status": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The status of the distribution.

" - } - }, - "isEnabled": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the distribution is enabled.

" - } - }, - "domainName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The domain name of the distribution.

" - } - }, - "bundleId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The ID of the bundle currently applied to the distribution.

" - } - }, - "certificateName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the SSL/TLS certificate attached to the distribution, if any.

" - } - }, - "origin": { - "target": "com.amazonaws.lightsail#Origin", - "traits": { - "smithy.api#documentation": "

An object that describes the origin resource of the distribution, such as a Lightsail\n instance, bucket, or load balancer.

\n

The distribution pulls, caches, and serves content from the origin.

" - } - }, - "originPublicDNS": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The public DNS of the origin.

" - } - }, - "defaultCacheBehavior": { - "target": "com.amazonaws.lightsail#CacheBehavior", - "traits": { - "smithy.api#documentation": "

An object that describes the default cache behavior of the distribution.

" - } - }, - "cacheBehaviorSettings": { - "target": "com.amazonaws.lightsail#CacheSettings", - "traits": { - "smithy.api#documentation": "

An object that describes the cache behavior settings of the distribution.

" - } - }, - "cacheBehaviors": { - "target": "com.amazonaws.lightsail#CacheBehaviorList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the per-path cache behavior of the distribution.

" - } - }, - "ableToUpdateBundle": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the bundle that is currently applied to your distribution, specified\n using the distributionName parameter, can be changed to another bundle.

\n

Use the UpdateDistributionBundle action to change your distribution's\n bundle.

" - } - }, - "ipAddressType": { - "target": "com.amazonaws.lightsail#IpAddressType", - "traits": { - "smithy.api#documentation": "

The IP address type of the distribution.

\n\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Amazon Lightsail content delivery network (CDN) distribution.

" - } - }, - "com.amazonaws.lightsail#Lightsail_20161128": { - "type": "service", - "version": "2016-11-28", - "operations": [ - { - "target": "com.amazonaws.lightsail#AllocateStaticIp" + "com.amazonaws.lightsail#LoadBalancerList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#LoadBalancer" + } + }, + "com.amazonaws.lightsail#LoadBalancerMetricName": { + "type": "enum", + "members": { + "ClientTLSNegotiationErrorCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ClientTLSNegotiationErrorCount" + } + }, + "HealthyHostCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HealthyHostCount" + } + }, + "UnhealthyHostCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnhealthyHostCount" + } + }, + "HTTPCode_LB_4XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_LB_4XX_Count" + } + }, + "HTTPCode_LB_5XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_LB_5XX_Count" + } + }, + "HTTPCode_Instance_2XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_Instance_2XX_Count" + } + }, + "HTTPCode_Instance_3XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_Instance_3XX_Count" + } + }, + "HTTPCode_Instance_4XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_Instance_4XX_Count" + } + }, + "HTTPCode_Instance_5XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_Instance_5XX_Count" + } + }, + "InstanceResponseTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceResponseTime" + } + }, + "RejectedConnectionCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RejectedConnectionCount" + } + }, + "RequestCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RequestCount" + } + } + } + }, + "com.amazonaws.lightsail#LoadBalancerProtocol": { + "type": "enum", + "members": { + "HTTP_HTTPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP_HTTPS" + } + }, + "HTTP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP" + } + } + } + }, + "com.amazonaws.lightsail#LoadBalancerState": { + "type": "enum", + "members": { + "Active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "Provisioning": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "provisioning" + } + }, + "ActiveImpaired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active_impaired" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "Unknown": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknown" + } + } + } + }, + "com.amazonaws.lightsail#LoadBalancerTlsCertificate": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the SSL/TLS certificate (e.g., my-certificate).

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SSL/TLS certificate.

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail load balancer or SSL/TLS certificate. This code enables our support team to\n look up your Lightsail information more easily.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The time when you created your SSL/TLS certificate.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region and Availability Zone where you created your\n certificate.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type (e.g., LoadBalancerTlsCertificate).

\n " + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + }, + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The load balancer name where your SSL/TLS certificate is attached.

" + } + }, + "isAttached": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

When true, the SSL/TLS certificate is attached to the Lightsail load\n balancer.

" + } + }, + "status": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateStatus", + "traits": { + "smithy.api#documentation": "

The validation status of the SSL/TLS certificate. Valid values are below.

" + } + }, + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name for your SSL/TLS certificate.

" + } + }, + "domainValidationRecords": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationRecordList", + "traits": { + "smithy.api#documentation": "

An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the\n records.

" + } + }, + "failureReason": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateFailureReason", + "traits": { + "smithy.api#documentation": "

The validation failure reason, if any, of the certificate.

\n

The following failure reasons are possible:

\n " + } + }, + "issuedAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The time when the SSL/TLS certificate was issued.

" + } + }, + "issuer": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The issuer of the certificate.

" + } + }, + "keyAlgorithm": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The algorithm used to generate the key pair (the public and private key).

" + } + }, + "notAfter": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the SSL/TLS certificate expires.

" + } + }, + "notBefore": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the SSL/TLS certificate is first valid.

" + } + }, + "renewalSummary": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateRenewalSummary", + "traits": { + "smithy.api#documentation": "

An object that describes the status of the certificate renewal managed by\n Lightsail.

" + } + }, + "revocationReason": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateRevocationReason", + "traits": { + "smithy.api#documentation": "

The reason the certificate was revoked. This value is present only when the certificate\n status is REVOKED.

" + } + }, + "revokedAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the certificate was revoked. This value is present only when the\n certificate status is REVOKED.

" + } + }, + "serial": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The serial number of the certificate.

" + } + }, + "signatureAlgorithm": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The algorithm that was used to sign the certificate.

" + } + }, + "subject": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the entity that is associated with the public key contained in the\n certificate.

" + } + }, + "subjectAlternativeNames": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

An array of strings that specify the alternate domains (e.g., example2.com)\n and subdomains (e.g., blog.example.com) for the certificate.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a load balancer SSL/TLS certificate.

\n

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

" + } + }, + "com.amazonaws.lightsail#LoadBalancerTlsCertificateDnsRecordCreationState": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDnsRecordCreationStateCode", + "traits": { + "smithy.api#documentation": "

The status code for the automated DNS record creation.

\n

Following are the possible values:

\n " + } + }, + "message": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The message that describes the reason for the status code.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that describes the state of the canonical name (CNAME) records that are\n automatically added by Lightsail to the DNS of the domain to validate domain\n ownership.

" + } + }, + "com.amazonaws.lightsail#LoadBalancerTlsCertificateDnsRecordCreationStateCode": { + "type": "enum", + "members": { + "Succeeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "Started": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTED" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainStatus": { + "type": "enum", + "members": { + "PendingValidation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_VALIDATION" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "Success": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + } + } }, - { - "target": "com.amazonaws.lightsail#AttachCertificateToDistribution" + "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationOption": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The fully qualified domain name in the certificate request.

" + } + }, + "validationStatus": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainStatus", + "traits": { + "smithy.api#documentation": "

The status of the domain validation. Valid values are listed below.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the domain names on an SSL/TLS certificate that you will use to\n validate domain ownership.

" + } + }, + "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationOption" + } + }, + "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationRecord": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A fully qualified domain name in the certificate. For example,\n example.com.

" + } + }, + "type": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of validation record. For example, CNAME for domain\n validation.

" + } + }, + "value": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value for that type.

" + } + }, + "validationStatus": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainStatus", + "traits": { + "smithy.api#documentation": "

The validation status. Valid values are listed below.

" + } + }, + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The domain name against which your SSL/TLS certificate was validated.

" + } + }, + "dnsRecordCreationState": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDnsRecordCreationState", + "traits": { + "smithy.api#documentation": "

An object that describes the state of the canonical name (CNAME) records that are\n automatically added by Lightsail to the DNS of a domain to validate domain\n ownership.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the validation record of each domain name in the SSL/TLS certificate.

" + } + }, + "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationRecordList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationRecord" + } + }, + "com.amazonaws.lightsail#LoadBalancerTlsCertificateFailureReason": { + "type": "enum", + "members": { + "NoAvailableContacts": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_AVAILABLE_CONTACTS" + } + }, + "AdditionalVerificationRequired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADDITIONAL_VERIFICATION_REQUIRED" + } + }, + "DomainNotAllowed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_NOT_ALLOWED" + } + }, + "InvalidPublicDomain": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_PUBLIC_DOMAIN" + } + }, + "Other": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTHER" + } + } + } }, - { - "target": "com.amazonaws.lightsail#AttachDisk" + "com.amazonaws.lightsail#LoadBalancerTlsCertificateList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificate" + } }, - { - "target": "com.amazonaws.lightsail#AttachInstancesToLoadBalancer" + "com.amazonaws.lightsail#LoadBalancerTlsCertificateRenewalStatus": { + "type": "enum", + "members": { + "PendingAutoRenewal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_AUTO_RENEWAL" + } + }, + "PendingValidation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_VALIDATION" + } + }, + "Success": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } }, - { - "target": "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificate" + "com.amazonaws.lightsail#LoadBalancerTlsCertificateRenewalSummary": { + "type": "structure", + "members": { + "renewalStatus": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateRenewalStatus", + "traits": { + "smithy.api#documentation": "

The renewal status of the certificate.

\n

The following renewal status are possible:

\n " + } + }, + "domainValidationOptions": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationOptionList", + "traits": { + "smithy.api#documentation": "

Contains information about the validation of each domain name in the certificate, as it\n pertains to Lightsail's managed renewal. This is different from the initial validation that\n occurs as a result of the RequestCertificate request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the status of Lightsail's managed renewal for the\n certificate.

\n

The renewal status of the certificate.

\n

The following renewal status are possible:

\n " + } }, - { - "target": "com.amazonaws.lightsail#AttachStaticIp" + "com.amazonaws.lightsail#LoadBalancerTlsCertificateRevocationReason": { + "type": "enum", + "members": { + "Unspecified": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSPECIFIED" + } + }, + "KeyCompromise": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEY_COMPROMISE" + } + }, + "CaCompromise": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA_COMPROMISE" + } + }, + "AffiliationChanged": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AFFILIATION_CHANGED" + } + }, + "Superceded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUPERCEDED" + } + }, + "CessationOfOperation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CESSATION_OF_OPERATION" + } + }, + "CertificateHold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CERTIFICATE_HOLD" + } + }, + "RemoveFromCrl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REMOVE_FROM_CRL" + } + }, + "PrivilegeWithdrawn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIVILEGE_WITHDRAWN" + } + }, + "AACompromise": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "A_A_COMPROMISE" + } + } + } }, - { - "target": "com.amazonaws.lightsail#CloseInstancePublicPorts" + "com.amazonaws.lightsail#LoadBalancerTlsCertificateStatus": { + "type": "enum", + "members": { + "PendingValidation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_VALIDATION" + } + }, + "Issued": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ISSUED" + } + }, + "Inactive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, + "Expired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } + }, + "ValidationTimedOut": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_TIMED_OUT" + } + }, + "Revoked": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVOKED" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "Unknown": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN" + } + } + } }, - { - "target": "com.amazonaws.lightsail#CopySnapshot" + "com.amazonaws.lightsail#LoadBalancerTlsCertificateSummary": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the SSL/TLS certificate.

" + } + }, + "isAttached": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

When true, the SSL/TLS certificate is attached to the Lightsail load\n balancer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides a summary of SSL/TLS certificate metadata.

" + } }, - { - "target": "com.amazonaws.lightsail#CreateBucket" + "com.amazonaws.lightsail#LoadBalancerTlsCertificateSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateSummary" + } }, - { - "target": "com.amazonaws.lightsail#CreateBucketAccessKey" + "com.amazonaws.lightsail#LoadBalancerTlsPolicy": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the TLS security policy.

" + } + }, + "isDefault": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether the TLS security policy is the default.

" + } + }, + "description": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The description of the TLS security policy.

" + } + }, + "protocols": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The protocols used in a given TLS security policy.

" + } + }, + "ciphers": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The ciphers used by the TLS security policy.

\n

The ciphers are listed in order of preference.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the TLS security policies that are available for Lightsail load\n balancers.

\n

For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load\n balancers in the Amazon Lightsail Developer\n Guide.

" + } }, - { - "target": "com.amazonaws.lightsail#CreateCertificate" + "com.amazonaws.lightsail#LoadBalancerTlsPolicyList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsPolicy" + } }, - { - "target": "com.amazonaws.lightsail#CreateCloudFormationStack" + "com.amazonaws.lightsail#LogEvent": { + "type": "structure", + "members": { + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the database log event was created.

" + } + }, + "message": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The message of the database log event.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a database log event.

" + } }, - { - "target": "com.amazonaws.lightsail#CreateContactMethod" + "com.amazonaws.lightsail#LogEventList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#LogEvent" + } }, - { - "target": "com.amazonaws.lightsail#CreateContainerService" + "com.amazonaws.lightsail#MetricDatapoint": { + "type": "structure", + "members": { + "average": { + "target": "com.amazonaws.lightsail#double", + "traits": { + "smithy.api#documentation": "

The average.

" + } + }, + "maximum": { + "target": "com.amazonaws.lightsail#double", + "traits": { + "smithy.api#documentation": "

The maximum.

" + } + }, + "minimum": { + "target": "com.amazonaws.lightsail#double", + "traits": { + "smithy.api#documentation": "

The minimum.

" + } + }, + "sampleCount": { + "target": "com.amazonaws.lightsail#double", + "traits": { + "smithy.api#documentation": "

The sample count.

" + } + }, + "sum": { + "target": "com.amazonaws.lightsail#double", + "traits": { + "smithy.api#documentation": "

The sum.

" + } + }, + "timestamp": { + "target": "com.amazonaws.lightsail#timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp (e.g., 1479816991.349).

" + } + }, + "unit": { + "target": "com.amazonaws.lightsail#MetricUnit", + "traits": { + "smithy.api#documentation": "

The unit.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the metric data point.

" + } }, - { - "target": "com.amazonaws.lightsail#CreateContainerServiceDeployment" + "com.amazonaws.lightsail#MetricDatapointList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#MetricDatapoint" + } }, - { - "target": "com.amazonaws.lightsail#CreateContainerServiceRegistryLogin" + "com.amazonaws.lightsail#MetricName": { + "type": "enum", + "members": { + "CPUUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CPUUtilization" + } + }, + "NetworkIn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetworkIn" + } + }, + "NetworkOut": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetworkOut" + } + }, + "StatusCheckFailed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StatusCheckFailed" + } + }, + "StatusCheckFailed_Instance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StatusCheckFailed_Instance" + } + }, + "StatusCheckFailed_System": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StatusCheckFailed_System" + } + }, + "ClientTLSNegotiationErrorCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ClientTLSNegotiationErrorCount" + } + }, + "HealthyHostCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HealthyHostCount" + } + }, + "UnhealthyHostCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnhealthyHostCount" + } + }, + "HTTPCode_LB_4XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_LB_4XX_Count" + } + }, + "HTTPCode_LB_5XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_LB_5XX_Count" + } + }, + "HTTPCode_Instance_2XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_Instance_2XX_Count" + } + }, + "HTTPCode_Instance_3XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_Instance_3XX_Count" + } + }, + "HTTPCode_Instance_4XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_Instance_4XX_Count" + } + }, + "HTTPCode_Instance_5XX_Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPCode_Instance_5XX_Count" + } + }, + "InstanceResponseTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceResponseTime" + } + }, + "RejectedConnectionCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RejectedConnectionCount" + } + }, + "RequestCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RequestCount" + } + }, + "DatabaseConnections": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DatabaseConnections" + } + }, + "DiskQueueDepth": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DiskQueueDepth" + } + }, + "FreeStorageSpace": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FreeStorageSpace" + } + }, + "NetworkReceiveThroughput": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetworkReceiveThroughput" + } + }, + "NetworkTransmitThroughput": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetworkTransmitThroughput" + } + }, + "BurstCapacityTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BurstCapacityTime" + } + }, + "BurstCapacityPercentage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BurstCapacityPercentage" + } + } + } }, - { - "target": "com.amazonaws.lightsail#CreateDisk" + "com.amazonaws.lightsail#MetricPeriod": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 60, + "max": 86400 + } + } }, - { - "target": "com.amazonaws.lightsail#CreateDiskFromSnapshot" + "com.amazonaws.lightsail#MetricStatistic": { + "type": "enum", + "members": { + "Minimum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Minimum" + } + }, + "Maximum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Maximum" + } + }, + "Sum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Sum" + } + }, + "Average": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Average" + } + }, + "SampleCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SampleCount" + } + } + } }, - { - "target": "com.amazonaws.lightsail#CreateDiskSnapshot" + "com.amazonaws.lightsail#MetricStatisticList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#MetricStatistic" + } }, - { - "target": "com.amazonaws.lightsail#CreateDistribution" + "com.amazonaws.lightsail#MetricUnit": { + "type": "enum", + "members": { + "Seconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Seconds" + } + }, + "Microseconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Microseconds" + } + }, + "Milliseconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Milliseconds" + } + }, + "Bytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bytes" + } + }, + "Kilobytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobytes" + } + }, + "Megabytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabytes" + } + }, + "Gigabytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabytes" + } + }, + "Terabytes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabytes" + } + }, + "Bits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bits" + } + }, + "Kilobits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobits" + } + }, + "Megabits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabits" + } + }, + "Gigabits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabits" + } + }, + "Terabits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabits" + } + }, + "Percent": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Percent" + } + }, + "Count": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Count" + } + }, + "BytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bytes/Second" + } + }, + "KilobytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobytes/Second" + } + }, + "MegabytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabytes/Second" + } + }, + "GigabytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabytes/Second" + } + }, + "TerabytesSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabytes/Second" + } + }, + "BitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bits/Second" + } + }, + "KilobitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobits/Second" + } + }, + "MegabitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabits/Second" + } + }, + "GigabitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabits/Second" + } + }, + "TerabitsSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabits/Second" + } + }, + "CountSecond": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Count/Second" + } + }, + "None": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + } + } }, - { - "target": "com.amazonaws.lightsail#CreateDomain" + "com.amazonaws.lightsail#MonitoredResourceInfo": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.lightsail#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource being monitored.

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Lightsail resource being monitored.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type of the resource being monitored.

\n

Instances, load balancers, and relational databases are the only Lightsail resources\n that can currently be monitored by alarms.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes resource being monitored by an alarm.

\n

An alarm is a way to monitor your Amazon Lightsail resource metrics. For more information,\n see Alarms\n in Amazon Lightsail.

" + } }, - { - "target": "com.amazonaws.lightsail#CreateDomainEntry" + "com.amazonaws.lightsail#MonthlyTransfer": { + "type": "structure", + "members": { + "gbPerMonthAllocated": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The amount allocated per month (in GB).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the monthly data transfer in and out of your virtual private server (or\n instance).

" + } }, - { - "target": "com.amazonaws.lightsail#CreateInstances" + "com.amazonaws.lightsail#NameServersUpdateState": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#NameServersUpdateStateCode", + "traits": { + "smithy.api#documentation": "

The status code for the name servers update.

\n

Following are the possible values:

\n " + } + }, + "message": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The message that describes the reason for the status code.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of the name server records update made by Amazon Lightsail\n to an Amazon RouteĀ 53 registered domain.

\n

For more information, see DNS in Amazon Lightsail in the Amazon Lightsail\n Developer Guide.

" + } }, - { - "target": "com.amazonaws.lightsail#CreateInstancesFromSnapshot" + "com.amazonaws.lightsail#NameServersUpdateStateCode": { + "type": "enum", + "members": { + "Succeeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "Started": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTED" + } + } + } }, - { - "target": "com.amazonaws.lightsail#CreateInstanceSnapshot" + "com.amazonaws.lightsail#NetworkProtocol": { + "type": "enum", + "members": { + "TCP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tcp" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "all" + } + }, + "UDP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "udp" + } + }, + "ICMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "icmp" + } + } + } }, - { - "target": "com.amazonaws.lightsail#CreateKeyPair" + "com.amazonaws.lightsail#NonEmptyString": { + "type": "string", + "traits": { + "smithy.api#pattern": "\\S" + } }, - { - "target": "com.amazonaws.lightsail#CreateLoadBalancer" + "com.amazonaws.lightsail#NotFoundException": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#string" + }, + "docs": { + "target": "com.amazonaws.lightsail#string" + }, + "message": { + "target": "com.amazonaws.lightsail#string" + }, + "tip": { + "target": "com.amazonaws.lightsail#string" + } + }, + "traits": { + "smithy.api#documentation": "

Lightsail throws this exception when it cannot find a resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } }, - { - "target": "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificate" + "com.amazonaws.lightsail#NotificationTriggerList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#AlarmState" + } }, - { - "target": "com.amazonaws.lightsail#CreateRelationalDatabase" + "com.amazonaws.lightsail#OpenInstancePublicPorts": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#OpenInstancePublicPortsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#OpenInstancePublicPortsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses\n allowed to connect to the instance through the ports, and the protocol.

\n

The OpenInstancePublicPorts action supports tag-based access control via\n resource tags applied to the resource identified by instanceName. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/OpenInstancePublicPorts", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshot" + "com.amazonaws.lightsail#OpenInstancePublicPortsRequest": { + "type": "structure", + "members": { + "portInfo": { + "target": "com.amazonaws.lightsail#PortInfo", + "traits": { + "smithy.api#documentation": "

An object to describe the ports to open for the specified instance.

", + "smithy.api#required": {} + } + }, + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance for which to open ports.

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshot" + "com.amazonaws.lightsail#OpenInstancePublicPortsResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } }, - { - "target": "com.amazonaws.lightsail#DeleteAlarm" + "com.amazonaws.lightsail#Operation": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the operation.

" + } + }, + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The resource name.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the operation was initialized (e.g.,\n 1479816991.349).

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region and Availability Zone.

" + } + }, + "isTerminal": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the operation is terminal.

" + } + }, + "operationDetails": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

Details about the operation (e.g., Debian-1GB-Ohio-1).

" + } + }, + "operationType": { + "target": "com.amazonaws.lightsail#OperationType", + "traits": { + "smithy.api#documentation": "

The type of operation.

" + } + }, + "status": { + "target": "com.amazonaws.lightsail#OperationStatus", + "traits": { + "smithy.api#documentation": "

The status of the operation.

" + } + }, + "statusChangedAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the status was changed (e.g., 1479816991.349).

" + } + }, + "errorCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The error code.

" + } + }, + "errorDetails": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The error details.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the API operation.

" + } }, - { - "target": "com.amazonaws.lightsail#DeleteAutoSnapshot" + "com.amazonaws.lightsail#OperationFailureException": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#string" + }, + "docs": { + "target": "com.amazonaws.lightsail#string" + }, + "message": { + "target": "com.amazonaws.lightsail#string" + }, + "tip": { + "target": "com.amazonaws.lightsail#string" + } + }, + "traits": { + "smithy.api#documentation": "

Lightsail throws this exception when an operation fails to execute.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.lightsail#DeleteBucket" + "com.amazonaws.lightsail#OperationList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Operation" + } }, - { - "target": "com.amazonaws.lightsail#DeleteBucketAccessKey" + "com.amazonaws.lightsail#OperationStatus": { + "type": "enum", + "members": { + "NotStarted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotStarted" + } + }, + "Started": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Started" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "Completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "Succeeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Succeeded" + } + } + } }, - { - "target": "com.amazonaws.lightsail#DeleteCertificate" + "com.amazonaws.lightsail#OperationType": { + "type": "enum", + "members": { + "DeleteKnownHostKeys": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteKnownHostKeys" + } + }, + "DeleteInstance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteInstance" + } + }, + "CreateInstance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateInstance" + } + }, + "StopInstance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StopInstance" + } + }, + "StartInstance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StartInstance" + } + }, + "RebootInstance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RebootInstance" + } + }, + "OpenInstancePublicPorts": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OpenInstancePublicPorts" + } + }, + "PutInstancePublicPorts": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PutInstancePublicPorts" + } + }, + "CloseInstancePublicPorts": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloseInstancePublicPorts" + } + }, + "AllocateStaticIp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AllocateStaticIp" + } + }, + "ReleaseStaticIp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReleaseStaticIp" + } + }, + "AttachStaticIp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AttachStaticIp" + } + }, + "DetachStaticIp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DetachStaticIp" + } + }, + "UpdateDomainEntry": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateDomainEntry" + } + }, + "DeleteDomainEntry": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteDomainEntry" + } + }, + "CreateDomain": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateDomain" + } + }, + "DeleteDomain": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteDomain" + } + }, + "CreateInstanceSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateInstanceSnapshot" + } + }, + "DeleteInstanceSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteInstanceSnapshot" + } + }, + "CreateInstancesFromSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateInstancesFromSnapshot" + } + }, + "CreateLoadBalancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateLoadBalancer" + } + }, + "DeleteLoadBalancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteLoadBalancer" + } + }, + "AttachInstancesToLoadBalancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AttachInstancesToLoadBalancer" + } + }, + "DetachInstancesFromLoadBalancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DetachInstancesFromLoadBalancer" + } + }, + "UpdateLoadBalancerAttribute": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateLoadBalancerAttribute" + } + }, + "CreateLoadBalancerTlsCertificate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateLoadBalancerTlsCertificate" + } + }, + "DeleteLoadBalancerTlsCertificate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteLoadBalancerTlsCertificate" + } + }, + "AttachLoadBalancerTlsCertificate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AttachLoadBalancerTlsCertificate" + } + }, + "CreateDisk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateDisk" + } + }, + "DeleteDisk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteDisk" + } + }, + "AttachDisk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AttachDisk" + } + }, + "DetachDisk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DetachDisk" + } + }, + "CreateDiskSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateDiskSnapshot" + } + }, + "DeleteDiskSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteDiskSnapshot" + } + }, + "CreateDiskFromSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateDiskFromSnapshot" + } + }, + "CreateRelationalDatabase": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateRelationalDatabase" + } + }, + "UpdateRelationalDatabase": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateRelationalDatabase" + } + }, + "DeleteRelationalDatabase": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteRelationalDatabase" + } + }, + "CreateRelationalDatabaseFromSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateRelationalDatabaseFromSnapshot" + } + }, + "CreateRelationalDatabaseSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateRelationalDatabaseSnapshot" + } + }, + "DeleteRelationalDatabaseSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteRelationalDatabaseSnapshot" + } + }, + "UpdateRelationalDatabaseParameters": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateRelationalDatabaseParameters" + } + }, + "StartRelationalDatabase": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StartRelationalDatabase" + } + }, + "RebootRelationalDatabase": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RebootRelationalDatabase" + } + }, + "StopRelationalDatabase": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StopRelationalDatabase" + } + }, + "EnableAddOn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EnableAddOn" + } + }, + "DisableAddOn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DisableAddOn" + } + }, + "PutAlarm": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PutAlarm" + } + }, + "GetAlarms": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GetAlarms" + } + }, + "DeleteAlarm": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteAlarm" + } + }, + "TestAlarm": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TestAlarm" + } + }, + "CreateContactMethod": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateContactMethod" + } + }, + "GetContactMethods": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GetContactMethods" + } + }, + "SendContactMethodVerification": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SendContactMethodVerification" + } + }, + "DeleteContactMethod": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteContactMethod" + } + }, + "CreateDistribution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateDistribution" + } + }, + "UpdateDistribution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateDistribution" + } + }, + "DeleteDistribution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteDistribution" + } + }, + "ResetDistributionCache": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResetDistributionCache" + } + }, + "AttachCertificateToDistribution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AttachCertificateToDistribution" + } + }, + "DetachCertificateFromDistribution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DetachCertificateFromDistribution" + } + }, + "UpdateDistributionBundle": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateDistributionBundle" + } + }, + "SetIpAddressType": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SetIpAddressType" + } + }, + "CreateCertificate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateCertificate" + } + }, + "DeleteCertificate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteCertificate" + } + }, + "CreateContainerService": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateContainerService" + } + }, + "UpdateContainerService": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateContainerService" + } + }, + "DeleteContainerService": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteContainerService" + } + }, + "CreateContainerServiceDeployment": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateContainerServiceDeployment" + } + }, + "CreateContainerServiceRegistryLogin": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateContainerServiceRegistryLogin" + } + }, + "RegisterContainerImage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RegisterContainerImage" + } + }, + "DeleteContainerImage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteContainerImage" + } + }, + "CreateBucket": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateBucket" + } + }, + "DeleteBucket": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteBucket" + } + }, + "CreateBucketAccessKey": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateBucketAccessKey" + } + }, + "DeleteBucketAccessKey": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteBucketAccessKey" + } + }, + "UpdateBucketBundle": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateBucketBundle" + } + }, + "UpdateBucket": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateBucket" + } + }, + "SetResourceAccessForBucket": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SetResourceAccessForBucket" + } + }, + "UpdateInstanceMetadataOptions": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdateInstanceMetadataOptions" + } + } + } }, - { - "target": "com.amazonaws.lightsail#DeleteContactMethod" + "com.amazonaws.lightsail#Origin": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the origin resource.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type of the origin resource (e.g., Instance).

" + } + }, + "regionName": { + "target": "com.amazonaws.lightsail#RegionName", + "traits": { + "smithy.api#documentation": "

The AWS Region name of the origin resource.

" + } + }, + "protocolPolicy": { + "target": "com.amazonaws.lightsail#OriginProtocolPolicyEnum", + "traits": { + "smithy.api#documentation": "

The protocol that your Amazon Lightsail distribution uses when establishing a connection\n with your origin to pull content.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the origin resource of an Amazon Lightsail content delivery network (CDN)\n distribution.

\n

An origin can be a Lightsail instance, bucket, or load balancer. A distribution pulls\n content from an origin, caches it, and serves it to viewers via a worldwide network of edge\n servers.

" + } }, - { - "target": "com.amazonaws.lightsail#DeleteContainerImage" + "com.amazonaws.lightsail#OriginProtocolPolicyEnum": { + "type": "enum", + "members": { + "HTTPOnly": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "http-only" + } + }, + "HTTPSOnly": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "https-only" + } + } + } }, - { - "target": "com.amazonaws.lightsail#DeleteContainerService" + "com.amazonaws.lightsail#PartnerIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#NonEmptyString" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } }, - { - "target": "com.amazonaws.lightsail#DeleteDisk" + "com.amazonaws.lightsail#PasswordData": { + "type": "structure", + "members": { + "ciphertext": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The encrypted password. Ciphertext will be an empty string if access to your new instance\n is not ready yet. When you create an instance, it can take up to 15 minutes for the instance\n to be ready.

\n \n

If you use the default key pair (LightsailDefaultKeyPair), the decrypted\n password will be available in the password field.

\n

If you are using a custom key pair, you need to use your own means of decryption.

\n

If you change the Administrator password on the instance, Lightsail will continue to\n return the original ciphertext value. When accessing the instance using RDP, you need to\n manually enter the Administrator password after changing it from the default.

\n " + } + }, + "keyPairName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the key pair that you used when creating your instance. If no key pair name\n was specified when creating the instance, Lightsail uses the default key pair\n (LightsailDefaultKeyPair).

\n

If you are using a custom key pair, you need to use your own means of decrypting your\n password using the ciphertext. Lightsail creates the ciphertext by encrypting\n your password with the public key part of this key pair.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The password data for the Windows Server-based instance, including the ciphertext and the\n key pair name.

" + } }, - { - "target": "com.amazonaws.lightsail#DeleteDiskSnapshot" + "com.amazonaws.lightsail#PeerVpc": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#PeerVpcRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#PeerVpcResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Peers the Lightsail VPC with the user's default VPC.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/PeerVpc", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#DeleteDistribution" + "com.amazonaws.lightsail#PeerVpcRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.lightsail#PeerVpcResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } }, - { - "target": "com.amazonaws.lightsail#DeleteDomain" + "com.amazonaws.lightsail#PendingMaintenanceAction": { + "type": "structure", + "members": { + "action": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of pending database maintenance action.

" + } + }, + "description": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Additional detail about the pending database maintenance action.

" + } + }, + "currentApplyDate": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The effective date of the pending database maintenance action.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a pending database maintenance action.

" + } }, - { - "target": "com.amazonaws.lightsail#DeleteDomainEntry" + "com.amazonaws.lightsail#PendingMaintenanceActionList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#PendingMaintenanceAction" + } }, - { - "target": "com.amazonaws.lightsail#DeleteInstance" + "com.amazonaws.lightsail#PendingModifiedRelationalDatabaseValues": { + "type": "structure", + "members": { + "masterUserPassword": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The password for the master user of the database.

" + } + }, + "engineVersion": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The database engine version.

" + } + }, + "backupRetentionEnabled": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether automated backup retention is enabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a pending database value modification.

" + } }, - { - "target": "com.amazonaws.lightsail#DeleteInstanceSnapshot" + "com.amazonaws.lightsail#Port": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": -1, + "max": 65535 + } + } }, - { - "target": "com.amazonaws.lightsail#DeleteKeyPair" + "com.amazonaws.lightsail#PortAccessType": { + "type": "enum", + "members": { + "Public": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Public" + } + }, + "Private": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Private" + } + } + } }, - { - "target": "com.amazonaws.lightsail#DeleteKnownHostKeys" + "com.amazonaws.lightsail#PortInfo": { + "type": "structure", + "members": { + "fromPort": { + "target": "com.amazonaws.lightsail#Port", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The first port in a range of open ports on an instance.

\n

Allowed ports:

\n " + } + }, + "toPort": { + "target": "com.amazonaws.lightsail#Port", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The last port in a range of open ports on an instance.

\n

Allowed ports:

\n " + } + }, + "protocol": { + "target": "com.amazonaws.lightsail#NetworkProtocol", + "traits": { + "smithy.api#documentation": "

The IP protocol name.

\n

The name can be one of the following:

\n " + } + }, + "cidrs": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol.

\n \n

The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to\n connect to an instance.

\n \n

Examples:

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" + } + }, + "ipv6Cidrs": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol. Only devices with an IPv6 address\n can connect to an instance through IPv6; otherwise, IPv4 should be used.

\n \n

The cidrs parameter lists the IPv4 addresses that are allowed to connect to\n an instance.

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" + } + }, + "cidrListAliases": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

An alias that defines access for a preconfigured range of IP addresses.

\n

The only alias currently supported is lightsail-connect, which allows IP\n addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your\n instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes ports to open on an instance, the IP addresses allowed to connect to the\n instance through the ports, and the protocol.

" + } }, - { - "target": "com.amazonaws.lightsail#DeleteLoadBalancer" + "com.amazonaws.lightsail#PortInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#PortInfo" + } }, - { - "target": "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificate" + "com.amazonaws.lightsail#PortInfoSourceType": { + "type": "enum", + "members": { + "Default": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } + }, + "Instance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE" + } + }, + "None": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "Closed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOSED" + } + } + } }, - { - "target": "com.amazonaws.lightsail#DeleteRelationalDatabase" + "com.amazonaws.lightsail#PortList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Port" + } }, - { - "target": "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshot" + "com.amazonaws.lightsail#PortMap": { + "type": "map", + "key": { + "target": "com.amazonaws.lightsail#string" + }, + "value": { + "target": "com.amazonaws.lightsail#ContainerServiceProtocol" + } }, - { - "target": "com.amazonaws.lightsail#DetachCertificateFromDistribution" + "com.amazonaws.lightsail#PortState": { + "type": "enum", + "members": { + "Open": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "open" + } + }, + "Closed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "closed" + } + } + } }, - { - "target": "com.amazonaws.lightsail#DetachDisk" + "com.amazonaws.lightsail#PrivateRegistryAccess": { + "type": "structure", + "members": { + "ecrImagePullerRole": { + "target": "com.amazonaws.lightsail#ContainerServiceECRImagePullerRole", + "traits": { + "smithy.api#documentation": "

An object that describes the activation status of the role that you can use to grant a\n Lightsail container service access to Amazon ECR private\n repositories. If the role is activated, the Amazon Resource Name (ARN) of the role is also\n listed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the configuration for an Amazon Lightsail container service to\n access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

\n

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" + } }, - { - "target": "com.amazonaws.lightsail#DetachInstancesFromLoadBalancer" + "com.amazonaws.lightsail#PrivateRegistryAccessRequest": { + "type": "structure", + "members": { + "ecrImagePullerRole": { + "target": "com.amazonaws.lightsail#ContainerServiceECRImagePullerRoleRequest", + "traits": { + "smithy.api#documentation": "

An object to describe a request to activate or deactivate the role that you can use to\n grant an Amazon Lightsail container service access to Amazon Elastic Container Registry\n (Amazon ECR) private repositories.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a request to configure an Amazon Lightsail container service to\n access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

\n

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" + } }, - { - "target": "com.amazonaws.lightsail#DetachStaticIp" + "com.amazonaws.lightsail#PutAlarm": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#PutAlarmRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#PutAlarmResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates an alarm, and associates it with the specified metric.

\n

An alarm is used to monitor a single metric for one of your resources. When a metric\n condition is met, the alarm can notify you by email, SMS text message, and a banner displayed\n on the Amazon Lightsail console. For more information, see Alarms\n in Amazon Lightsail.

\n

When this action creates an alarm, the alarm state is immediately set to\n INSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n appropriately. Any actions associated with the new state are then executed.

\n

When you update an existing alarm, its state is left unchanged, but the update completely\n overwrites the previous configuration of the alarm. The alarm is then evaluated with the\n updated configuration.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/PutAlarm", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#DisableAddOn" + "com.amazonaws.lightsail#PutAlarmRequest": { + "type": "structure", + "members": { + "alarmName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name for the alarm. Specify the name of an existing alarm to update, and overwrite the\n previous configuration of the alarm.

", + "smithy.api#required": {} + } + }, + "metricName": { + "target": "com.amazonaws.lightsail#MetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric to associate with the alarm.

\n

You can configure up to two alarms per metric.

\n

The following metrics are available for each resource type:

\n \n

For more information about these metrics, see Metrics available in Lightsail.

", + "smithy.api#required": {} + } + }, + "monitoredResourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Lightsail resource that will be monitored.

\n

Instances, load balancers, and relational databases are the only Lightsail resources\n that can currently be monitored by alarms.

", + "smithy.api#required": {} + } + }, + "comparisonOperator": { + "target": "com.amazonaws.lightsail#ComparisonOperator", + "traits": { + "smithy.api#documentation": "

The arithmetic operation to use when comparing the specified statistic to the threshold.\n The specified statistic value is used as the first operand.

", + "smithy.api#required": {} + } + }, + "threshold": { + "target": "com.amazonaws.lightsail#double", + "traits": { + "smithy.api#documentation": "

The value against which the specified statistic is compared.

", + "smithy.api#required": {} + } + }, + "evaluationPeriods": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The number of most recent periods over which data is compared to the specified threshold.\n If you are setting an \"M out of N\" alarm, this value (evaluationPeriods) is the\n N.

\n

If you are setting an alarm that requires that a number of consecutive data points be\n breaching to trigger the alarm, this value specifies the rolling period of time in which data\n points are evaluated.

\n

Each evaluation period is five minutes long. For example, specify an evaluation period of\n 24 to evaluate a metric over a rolling period of two hours.

\n

You can specify a minimum valuation period of 1 (5 minutes), and a maximum evaluation\n period of 288 (24 hours).

", + "smithy.api#required": {} + } + }, + "datapointsToAlarm": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The number of data points that must be not within the specified threshold to trigger the\n alarm. If you are setting an \"M out of N\" alarm, this value (datapointsToAlarm)\n is the M.

" + } + }, + "treatMissingData": { + "target": "com.amazonaws.lightsail#TreatMissingData", + "traits": { + "smithy.api#documentation": "

Sets how this alarm will handle missing data points.

\n

An alarm can treat missing data in the following ways:

\n \n

If treatMissingData is not specified, the default behavior of\n missing is used.

" + } + }, + "contactProtocols": { + "target": "com.amazonaws.lightsail#ContactProtocolsList", + "traits": { + "smithy.api#documentation": "

The contact protocols to use for the alarm, such as Email, SMS\n (text messaging), or both.

\n

A notification is sent via the specified contact protocol if notifications are enabled for\n the alarm, and when the alarm is triggered.

\n

A notification is not sent if a contact protocol is not specified, if the specified\n contact protocol is not configured in the Amazon Web Services Region, or if notifications are\n not enabled for the alarm using the notificationEnabled paramater.

\n

Use the CreateContactMethod action to configure a contact protocol in an\n Amazon Web Services Region.

" + } + }, + "notificationTriggers": { + "target": "com.amazonaws.lightsail#NotificationTriggerList", + "traits": { + "smithy.api#documentation": "

The alarm states that trigger a notification.

\n

An alarm has the following possible states:

\n \n

When you specify a notification trigger, the ALARM state must be specified.\n The INSUFFICIENT_DATA and OK states can be specified in addition to\n the ALARM state.

\n \n

The notification trigger defaults to ALARM if you don't specify this\n parameter.

" + } + }, + "notificationEnabled": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the alarm is enabled.

\n

Notifications are enabled by default if you don't specify this parameter.

" + } + } + } }, - { - "target": "com.amazonaws.lightsail#DownloadDefaultKeyPair" + "com.amazonaws.lightsail#PutAlarmResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } }, - { - "target": "com.amazonaws.lightsail#EnableAddOn" + "com.amazonaws.lightsail#PutInstancePublicPorts": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#PutInstancePublicPortsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#PutInstancePublicPortsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses\n allowed to connect to the instance through the ports, and the protocol. This action also\n closes all currently open ports that are not included in the request. Include all of the ports\n and the protocols you want to open in your PutInstancePublicPortsrequest. Or use\n the OpenInstancePublicPorts action to open ports without closing currently open\n ports.

\n

The PutInstancePublicPorts action supports tag-based access control via\n resource tags applied to the resource identified by instanceName. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/PutInstancePublicPorts", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#ExportSnapshot" + "com.amazonaws.lightsail#PutInstancePublicPortsRequest": { + "type": "structure", + "members": { + "portInfos": { + "target": "com.amazonaws.lightsail#PortInfoList", + "traits": { + "smithy.api#documentation": "

An array of objects to describe the ports to open for the specified instance.

", + "smithy.api#required": {} + } + }, + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance for which to open ports.

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetActiveNames" + "com.amazonaws.lightsail#PutInstancePublicPortsResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetAlarms" + "com.amazonaws.lightsail#QueryStringObject": { + "type": "structure", + "members": { + "option": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the distribution forwards and caches based on query strings.

" + } + }, + "queryStringsAllowList": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The specific query strings that the distribution forwards to the origin.

\n

Your distribution will cache content based on the specified query strings.

\n

If the option parameter is true, then your distribution forwards all query\n strings, regardless of what you specify using the queryStringsAllowList\n parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the query string parameters that an Amazon Lightsail content delivery network\n (CDN) distribution to bases caching on.

\n

For the query strings that you specify, your distribution caches separate versions of the\n specified content based on the query string values in viewer\n requests.

" + } }, - { - "target": "com.amazonaws.lightsail#GetAutoSnapshots" + "com.amazonaws.lightsail#R53HostedZoneDeletionState": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#R53HostedZoneDeletionStateCode", + "traits": { + "smithy.api#documentation": "

The status code for the deletion state.

\n

Following are the possible values:

\n " + } + }, + "message": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The message that describes the reason for the status code.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the deletion state of an Amazon RouteĀ 53 hosted zone for a domain that is\n being automatically delegated to an Amazon Lightsail DNS zone.

" + } }, - { - "target": "com.amazonaws.lightsail#GetBlueprints" + "com.amazonaws.lightsail#R53HostedZoneDeletionStateCode": { + "type": "enum", + "members": { + "Succeeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "Started": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTED" + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetBucketAccessKeys" + "com.amazonaws.lightsail#RebootInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#RebootInstanceRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#RebootInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Restarts a specific instance.

\n

The reboot instance operation supports tag-based access control via resource\n tags applied to the resource identified by instance name. For more information,\n see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/RebootInstance", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#GetBucketBundles" + "com.amazonaws.lightsail#RebootInstanceRequest": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance to reboot.

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetBucketMetricData" + "com.amazonaws.lightsail#RebootInstanceResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetBuckets" + "com.amazonaws.lightsail#RebootRelationalDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#RebootRelationalDatabaseRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#RebootRelationalDatabaseResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Restarts a specific database in Amazon Lightsail.

\n

The reboot relational database operation supports tag-based access control\n via resource tags applied to the resource identified by relationalDatabaseName. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/RebootRelationalDatabase", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#GetBundles" + "com.amazonaws.lightsail#RebootRelationalDatabaseRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your database to reboot.

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetCertificates" + "com.amazonaws.lightsail#RebootRelationalDatabaseResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetCloudFormationStackRecords" + "com.amazonaws.lightsail#RecordState": { + "type": "enum", + "members": { + "Started": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Started" + } + }, + "Succeeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Succeeded" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetContactMethods" + "com.amazonaws.lightsail#Region": { + "type": "structure", + "members": { + "continentCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The continent code (e.g., NA, meaning North America).

" + } + }, + "description": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The description of the Amazon Web Services Region (e.g., This region is recommended\n to serve users in the eastern United States and eastern Canada).

" + } + }, + "displayName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The display name (e.g., Ohio).

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#RegionName", + "traits": { + "smithy.api#documentation": "

The region name (e.g., us-east-2).

" + } + }, + "availabilityZones": { + "target": "com.amazonaws.lightsail#AvailabilityZoneList", + "traits": { + "smithy.api#documentation": "

The Availability Zones. Follows the format us-east-2a\n (case-sensitive).

" + } + }, + "relationalDatabaseAvailabilityZones": { + "target": "com.amazonaws.lightsail#AvailabilityZoneList", + "traits": { + "smithy.api#documentation": "

The Availability Zones for databases. Follows the format us-east-2a\n (case-sensitive).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Amazon Web Services Region.

" + } }, - { - "target": "com.amazonaws.lightsail#GetContainerAPIMetadata" + "com.amazonaws.lightsail#RegionList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Region" + } }, - { - "target": "com.amazonaws.lightsail#GetContainerImages" + "com.amazonaws.lightsail#RegionName": { + "type": "enum", + "members": { + "US_EAST_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-1" + } + }, + "US_EAST_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-2" + } + }, + "US_WEST_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-1" + } + }, + "US_WEST_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-2" + } + }, + "EU_WEST_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-1" + } + }, + "EU_WEST_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-2" + } + }, + "EU_WEST_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-3" + } + }, + "EU_CENTRAL_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-central-1" + } + }, + "CA_CENTRAL_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ca-central-1" + } + }, + "AP_SOUTH_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-1" + } + }, + "AP_SOUTHEAST_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-1" + } + }, + "AP_SOUTHEAST_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-2" + } + }, + "AP_NORTHEAST_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-1" + } + }, + "AP_NORTHEAST_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-2" + } + }, + "EU_NORTH_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-north-1" + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetContainerLog" + "com.amazonaws.lightsail#RegisterContainerImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#RegisterContainerImageRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#RegisterContainerImageResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Registers a container image to your Amazon Lightsail container service.

\n \n

This action is not required if you install and use the Lightsail Control\n (lightsailctl) plugin to push container images to your Lightsail container service. For\n more information, see Pushing and managing container images on your Amazon Lightsail container services\n in the Amazon Lightsail Developer Guide.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/container-services/{serviceName}/images", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#GetContainerServiceDeployments" + "com.amazonaws.lightsail#RegisterContainerImageRequest": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.lightsail#ContainerServiceName", + "traits": { + "smithy.api#documentation": "

The name of the container service for which to register a container image.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "label": { + "target": "com.amazonaws.lightsail#ContainerLabel", + "traits": { + "smithy.api#documentation": "

The label for the container image when it's registered to the container service.

\n

Use a descriptive label that you can use to track the different versions of your\n registered container images.

\n

Use the GetContainerImages action to return the container images registered\n to a Lightsail container service. The label is the portion\n of the following image name example:

\n \n

If the name of your container service is mycontainerservice, and the label\n that you specify is mystaticwebsite, then the name of the registered container\n image will be :mycontainerservice.mystaticwebsite.1.

\n

The number at the end of these image name examples represents the version of the\n registered container image. If you push and register another container image to the same\n Lightsail container service, with the same label, then the version number for the new\n registered container image will be 2. If you push and register another container\n image, the version number will be 3, and so on.

", + "smithy.api#required": {} + } + }, + "digest": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The digest of the container image to be registered.

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetContainerServiceMetricData" + "com.amazonaws.lightsail#RegisterContainerImageResult": { + "type": "structure", + "members": { + "containerImage": { + "target": "com.amazonaws.lightsail#ContainerImage", + "traits": { + "smithy.api#documentation": "

An object that describes a container image that is registered to a Lightsail container\n service

" + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetContainerServicePowers" + "com.amazonaws.lightsail#RegisteredDomainDelegationInfo": { + "type": "structure", + "members": { + "nameServersUpdateState": { + "target": "com.amazonaws.lightsail#NameServersUpdateState", + "traits": { + "smithy.api#documentation": "

An object that describes the state of the name server records that are automatically added\n to the RouteĀ 53 domain by Lightsail.

" + } + }, + "r53HostedZoneDeletionState": { + "target": "com.amazonaws.lightsail#R53HostedZoneDeletionState" + } + }, + "traits": { + "smithy.api#documentation": "

Describes the delegation state of an Amazon RouteĀ 53 registered domain to Amazon Lightsail.

\n

When you delegate an Amazon RouteĀ 53 registered domain to Lightsail,\n you can manage the DNS of the domain using a Lightsail DNS zone. You no longer\n use the RouteĀ 53 hosted zone to manage the DNS of the domain. To delegate the\n domain, Lightsail automatically updates the domain's name servers in RouteĀ 53 to the name servers of the Lightsail DNS zone. Then, Lightsail automatically deletes the RouteĀ 53 hosted zone for the\n domain.

\n

All of the following conditions must be true for automatic domain delegation to be\n successful:

\n \n

If automatic domain delegation fails, or if you manage the DNS of your domain using a\n service other than RouteĀ 53, then you must manually add the Lightsail\n DNS zone name servers to your domain in order to delegate management of its DNS to Lightsail. For more information, see Creating a DNS zone to manage your domainā€™s records in Amazon Lightsail\n in the Amazon Lightsail Developer Guide.

" + } }, - { - "target": "com.amazonaws.lightsail#GetContainerServices" + "com.amazonaws.lightsail#RelationalDatabase": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The unique name of the database resource in Lightsail.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database.

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The support code for the database. Include this code in your email to support when you\n have questions about a database in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the database was created. Formatted in Unix time.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

The Region name and Availability Zone where the database is located.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type for the database (for example,\n RelationalDatabase).

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + }, + "relationalDatabaseBlueprintId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The blueprint ID for the database. A blueprint describes the major engine version of a\n database.

" + } + }, + "relationalDatabaseBundleId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The bundle ID for the database. A bundle describes the performance specifications for your\n database.

" + } + }, + "masterDatabaseName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the master database created when the Lightsail database resource is\n created.

" + } + }, + "hardware": { + "target": "com.amazonaws.lightsail#RelationalDatabaseHardware", + "traits": { + "smithy.api#documentation": "

Describes the hardware of the database.

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Describes the current state of the database.

" + } + }, + "secondaryAvailabilityZone": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

Describes the secondary Availability Zone of a high availability database.

\n

The secondary database is used for failover support of a high availability\n database.

" + } + }, + "backupRetentionEnabled": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether automated backup retention is enabled for the\n database.

" + } + }, + "pendingModifiedValues": { + "target": "com.amazonaws.lightsail#PendingModifiedRelationalDatabaseValues", + "traits": { + "smithy.api#documentation": "

Describes pending database value modifications.

" + } + }, + "engine": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The database software (for example, MySQL).

" + } + }, + "engineVersion": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The database engine version (for example, 5.7.23).

" + } + }, + "latestRestorableTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The latest point in time to which the database can be restored. Formatted in Unix\n time.

" + } + }, + "masterUsername": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The master user name of the database.

" + } + }, + "parameterApplyStatus": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of parameter updates for the database.

" + } + }, + "preferredBackupWindow": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are created for the database (for\n example, 16:00-16:30).

" + } + }, + "preferredMaintenanceWindow": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur on the database.

\n

In the format ddd:hh24:mi-ddd:hh24:mi. For example,\n Tue:17:00-Tue:17:30.

" + } + }, + "publiclyAccessible": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the database is publicly accessible.

" + } + }, + "masterEndpoint": { + "target": "com.amazonaws.lightsail#RelationalDatabaseEndpoint", + "traits": { + "smithy.api#documentation": "

The master endpoint for the database.

" + } + }, + "pendingMaintenanceActions": { + "target": "com.amazonaws.lightsail#PendingMaintenanceActionList", + "traits": { + "smithy.api#documentation": "

Describes the pending maintenance actions for the database.

" + } + }, + "caCertificateIdentifier": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The certificate associated with the database.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a database.

" + } }, - { - "target": "com.amazonaws.lightsail#GetDisk" + "com.amazonaws.lightsail#RelationalDatabaseBlueprint": { + "type": "structure", + "members": { + "blueprintId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The ID for the database blueprint.

" + } + }, + "engine": { + "target": "com.amazonaws.lightsail#RelationalDatabaseEngine", + "traits": { + "smithy.api#documentation": "

The database software of the database blueprint (for example, MySQL).

" + } + }, + "engineVersion": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The database engine version for the database blueprint (for example,\n 5.7.23).

" + } + }, + "engineDescription": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The description of the database engine for the database blueprint.

" + } + }, + "engineVersionDescription": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The description of the database engine version for the database blueprint.

" + } + }, + "isEngineDefault": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the engine version is the default for the database\n blueprint.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a database image, or blueprint. A blueprint describes the major engine version\n of a database.

" + } }, - { - "target": "com.amazonaws.lightsail#GetDisks" + "com.amazonaws.lightsail#RelationalDatabaseBlueprintList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#RelationalDatabaseBlueprint" + } }, - { - "target": "com.amazonaws.lightsail#GetDiskSnapshot" + "com.amazonaws.lightsail#RelationalDatabaseBundle": { + "type": "structure", + "members": { + "bundleId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The ID for the database bundle.

" + } + }, + "name": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name for the database bundle.

" + } + }, + "price": { + "target": "com.amazonaws.lightsail#float", + "traits": { + "smithy.api#documentation": "

The cost of the database bundle in US currency.

" + } + }, + "ramSizeInGb": { + "target": "com.amazonaws.lightsail#float", + "traits": { + "smithy.api#documentation": "

The amount of RAM in GB (for example, 2.0) for the database bundle.

" + } + }, + "diskSizeInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The size of the disk for the database bundle.

" + } + }, + "transferPerMonthInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The data transfer rate per month in GB for the database bundle.

" + } + }, + "cpuCount": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The number of virtual CPUs (vCPUs) for the database bundle.

" + } + }, + "isEncrypted": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the database bundle is encrypted.

" + } + }, + "isActive": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the database bundle is active.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a database bundle. A bundle describes the performance specifications of the\n database.

" + } }, - { - "target": "com.amazonaws.lightsail#GetDiskSnapshots" + "com.amazonaws.lightsail#RelationalDatabaseBundleList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#RelationalDatabaseBundle" + } }, - { - "target": "com.amazonaws.lightsail#GetDistributionBundles" + "com.amazonaws.lightsail#RelationalDatabaseEndpoint": { + "type": "structure", + "members": { + "port": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

Specifies the port that the database is listening on.

" + } + }, + "address": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the DNS address of the database.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an endpoint for a database.

" + } }, - { - "target": "com.amazonaws.lightsail#GetDistributionLatestCacheReset" + "com.amazonaws.lightsail#RelationalDatabaseEngine": { + "type": "enum", + "members": { + "MYSQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mysql" + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetDistributionMetricData" + "com.amazonaws.lightsail#RelationalDatabaseEvent": { + "type": "structure", + "members": { + "resource": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The database that the database event relates to.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the database event was created.

" + } + }, + "message": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The message of the database event.

" + } + }, + "eventCategories": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The category that the database event belongs to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an event for a database.

" + } }, - { - "target": "com.amazonaws.lightsail#GetDistributions" + "com.amazonaws.lightsail#RelationalDatabaseEventList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#RelationalDatabaseEvent" + } }, - { - "target": "com.amazonaws.lightsail#GetDomain" + "com.amazonaws.lightsail#RelationalDatabaseHardware": { + "type": "structure", + "members": { + "cpuCount": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The number of vCPUs for the database.

" + } + }, + "diskSizeInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The size of the disk for the database.

" + } + }, + "ramSizeInGb": { + "target": "com.amazonaws.lightsail#float", + "traits": { + "smithy.api#documentation": "

The amount of RAM in GB for the database.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the hardware of a database.

" + } }, - { - "target": "com.amazonaws.lightsail#GetDomains" + "com.amazonaws.lightsail#RelationalDatabaseList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#RelationalDatabase" + } }, - { - "target": "com.amazonaws.lightsail#GetExportSnapshotRecords" + "com.amazonaws.lightsail#RelationalDatabaseMetricName": { + "type": "enum", + "members": { + "CPUUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CPUUtilization" + } + }, + "DatabaseConnections": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DatabaseConnections" + } + }, + "DiskQueueDepth": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DiskQueueDepth" + } + }, + "FreeStorageSpace": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FreeStorageSpace" + } + }, + "NetworkReceiveThroughput": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetworkReceiveThroughput" + } + }, + "NetworkTransmitThroughput": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetworkTransmitThroughput" + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetInstance" + "com.amazonaws.lightsail#RelationalDatabaseParameter": { + "type": "structure", + "members": { + "allowedValues": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

Specifies the valid range of values for the parameter.

" + } + }, + "applyMethod": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

Indicates when parameter updates are applied.

\n

Can be immediate or pending-reboot.

" + } + }, + "applyType": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

Specifies the engine-specific parameter type.

" + } + }, + "dataType": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

Specifies the valid data type for the parameter.

" + } + }, + "description": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

Provides a description of the parameter.

" + } + }, + "isModifiable": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the parameter can be modified.

" + } + }, + "parameterName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

Specifies the name of the parameter.

" + } + }, + "parameterValue": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

Specifies the value of the parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the parameters of a database.

" + } }, - { - "target": "com.amazonaws.lightsail#GetInstanceAccessDetails" + "com.amazonaws.lightsail#RelationalDatabaseParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#RelationalDatabaseParameter" + } }, - { - "target": "com.amazonaws.lightsail#GetInstanceMetricData" + "com.amazonaws.lightsail#RelationalDatabasePasswordVersion": { + "type": "enum", + "members": { + "CURRENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CURRENT" + } + }, + "PREVIOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREVIOUS" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetInstancePortStates" + "com.amazonaws.lightsail#RelationalDatabaseSnapshot": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the database snapshot.

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database snapshot.

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The support code for the database snapshot. Include this code in your email to support\n when you have questions about a database snapshot in Lightsail. This code enables our\n support team to look up your Lightsail information more easily.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the database snapshot was created.

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

The Region name and Availability Zone where the database snapshot is located.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" + } + }, + "engine": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The software of the database snapshot (for example, MySQL)

" + } + }, + "engineVersion": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The database engine version for the database snapshot (for example,\n 5.7.23).

" + } + }, + "sizeInGb": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The size of the disk in GB (for example, 32) for the database\n snapshot.

" + } + }, + "state": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The state of the database snapshot.

" + } + }, + "fromRelationalDatabaseName": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the source database from which the database snapshot was created.

" + } + }, + "fromRelationalDatabaseArn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database from which the database snapshot was\n created.

" + } + }, + "fromRelationalDatabaseBundleId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The bundle ID of the database from which the database snapshot was created.

" + } + }, + "fromRelationalDatabaseBlueprintId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The blueprint ID of the database from which the database snapshot was created. A blueprint\n describes the major engine version of a database.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a database snapshot.

" + } }, - { - "target": "com.amazonaws.lightsail#GetInstances" + "com.amazonaws.lightsail#RelationalDatabaseSnapshotList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#RelationalDatabaseSnapshot" + } }, - { - "target": "com.amazonaws.lightsail#GetInstanceSnapshot" + "com.amazonaws.lightsail#ReleaseStaticIp": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#ReleaseStaticIpRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#ReleaseStaticIpResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a specific static IP from your account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/ReleaseStaticIp", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#GetInstanceSnapshots" + "com.amazonaws.lightsail#ReleaseStaticIpRequest": { + "type": "structure", + "members": { + "staticIpName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the static IP to delete.

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetInstanceState" + "com.amazonaws.lightsail#ReleaseStaticIpResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetKeyPair" + "com.amazonaws.lightsail#RenewalStatus": { + "type": "enum", + "members": { + "PendingAutoRenewal": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PendingAutoRenewal" + } + }, + "PendingValidation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PendingValidation" + } + }, + "Success": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Success" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetKeyPairs" + "com.amazonaws.lightsail#RenewalStatusReason": { + "type": "string" }, - { - "target": "com.amazonaws.lightsail#GetLoadBalancer" + "com.amazonaws.lightsail#RenewalSummary": { + "type": "structure", + "members": { + "domainValidationRecords": { + "target": "com.amazonaws.lightsail#DomainValidationRecordList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the domain validation records of the certificate.

" + } + }, + "renewalStatus": { + "target": "com.amazonaws.lightsail#RenewalStatus", + "traits": { + "smithy.api#documentation": "

The renewal status of the certificate.

\n

The following renewal status are possible:

\n " + } + }, + "renewalStatusReason": { + "target": "com.amazonaws.lightsail#RenewalStatusReason", + "traits": { + "smithy.api#documentation": "

The reason for the renewal status of the certificate.

" + } + }, + "updatedAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the certificate was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the status of a SSL/TLS certificate renewal managed by Amazon Lightsail.

" + } }, - { - "target": "com.amazonaws.lightsail#GetLoadBalancerMetricData" + "com.amazonaws.lightsail#RequestFailureReason": { + "type": "string" }, - { - "target": "com.amazonaws.lightsail#GetLoadBalancers" + "com.amazonaws.lightsail#ResetDistributionCache": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#ResetDistributionCacheRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#ResetDistributionCacheResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes currently cached content from your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

After resetting the cache, the next time a content request is made, your distribution\n pulls, serves, and caches it from the origin.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/ResetDistributionCache", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#GetLoadBalancerTlsCertificates" + "com.amazonaws.lightsail#ResetDistributionCacheRequest": { + "type": "structure", + "members": { + "distributionName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the distribution for which to reset cache.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

" + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetLoadBalancerTlsPolicies" + "com.amazonaws.lightsail#ResetDistributionCacheResult": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The status of the reset cache request.

" + } + }, + "createTime": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp of the reset cache request (e.g., 1479734909.17) in Unix time\n format.

" + } + }, + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetOperation" + "com.amazonaws.lightsail#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws[^:]*):([a-zA-Z0-9-]+):([a-z0-9-]+):([0-9]+):([a-zA-Z]+)/([a-zA-Z0-9-]+)$" + } }, - { - "target": "com.amazonaws.lightsail#GetOperations" + "com.amazonaws.lightsail#ResourceBucketAccess": { + "type": "enum", + "members": { + "Allow": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "allow" + } + }, + "Deny": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deny" + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetOperationsForResource" + "com.amazonaws.lightsail#ResourceLocation": { + "type": "structure", + "members": { + "availabilityZone": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The Availability Zone. Follows the format us-east-2a (case-sensitive).

" + } + }, + "regionName": { + "target": "com.amazonaws.lightsail#RegionName", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region name.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the resource location.

" + } }, - { - "target": "com.amazonaws.lightsail#GetRegions" + "com.amazonaws.lightsail#ResourceName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\w[\\w\\-]*\\w$" + } }, - { - "target": "com.amazonaws.lightsail#GetRelationalDatabase" + "com.amazonaws.lightsail#ResourceNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#ResourceName" + } }, - { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseBlueprints" + "com.amazonaws.lightsail#ResourceReceivingAccess": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the Lightsail instance.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Lightsail resource type (for example, Instance).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Amazon Lightsail instance that has access to a Lightsail bucket.

" + } }, - { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseBundles" + "com.amazonaws.lightsail#ResourceRecord": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the record.

" + } + }, + "type": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The DNS record type.

" + } + }, + "value": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The value for the DNS record.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the domain name system (DNS) records to add to your domain's DNS to validate it\n for an Amazon Lightsail certificate.

" + } }, - { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseEvents" + "com.amazonaws.lightsail#ResourceType": { + "type": "enum", + "members": { + "ContainerService": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ContainerService" + } + }, + "Instance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance" + } + }, + "StaticIp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StaticIp" + } + }, + "KeyPair": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KeyPair" + } + }, + "InstanceSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceSnapshot" + } + }, + "Domain": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Domain" + } + }, + "PeeredVpc": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PeeredVpc" + } + }, + "LoadBalancer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LoadBalancer" + } + }, + "LoadBalancerTlsCertificate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LoadBalancerTlsCertificate" + } + }, + "Disk": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disk" + } + }, + "DiskSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DiskSnapshot" + } + }, + "RelationalDatabase": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RelationalDatabase" + } + }, + "RelationalDatabaseSnapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RelationalDatabaseSnapshot" + } + }, + "ExportSnapshotRecord": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExportSnapshotRecord" + } + }, + "CloudFormationStackRecord": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudFormationStackRecord" + } + }, + "Alarm": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Alarm" + } + }, + "ContactMethod": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ContactMethod" + } + }, + "Distribution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Distribution" + } + }, + "Certificate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Certificate" + } + }, + "Bucket": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bucket" + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogEvents" + "com.amazonaws.lightsail#RevocationReason": { + "type": "string" }, - { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogStreams" + "com.amazonaws.lightsail#SendContactMethodVerification": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#SendContactMethodVerificationRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#SendContactMethodVerificationResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Sends a verification request to an email contact method to ensure it's owned by the\n requester. SMS contact methods don't need to be verified.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services\n Regions, and SMS text messages cannot be sent to some countries/regions. For more information,\n see Notifications in Amazon Lightsail.

\n

A verification request is sent to the contact method when you initially create it. Use\n this action to send another verification request if a previous verification request was\n deleted, or has expired.

\n \n

Notifications are not sent to an email contact method until after it is verified, and\n confirmed as valid.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/SendContactMethodVerification", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPassword" + "com.amazonaws.lightsail#SendContactMethodVerificationRequest": { + "type": "structure", + "members": { + "protocol": { + "target": "com.amazonaws.lightsail#ContactMethodVerificationProtocol", + "traits": { + "smithy.api#documentation": "

The protocol to verify, such as Email or SMS (text\n messaging).

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseMetricData" + "com.amazonaws.lightsail#SendContactMethodVerificationResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseParameters" + "com.amazonaws.lightsail#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } }, - { - "target": "com.amazonaws.lightsail#GetRelationalDatabases" + "com.amazonaws.lightsail#SerialNumber": { + "type": "string" }, - { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshot" + "com.amazonaws.lightsail#ServiceException": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#string" + }, + "docs": { + "target": "com.amazonaws.lightsail#string" + }, + "message": { + "target": "com.amazonaws.lightsail#string" + }, + "tip": { + "target": "com.amazonaws.lightsail#string" + } + }, + "traits": { + "smithy.api#documentation": "

A general service exception.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } }, - { - "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshots" + "com.amazonaws.lightsail#SetIpAddressType": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#SetIpAddressTypeRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#SetIpAddressTypeResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Sets the IP address type for an Amazon Lightsail resource.

\n

Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the\n specified resource. Alternately, you can use this action to disable dual-stack, and enable\n IPv4 only.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/SetIpAddressType", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#GetStaticIp" + "com.amazonaws.lightsail#SetIpAddressTypeRequest": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type.

\n

The possible values are Distribution, Instance, and\n LoadBalancer.

\n \n

Distribution-related APIs are available only in the N. Virginia (us-east-1)\n Amazon Web Services Region. Set your Amazon Web Services Region configuration to\n us-east-1 to create, view, or edit distributions.

\n ", + "smithy.api#required": {} + } + }, + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the resource for which to set the IP address type.

", + "smithy.api#required": {} + } + }, + "ipAddressType": { + "target": "com.amazonaws.lightsail#IpAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type to set for the specified resource.

\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.lightsail#GetStaticIps" + "com.amazonaws.lightsail#SetIpAddressTypeResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } }, - { - "target": "com.amazonaws.lightsail#ImportKeyPair" + "com.amazonaws.lightsail#SetResourceAccessForBucket": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#SetResourceAccessForBucketRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#SetResourceAccessForBucketResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Sets the Amazon Lightsail resources that can access the specified Lightsail\n bucket.

\n

Lightsail buckets currently support setting access for Lightsail instances in the same\n Amazon Web Services Region.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/SetResourceAccessForBucket", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#IsVpcPeered" + "com.amazonaws.lightsail#SetResourceAccessForBucketRequest": { + "type": "structure", + "members": { + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Lightsail instance for which to set bucket access. The instance must be\n in a running or stopped state.

", + "smithy.api#required": {} + } + }, + "bucketName": { + "target": "com.amazonaws.lightsail#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which to set access to another Lightsail resource.

", + "smithy.api#required": {} + } + }, + "access": { + "target": "com.amazonaws.lightsail#ResourceBucketAccess", + "traits": { + "smithy.api#documentation": "

The access setting.

\n

The following access settings are available:

\n ", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.lightsail#OpenInstancePublicPorts" + "com.amazonaws.lightsail#SetResourceAccessForBucketResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } }, - { - "target": "com.amazonaws.lightsail#PeerVpc" + "com.amazonaws.lightsail#StartInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#StartInstanceRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#StartInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance,\n use the reboot instance operation.

\n \n

When you start a stopped instance, Lightsail assigns a new public IP address to the\n instance. To use the same IP address after stopping and starting an instance, create a\n static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.

\n \n

The start instance operation supports tag-based access control via resource\n tags applied to the resource identified by instance name. For more information,\n see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/StartInstance", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#PutAlarm" + "com.amazonaws.lightsail#StartInstanceRequest": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance (a virtual private server) to start.

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.lightsail#PutInstancePublicPorts" + "com.amazonaws.lightsail#StartInstanceResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } }, - { - "target": "com.amazonaws.lightsail#RebootInstance" + "com.amazonaws.lightsail#StartRelationalDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#StartRelationalDatabaseRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#StartRelationalDatabaseResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a specific database from a stopped state in Amazon Lightsail. To restart a database,\n use the reboot relational database operation.

\n

The start relational database operation supports tag-based access control via\n resource tags applied to the resource identified by relationalDatabaseName. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/StartRelationalDatabase", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#RebootRelationalDatabase" + "com.amazonaws.lightsail#StartRelationalDatabaseRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your database to start.

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.lightsail#RegisterContainerImage" + "com.amazonaws.lightsail#StartRelationalDatabaseResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } }, - { - "target": "com.amazonaws.lightsail#ReleaseStaticIp" + "com.amazonaws.lightsail#StaticIp": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE).

" + } + }, + "arn": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the static IP (e.g.,\n arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE).

" + } + }, + "supportCode": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" + } + }, + "createdAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp when the static IP was created (e.g., 1479735304.222).

" + } + }, + "location": { + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

The region and Availability Zone where the static IP was created.

" + } + }, + "resourceType": { + "target": "com.amazonaws.lightsail#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type (usually StaticIp).

" + } + }, + "ipAddress": { + "target": "com.amazonaws.lightsail#IpAddress", + "traits": { + "smithy.api#documentation": "

The static IP address.

" + } + }, + "attachedTo": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The instance where the static IP is attached (e.g.,\n Amazon_Linux-1GB-Ohio-1).

" + } + }, + "isAttached": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value indicating whether the static IP is attached.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a static IP.

" + } }, - { - "target": "com.amazonaws.lightsail#ResetDistributionCache" + "com.amazonaws.lightsail#StaticIpList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#StaticIp" + } }, - { - "target": "com.amazonaws.lightsail#SendContactMethodVerification" + "com.amazonaws.lightsail#StatusType": { + "type": "enum", + "members": { + "Active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "Inactive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Inactive" + } + } + } }, - { - "target": "com.amazonaws.lightsail#SetIpAddressType" + "com.amazonaws.lightsail#StopInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#StopInstanceRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#StopInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a specific Amazon Lightsail instance that is currently running.

\n \n

When you start a stopped instance, Lightsail assigns a new public IP address to the\n instance. To use the same IP address after stopping and starting an instance, create a\n static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.

\n \n

The stop instance operation supports tag-based access control via resource\n tags applied to the resource identified by instance name. For more information,\n see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/StopInstance", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#SetResourceAccessForBucket" + "com.amazonaws.lightsail#StopInstanceRequest": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance (a virtual private server) to stop.

", + "smithy.api#required": {} + } + }, + "force": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

When set to True, forces a Lightsail instance that is stuck in a\n stopping state to stop.

\n \n

Only use the force parameter if your instance is stuck in the\n stopping state. In any other state, your instance should stop normally\n without adding this parameter to your API request.

\n " + } + } + } }, - { - "target": "com.amazonaws.lightsail#StartInstance" + "com.amazonaws.lightsail#StopInstanceResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } }, - { - "target": "com.amazonaws.lightsail#StartRelationalDatabase" + "com.amazonaws.lightsail#StopRelationalDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#StopRelationalDatabaseRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#StopRelationalDatabaseResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a specific database that is currently running in Amazon Lightsail.

\n

The stop relational database operation supports tag-based access control via\n resource tags applied to the resource identified by relationalDatabaseName. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/StopRelationalDatabase", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#StopInstance" + "com.amazonaws.lightsail#StopRelationalDatabaseRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your database to stop.

", + "smithy.api#required": {} + } + }, + "relationalDatabaseSnapshotName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your new database snapshot to be created before stopping your database.

" + } + } + } }, - { - "target": "com.amazonaws.lightsail#StopRelationalDatabase" + "com.amazonaws.lightsail#StopRelationalDatabaseResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } }, - { - "target": "com.amazonaws.lightsail#TagResource" + "com.amazonaws.lightsail#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#string" + } }, - { - "target": "com.amazonaws.lightsail#TestAlarm" + "com.amazonaws.lightsail#StringMax256": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } }, - { - "target": "com.amazonaws.lightsail#UnpeerVpc" + "com.amazonaws.lightsail#SubjectAlternativeNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#DomainName" + } }, - { - "target": "com.amazonaws.lightsail#UntagResource" + "com.amazonaws.lightsail#Tag": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.lightsail#TagKey", + "traits": { + "smithy.api#documentation": "

The key of the tag.

\n

Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the\n following characters: + - = . _ : / @

" + } + }, + "value": { + "target": "com.amazonaws.lightsail#TagValue", + "traits": { + "smithy.api#documentation": "

The value of the tag.

\n

Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the\n following characters: + - = . _ : / @

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

\n

For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

" + } }, - { - "target": "com.amazonaws.lightsail#UpdateBucket" + "com.amazonaws.lightsail#TagKey": { + "type": "string" }, - { - "target": "com.amazonaws.lightsail#UpdateBucketBundle" + "com.amazonaws.lightsail#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#TagKey" + } }, - { - "target": "com.amazonaws.lightsail#UpdateContainerService" + "com.amazonaws.lightsail#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#Tag" + } }, - { - "target": "com.amazonaws.lightsail#UpdateDistribution" + "com.amazonaws.lightsail#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#TagResourceResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a\n maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique\n per resource. For more information about tags, see the Amazon Lightsail Developer Guide.

\n

The tag resource operation supports tag-based access control via request tags\n and resource tags applied to the resource identified by resource name. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/TagResource", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#UpdateDistributionBundle" + "com.amazonaws.lightsail#TagResourceRequest": { + "type": "structure", + "members": { + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the resource to which you are adding tags.

", + "smithy.api#required": {} + } + }, + "resourceArn": { + "target": "com.amazonaws.lightsail#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to which you want to add a tag.

" + } + }, + "tags": { + "target": "com.amazonaws.lightsail#TagList", + "traits": { + "smithy.api#documentation": "

The tag key and optional value.

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.lightsail#UpdateDomainEntry" + "com.amazonaws.lightsail#TagResourceResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } }, - { - "target": "com.amazonaws.lightsail#UpdateInstanceMetadataOptions" + "com.amazonaws.lightsail#TagValue": { + "type": "string" }, - { - "target": "com.amazonaws.lightsail#UpdateLoadBalancerAttribute" + "com.amazonaws.lightsail#TestAlarm": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#TestAlarmRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#TestAlarmResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification\n trigger is configured for the specified alarm, the test also sends a notification to the\n notification protocol (Email and/or SMS) configured for the\n alarm.

\n

An alarm is used to monitor a single metric for one of your resources. When a metric\n condition is met, the alarm can notify you by email, SMS text message, and a banner displayed\n on the Amazon Lightsail console. For more information, see Alarms\n in Amazon Lightsail.

", + "smithy.api#http": { + "method": "GET", + "uri": "/ls/api/2016-11-28/TestAlarm", + "code": 200 + } + } }, - { - "target": "com.amazonaws.lightsail#UpdateRelationalDatabase" + "com.amazonaws.lightsail#TestAlarmRequest": { + "type": "structure", + "members": { + "alarmName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the alarm to test.

", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.lightsail#AlarmState", + "traits": { + "smithy.api#documentation": "

The alarm state to test.

\n

An alarm has the following possible states that can be tested:

\n ", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.lightsail#UpdateRelationalDatabaseParameters" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "Lightsail", - "arnNamespace": "lightsail", - "cloudFormationName": "Lightsail", - "cloudTrailEventSource": "lightsail.amazonaws.com", - "endpointPrefix": "lightsail" - }, - "aws.auth#sigv4": { - "name": "lightsail" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes\n everything you need to launch your project quickly - instances (virtual private servers),\n container services, storage buckets, managed databases, SSD-based block storage, static IP\n addresses, load balancers, content delivery network (CDN) distributions, DNS management of\n registered domains, and resource snapshots (backups) - for a low, predictable monthly\n price.

\n\n

You can manage your Lightsail resources using the Lightsail console, Lightsail API,\n Command Line Interface (CLI), or SDKs. For more information about Lightsail\n concepts and tasks, see the Amazon Lightsail Developer Guide.

\n\n

This API Reference provides detailed information about the actions, data types,\n parameters, and errors of the Lightsail service. For more information about the supported\n Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see\n Amazon Lightsail Endpoints\n and Quotas in the Amazon Web Services General Reference.

", - "smithy.api#title": "Amazon Lightsail", - "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": "aws.partition", - "argv": [ - { - "ref": "Region" + "com.amazonaws.lightsail#TestAlarmResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } - ], - "assign": "PartitionResult" } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "type": "tree", - "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" - } - ] + } + }, + "com.amazonaws.lightsail#TimeOfDay": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$" + } + }, + "com.amazonaws.lightsail#TreatMissingData": { + "type": "enum", + "members": { + "Breaching": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "breaching" } - ] }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://lightsail-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" + "NotBreaching": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "notBreaching" } - ] }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://lightsail-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "Ignore": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ignore" } - ] }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://lightsail.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" + "Missing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "missing" } - ] - }, - { - "conditions": [], - "endpoint": { - "url": "https://lightsail.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" } - ] } - ] }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.ap-south-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-south-1" - } - }, - { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.ap-south-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-south-1" - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail.ap-south-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-south-1" - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.ap-south-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-south-1" - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.ca-central-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "ca-central-1" - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.ca-central-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "ca-central-1" - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail.ca-central-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "ca-central-1" - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.ca-central-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "ca-central-1" - } - }, - { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.eu-central-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-central-1" - } - }, - { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.eu-central-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-central-1" - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail.eu-central-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-central-1" - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.eu-central-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-central-1" - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.us-west-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-west-2" - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-west-2" - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail.us-west-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-west-2" - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.us-west-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-west-2" - } - }, - { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.eu-north-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-north-1" - } - }, - { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.eu-north-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-north-1" - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail.eu-north-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-north-1" - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.eu-north-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-north-1" - } - }, - { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.eu-west-3.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-west-3" - } - }, - { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.eu-west-3.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-west-3" - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail.eu-west-3.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-west-3" - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.eu-west-3.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-west-3" - } - }, - { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.eu-west-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-west-2" - } - }, - { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.eu-west-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-west-2" - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail.eu-west-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-west-2" - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.eu-west-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-west-2" - } - }, - { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.eu-west-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-west-1" - } - }, - { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.eu-west-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-west-1" - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail.eu-west-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-west-1" - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.eu-west-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-west-1" - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.ap-northeast-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-northeast-2" - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-northeast-2" - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail.ap-northeast-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-northeast-2" - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-northeast-2" - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.ap-northeast-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-northeast-1" - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-northeast-1" - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail.ap-northeast-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-northeast-1" - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-northeast-1" - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.ap-southeast-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-southeast-1" - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-southeast-1" - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail.ap-southeast-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-southeast-1" - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-southeast-1" - } + "com.amazonaws.lightsail#UnauthenticatedException": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#string" + }, + "docs": { + "target": "com.amazonaws.lightsail#string" + }, + "message": { + "target": "com.amazonaws.lightsail#string" + }, + "tip": { + "target": "com.amazonaws.lightsail#string" + } }, - { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.ap-southeast-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-southeast-2" - } + "traits": { + "smithy.api#documentation": "

Lightsail throws this exception when the user has not been authenticated.

", + "smithy.api#error": "client", + "smithy.api#httpError": 401 + } + }, + "com.amazonaws.lightsail#UnpeerVpc": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#UnpeerVpcRequest" }, - { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-southeast-2" - } + "output": { + "target": "com.amazonaws.lightsail#UnpeerVpcResult" }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail.ap-southeast-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-southeast-2" - } + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Unpeers the Lightsail VPC from the user's default VPC.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/UnpeerVpc", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#UnpeerVpcRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.lightsail#UnpeerVpcResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#UntagResourceRequest" }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-southeast-2" - } + "output": { + "target": "com.amazonaws.lightsail#UntagResourceResult" }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.us-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-east-1" - } + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified set of tag keys and their values from the specified Amazon Lightsail\n resource.

\n

The untag resource operation supports tag-based access control via request\n tags and resource tags applied to the resource identified by resource name. For\n more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/UntagResource", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the resource from which you are removing a tag.

", + "smithy.api#required": {} + } + }, + "resourceArn": { + "target": "com.amazonaws.lightsail#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource from which you want to remove a tag.

" + } + }, + "tagKeys": { + "target": "com.amazonaws.lightsail#TagKeyList", + "traits": { + "smithy.api#documentation": "

The tag keys to delete from the specified resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#UntagResourceResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#UpdateBucket": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#UpdateBucketRequest" }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-east-1" - } + "output": { + "target": "com.amazonaws.lightsail#UpdateBucketResult" }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail.us-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-east-1" - } + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing Amazon Lightsail bucket.

\n

Use this action to update the configuration of an existing bucket, such as versioning,\n public accessibility, and the Amazon Web Services accounts that can access the bucket.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/UpdateBucket", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#UpdateBucketBundle": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#UpdateBucketBundleRequest" }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.us-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-east-1" - } + "output": { + "target": "com.amazonaws.lightsail#UpdateBucketBundleResult" }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.us-east-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": true, - "Region": "us-east-2" - } + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.

\n

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\n bucket. You can update a bucket's bundle only one time within a monthly Amazon Web Services\n billing cycle. To determine if you can update a bucket's bundle, use the GetBuckets action. The\n ableToUpdateBundle parameter in the response will indicate whether you can\n currently update a bucket's bundle.

\n

Update a bucket's bundle if it's consistently going over its storage space or data\n transfer quota, or if a bucket's usage is consistently in the lower range of its storage space\n or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might\n experience, we strongly recommend that you update a bucket's bundle only as a long-term\n strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle\n that will provide the bucket with ample storage space and data transfer for a long time to\n come.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/UpdateBucketBundle", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#UpdateBucketBundleRequest": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.lightsail#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket for which to update the bundle.

", + "smithy.api#required": {} + } + }, + "bundleId": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the new bundle to apply to the bucket.

\n

Use the GetBucketBundles action to get a list of\n bundle IDs that you can specify.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lightsail#UpdateBucketBundleResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#UpdateBucketRequest": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.lightsail#BucketName", + "traits": { + "smithy.api#documentation": "

The name of the bucket to update.

", + "smithy.api#required": {} + } + }, + "accessRules": { + "target": "com.amazonaws.lightsail#AccessRules", + "traits": { + "smithy.api#documentation": "

An object that sets the public accessibility of objects in the specified bucket.

" + } + }, + "versioning": { + "target": "com.amazonaws.lightsail#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable or suspend versioning of objects in the bucket.

\n

The following options can be specified:

\n " + } + }, + "readonlyAccessAccounts": { + "target": "com.amazonaws.lightsail#PartnerIdList", + "traits": { + "smithy.api#documentation": "

An array of strings to specify the Amazon Web Services account IDs that can access the\n bucket.

\n

You can give a maximum of 10 Amazon Web Services accounts access to a bucket.

" + } + }, + "accessLogConfig": { + "target": "com.amazonaws.lightsail#BucketAccessLogConfig", + "traits": { + "smithy.api#documentation": "

An object that describes the access log configuration for the bucket.

" + } + } + } + }, + "com.amazonaws.lightsail#UpdateBucketResult": { + "type": "structure", + "members": { + "bucket": { + "target": "com.amazonaws.lightsail#Bucket", + "traits": { + "smithy.api#documentation": "

An object that describes the bucket that is updated.

" + } + }, + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#UpdateContainerService": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#UpdateContainerServiceRequest" }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail-fips.us-east-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-east-2" - } + "output": { + "target": "com.amazonaws.lightsail#UpdateContainerServiceResult" }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lightsail.us-east-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-east-2" - } + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the configuration of your Amazon Lightsail container service, such as its power,\n scale, and public domain names.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/ls/api/2016-11-28/container-services/{serviceName}", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#UpdateContainerServiceRequest": { + "type": "structure", + "members": { + "serviceName": { + "target": "com.amazonaws.lightsail#ContainerServiceName", + "traits": { + "smithy.api#documentation": "

The name of the container service to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "power": { + "target": "com.amazonaws.lightsail#ContainerServicePowerName", + "traits": { + "smithy.api#documentation": "

The power for the container service.

\n

The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the\n container service. The power and scale of a container service makes\n up its configured capacity. To determine the monthly price of your container service, multiply\n the base price of the power with the scale (the number of nodes) of\n the service.

\n

Use the GetContainerServicePowers action to view the specifications of each\n power option.

" + } + }, + "scale": { + "target": "com.amazonaws.lightsail#ContainerServiceScale", + "traits": { + "smithy.api#documentation": "

The scale for the container service.

\n

The scale specifies the allocated compute nodes of the container service. The\n power and scale of a container service makes up its configured\n capacity. To determine the monthly price of your container service, multiply the base price of\n the power with the scale (the number of nodes) of the\n service.

" + } + }, + "isDisabled": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value to indicate whether the container service is disabled.

" + } + }, + "publicDomainNames": { + "target": "com.amazonaws.lightsail#ContainerServicePublicDomains", + "traits": { + "smithy.api#documentation": "

The public domain names to use with the container service, such as\n example.com and www.example.com.

\n

You can specify up to four public domain names for a container service. The domain names\n that you specify are used when you create a deployment with a container configured as the\n public endpoint of your container service.

\n

If you don't specify public domain names, then you can use the default domain of the\n container service.

\n \n

You must create and validate an SSL/TLS certificate before you can use public domain\n names with your container service. Use the CreateCertificate action to create a\n certificate for the public domain names you want to use with your container service.

\n \n

You can specify public domain names using a string to array map as shown in the example\n later on this page.

" + } + }, + "privateRegistryAccess": { + "target": "com.amazonaws.lightsail#PrivateRegistryAccessRequest", + "traits": { + "smithy.api#documentation": "

An object to describe the configuration for the container service to access private\n container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private\n repositories.

\n

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" + } + } + } + }, + "com.amazonaws.lightsail#UpdateContainerServiceResult": { + "type": "structure", + "members": { + "containerService": { + "target": "com.amazonaws.lightsail#ContainerService", + "traits": { + "smithy.api#documentation": "

An object that describes a container service.

" + } + } + } + }, + "com.amazonaws.lightsail#UpdateDistribution": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#UpdateDistributionRequest" }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lightsail.us-east-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-east-2" - } + "output": { + "target": "com.amazonaws.lightsail#UpdateDistributionResult" }, - { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseDualStack": false, - "UseFIPS": false, - "Region": "us-east-1", - "Endpoint": "https://example.com" - } + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing Amazon Lightsail content delivery network (CDN) distribution.

\n

Use this action to update the configuration of your existing distribution.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/UpdateDistribution", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#UpdateDistributionBundle": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#UpdateDistributionBundleRequest" }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "UseDualStack": false, - "UseFIPS": true, - "Region": "us-east-1", - "Endpoint": "https://example.com" - } + "output": { + "target": "com.amazonaws.lightsail#UpdateDistributionBundleResult" }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "UseDualStack": true, - "UseFIPS": false, - "Region": "us-east-1", - "Endpoint": "https://example.com" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.lightsail#LoadBalancer": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the load balancer (e.g., my-load-balancer).

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail load balancer. This code enables our support team to look up your Lightsail\n information more easily.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The date when your load balancer was created.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

The AWS Region where your load balancer was created (e.g., us-east-2a).\n Lightsail automatically creates your load balancer across Availability Zones.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The resource type (e.g., LoadBalancer.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "dnsName": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The DNS name of your Lightsail load balancer.

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#LoadBalancerState", - "traits": { - "smithy.api#documentation": "

The status of your load balancer. Valid values are below.

" - } - }, - "protocol": { - "target": "com.amazonaws.lightsail#LoadBalancerProtocol", - "traits": { - "smithy.api#documentation": "

The protocol you have enabled for your load balancer. Valid values are below.

\n

You can't just have HTTP_HTTPS, but you can have just\n HTTP.

" - } - }, - "publicPorts": { - "target": "com.amazonaws.lightsail#PortList", - "traits": { - "smithy.api#documentation": "

An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS,\n use port 443.

" - } - }, - "healthCheckPath": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The path you specified to perform your health checks. If no path is specified, the load\n balancer tries to make a request to the default (root) page.

" - } - }, - "instancePort": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The port where the load balancer will direct traffic to your Lightsail instances. For\n HTTP traffic, it's port 80. For HTTPS traffic, it's port 443.

" - } - }, - "instanceHealthSummary": { - "target": "com.amazonaws.lightsail#InstanceHealthSummaryList", - "traits": { - "smithy.api#documentation": "

An array of InstanceHealthSummary objects describing the health of the load\n balancer.

" - } - }, - "tlsCertificateSummaries": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateSummaryList", - "traits": { - "smithy.api#documentation": "

An array of LoadBalancerTlsCertificateSummary objects that provide additional information\n about the SSL/TLS certificates. For example, if true, the certificate is attached\n to the load balancer.

" - } - }, - "configurationOptions": { - "target": "com.amazonaws.lightsail#LoadBalancerConfigurationOptions", - "traits": { - "smithy.api#documentation": "

A string to string map of the configuration options for your load balancer. Valid values\n are listed below.

" - } - }, - "ipAddressType": { - "target": "com.amazonaws.lightsail#IpAddressType", - "traits": { - "smithy.api#documentation": "

The IP address type of the load balancer.

\n\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

" - } - }, - "httpsRedirectionEnabled": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether HTTPS redirection is enabled for the load\n balancer.

" - } - }, - "tlsPolicyName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the TLS security policy for the load balancer.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a load balancer.

" - } - }, - "com.amazonaws.lightsail#LoadBalancerAttributeName": { - "type": "enum", - "members": { - "HealthCheckPath": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HealthCheckPath" - } - }, - "SessionStickinessEnabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SessionStickinessEnabled" - } - }, - "SessionStickiness_LB_CookieDurationSeconds": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SessionStickiness_LB_CookieDurationSeconds" - } - }, - "HttpsRedirectionEnabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HttpsRedirectionEnabled" - } - }, - "TlsPolicyName": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TlsPolicyName" - } - } - } - }, - "com.amazonaws.lightsail#LoadBalancerConfigurationOptions": { - "type": "map", - "key": { - "target": "com.amazonaws.lightsail#LoadBalancerAttributeName" - }, - "value": { - "target": "com.amazonaws.lightsail#string" - } - }, - "com.amazonaws.lightsail#LoadBalancerList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#LoadBalancer" - } - }, - "com.amazonaws.lightsail#LoadBalancerMetricName": { - "type": "enum", - "members": { - "ClientTLSNegotiationErrorCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ClientTLSNegotiationErrorCount" - } - }, - "HealthyHostCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HealthyHostCount" - } - }, - "UnhealthyHostCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UnhealthyHostCount" - } - }, - "HTTPCode_LB_4XX_Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPCode_LB_4XX_Count" - } - }, - "HTTPCode_LB_5XX_Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPCode_LB_5XX_Count" - } - }, - "HTTPCode_Instance_2XX_Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPCode_Instance_2XX_Count" - } - }, - "HTTPCode_Instance_3XX_Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPCode_Instance_3XX_Count" - } - }, - "HTTPCode_Instance_4XX_Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPCode_Instance_4XX_Count" - } - }, - "HTTPCode_Instance_5XX_Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPCode_Instance_5XX_Count" - } - }, - "InstanceResponseTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InstanceResponseTime" - } - }, - "RejectedConnectionCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RejectedConnectionCount" - } - }, - "RequestCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RequestCount" - } - } - } - }, - "com.amazonaws.lightsail#LoadBalancerProtocol": { - "type": "enum", - "members": { - "HTTP_HTTPS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTP_HTTPS" - } - }, - "HTTP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTP" - } - } - } - }, - "com.amazonaws.lightsail#LoadBalancerState": { - "type": "enum", - "members": { - "Active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "active" - } - }, - "Provisioning": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "provisioning" - } - }, - "ActiveImpaired": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "active_impaired" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failed" - } - }, - "Unknown": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unknown" - } - } - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificate": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the SSL/TLS certificate (e.g., my-certificate).

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SSL/TLS certificate.

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail load balancer or SSL/TLS certificate. This code enables our support team to\n look up your Lightsail information more easily.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The time when you created your SSL/TLS certificate.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region and Availability Zone where you created your\n certificate.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The resource type (e.g., LoadBalancerTlsCertificate).

\n " - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The load balancer name where your SSL/TLS certificate is attached.

" - } - }, - "isAttached": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

When true, the SSL/TLS certificate is attached to the Lightsail load\n balancer.

" - } - }, - "status": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateStatus", - "traits": { - "smithy.api#documentation": "

The validation status of the SSL/TLS certificate. Valid values are below.

" - } - }, - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The domain name for your SSL/TLS certificate.

" - } - }, - "domainValidationRecords": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationRecordList", - "traits": { - "smithy.api#documentation": "

An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the\n records.

" - } - }, - "failureReason": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateFailureReason", - "traits": { - "smithy.api#documentation": "

The validation failure reason, if any, of the certificate.

\n\n

The following failure reasons are possible:

\n " - } - }, - "issuedAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The time when the SSL/TLS certificate was issued.

" - } - }, - "issuer": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The issuer of the certificate.

" - } - }, - "keyAlgorithm": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The algorithm used to generate the key pair (the public and private key).

" - } - }, - "notAfter": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the SSL/TLS certificate expires.

" - } - }, - "notBefore": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the SSL/TLS certificate is first valid.

" - } - }, - "renewalSummary": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateRenewalSummary", - "traits": { - "smithy.api#documentation": "

An object that describes the status of the certificate renewal managed by\n Lightsail.

" - } - }, - "revocationReason": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateRevocationReason", - "traits": { - "smithy.api#documentation": "

The reason the certificate was revoked. This value is present only when the certificate\n status is REVOKED.

" - } - }, - "revokedAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the certificate was revoked. This value is present only when the\n certificate status is REVOKED.

" - } - }, - "serial": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The serial number of the certificate.

" - } - }, - "signatureAlgorithm": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The algorithm that was used to sign the certificate.

" - } - }, - "subject": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the entity that is associated with the public key contained in the\n certificate.

" - } - }, - "subjectAlternativeNames": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

An array of strings that specify the alternate domains (e.g., example2.com)\n and subdomains (e.g., blog.example.com) for the certificate.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a load balancer SSL/TLS certificate.

\n

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

" - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateDnsRecordCreationState": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDnsRecordCreationStateCode", - "traits": { - "smithy.api#documentation": "

The status code for the automated DNS record creation.

\n\n

Following are the possible values:

\n " - } - }, - "message": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The message that describes the reason for the status code.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that describes the state of the canonical name (CNAME) records that are\n automatically added by Lightsail to the DNS of the domain to validate domain\n ownership.

" - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateDnsRecordCreationStateCode": { - "type": "enum", - "members": { - "Succeeded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCEEDED" - } - }, - "Started": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTED" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainStatus": { - "type": "enum", - "members": { - "PendingValidation": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_VALIDATION" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "Success": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESS" - } - } - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationOption": { - "type": "structure", - "members": { - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The fully qualified domain name in the certificate request.

" - } - }, - "validationStatus": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainStatus", - "traits": { - "smithy.api#documentation": "

The status of the domain validation. Valid values are listed below.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the domain names on an SSL/TLS certificate that you will use to\n validate domain ownership.

" - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationOptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationOption" - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationRecord": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A fully qualified domain name in the certificate. For example,\n example.com.

" - } - }, - "type": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of validation record. For example, CNAME for domain\n validation.

" - } - }, - "value": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The value for that type.

" - } - }, - "validationStatus": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainStatus", - "traits": { - "smithy.api#documentation": "

The validation status. Valid values are listed below.

" - } - }, - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The domain name against which your SSL/TLS certificate was validated.

" - } - }, - "dnsRecordCreationState": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDnsRecordCreationState", - "traits": { - "smithy.api#documentation": "

An object that describes the state of the canonical name (CNAME) records that are\n automatically added by Lightsail to the DNS of a domain to validate domain\n ownership.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the validation record of each domain name in the SSL/TLS certificate.

" - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationRecordList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationRecord" - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateFailureReason": { - "type": "enum", - "members": { - "NoAvailableContacts": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NO_AVAILABLE_CONTACTS" - } - }, - "AdditionalVerificationRequired": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ADDITIONAL_VERIFICATION_REQUIRED" - } - }, - "DomainNotAllowed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOMAIN_NOT_ALLOWED" - } - }, - "InvalidPublicDomain": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INVALID_PUBLIC_DOMAIN" - } - }, - "Other": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OTHER" - } - } - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificate" - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateRenewalStatus": { - "type": "enum", - "members": { - "PendingAutoRenewal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_AUTO_RENEWAL" - } - }, - "PendingValidation": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_VALIDATION" - } - }, - "Success": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESS" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateRenewalSummary": { - "type": "structure", - "members": { - "renewalStatus": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateRenewalStatus", - "traits": { - "smithy.api#documentation": "

The renewal status of the certificate.

\n

The following renewal status are possible:

\n " - } - }, - "domainValidationOptions": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationOptionList", - "traits": { - "smithy.api#documentation": "

Contains information about the validation of each domain name in the certificate, as it\n pertains to Lightsail's managed renewal. This is different from the initial validation that\n occurs as a result of the RequestCertificate request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the status of Lightsail's managed renewal for the\n certificate.

\n

The renewal status of the certificate.

\n

The following renewal status are possible:

\n " - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateRevocationReason": { - "type": "enum", - "members": { - "Unspecified": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNSPECIFIED" - } - }, - "KeyCompromise": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KEY_COMPROMISE" - } - }, - "CaCompromise": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CA_COMPROMISE" - } - }, - "AffiliationChanged": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AFFILIATION_CHANGED" - } - }, - "Superceded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUPERCEDED" - } - }, - "CessationOfOperation": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CESSATION_OF_OPERATION" - } - }, - "CertificateHold": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CERTIFICATE_HOLD" - } - }, - "RemoveFromCrl": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REMOVE_FROM_CRL" - } - }, - "PrivilegeWithdrawn": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PRIVILEGE_WITHDRAWN" - } - }, - "AACompromise": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "A_A_COMPROMISE" - } - } - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateStatus": { - "type": "enum", - "members": { - "PendingValidation": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_VALIDATION" - } - }, - "Issued": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ISSUED" - } - }, - "Inactive": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INACTIVE" - } - }, - "Expired": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXPIRED" - } - }, - "ValidationTimedOut": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VALIDATION_TIMED_OUT" - } - }, - "Revoked": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REVOKED" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "Unknown": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNKNOWN" - } - } - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateSummary": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the SSL/TLS certificate.

" - } - }, - "isAttached": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

When true, the SSL/TLS certificate is attached to the Lightsail load\n balancer.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides a summary of SSL/TLS certificate metadata.

" - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsCertificateSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateSummary" - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsPolicy": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the TLS security policy.

" - } - }, - "isDefault": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether the TLS security policy is the default.

" - } - }, - "description": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The description of the TLS security policy.

" - } - }, - "protocols": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The protocols used in a given TLS security policy.

" - } - }, - "ciphers": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The ciphers used by the TLS security policy.

\n

The ciphers are listed in order of preference.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the TLS security policies that are available for Lightsail load\n balancers.

\n\n

For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load\n balancers in the Amazon Lightsail Developer\n Guide.

" - } - }, - "com.amazonaws.lightsail#LoadBalancerTlsPolicyList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#LoadBalancerTlsPolicy" - } - }, - "com.amazonaws.lightsail#LogEvent": { - "type": "structure", - "members": { - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the database log event was created.

" - } - }, - "message": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The message of the database log event.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a database log event.

" - } - }, - "com.amazonaws.lightsail#LogEventList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#LogEvent" - } - }, - "com.amazonaws.lightsail#MetricDatapoint": { - "type": "structure", - "members": { - "average": { - "target": "com.amazonaws.lightsail#double", - "traits": { - "smithy.api#documentation": "

The average.

" - } - }, - "maximum": { - "target": "com.amazonaws.lightsail#double", - "traits": { - "smithy.api#documentation": "

The maximum.

" - } - }, - "minimum": { - "target": "com.amazonaws.lightsail#double", - "traits": { - "smithy.api#documentation": "

The minimum.

" - } - }, - "sampleCount": { - "target": "com.amazonaws.lightsail#double", - "traits": { - "smithy.api#documentation": "

The sample count.

" - } - }, - "sum": { - "target": "com.amazonaws.lightsail#double", - "traits": { - "smithy.api#documentation": "

The sum.

" - } - }, - "timestamp": { - "target": "com.amazonaws.lightsail#timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp (e.g., 1479816991.349).

" - } - }, - "unit": { - "target": "com.amazonaws.lightsail#MetricUnit", - "traits": { - "smithy.api#documentation": "

The unit.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the metric data point.

" - } - }, - "com.amazonaws.lightsail#MetricDatapointList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#MetricDatapoint" - } - }, - "com.amazonaws.lightsail#MetricName": { - "type": "enum", - "members": { - "CPUUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CPUUtilization" - } - }, - "NetworkIn": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NetworkIn" - } - }, - "NetworkOut": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NetworkOut" - } - }, - "StatusCheckFailed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StatusCheckFailed" - } - }, - "StatusCheckFailed_Instance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StatusCheckFailed_Instance" - } - }, - "StatusCheckFailed_System": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StatusCheckFailed_System" - } - }, - "ClientTLSNegotiationErrorCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ClientTLSNegotiationErrorCount" - } - }, - "HealthyHostCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HealthyHostCount" - } - }, - "UnhealthyHostCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UnhealthyHostCount" - } - }, - "HTTPCode_LB_4XX_Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPCode_LB_4XX_Count" - } - }, - "HTTPCode_LB_5XX_Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPCode_LB_5XX_Count" - } - }, - "HTTPCode_Instance_2XX_Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPCode_Instance_2XX_Count" - } - }, - "HTTPCode_Instance_3XX_Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPCode_Instance_3XX_Count" - } - }, - "HTTPCode_Instance_4XX_Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPCode_Instance_4XX_Count" - } - }, - "HTTPCode_Instance_5XX_Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPCode_Instance_5XX_Count" - } - }, - "InstanceResponseTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InstanceResponseTime" - } - }, - "RejectedConnectionCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RejectedConnectionCount" - } - }, - "RequestCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RequestCount" - } - }, - "DatabaseConnections": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DatabaseConnections" - } - }, - "DiskQueueDepth": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DiskQueueDepth" - } - }, - "FreeStorageSpace": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FreeStorageSpace" - } - }, - "NetworkReceiveThroughput": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NetworkReceiveThroughput" - } - }, - "NetworkTransmitThroughput": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NetworkTransmitThroughput" - } - }, - "BurstCapacityTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BurstCapacityTime" - } - }, - "BurstCapacityPercentage": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BurstCapacityPercentage" - } - } - } - }, - "com.amazonaws.lightsail#MetricPeriod": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 60, - "max": 86400 - } - } - }, - "com.amazonaws.lightsail#MetricStatistic": { - "type": "enum", - "members": { - "Minimum": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Minimum" - } - }, - "Maximum": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Maximum" - } - }, - "Sum": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Sum" - } - }, - "Average": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Average" - } - }, - "SampleCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SampleCount" - } - } - } - }, - "com.amazonaws.lightsail#MetricStatisticList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#MetricStatistic" - } - }, - "com.amazonaws.lightsail#MetricUnit": { - "type": "enum", - "members": { - "Seconds": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Seconds" - } - }, - "Microseconds": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Microseconds" - } - }, - "Milliseconds": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Milliseconds" - } - }, - "Bytes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Bytes" - } - }, - "Kilobytes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Kilobytes" - } - }, - "Megabytes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Megabytes" - } - }, - "Gigabytes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Gigabytes" - } - }, - "Terabytes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Terabytes" - } - }, - "Bits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Bits" - } - }, - "Kilobits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Kilobits" - } - }, - "Megabits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Megabits" - } - }, - "Gigabits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Gigabits" - } - }, - "Terabits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Terabits" - } - }, - "Percent": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Percent" - } - }, - "Count": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Count" - } - }, - "BytesSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Bytes/Second" - } - }, - "KilobytesSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Kilobytes/Second" - } - }, - "MegabytesSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Megabytes/Second" - } - }, - "GigabytesSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Gigabytes/Second" - } - }, - "TerabytesSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Terabytes/Second" - } - }, - "BitsSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Bits/Second" - } - }, - "KilobitsSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Kilobits/Second" - } - }, - "MegabitsSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Megabits/Second" - } - }, - "GigabitsSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Gigabits/Second" - } - }, - "TerabitsSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Terabits/Second" - } - }, - "CountSecond": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Count/Second" - } - }, - "None": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "None" - } - } - } - }, - "com.amazonaws.lightsail#MonitoredResourceInfo": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.lightsail#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource being monitored.

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the Lightsail resource being monitored.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type of the resource being monitored.

\n

Instances, load balancers, and relational databases are the only Lightsail resources\n that can currently be monitored by alarms.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes resource being monitored by an alarm.

\n

An alarm is a way to monitor your Amazon Lightsail resource metrics. For more information,\n see Alarms\n in Amazon Lightsail.

" - } - }, - "com.amazonaws.lightsail#MonthlyTransfer": { - "type": "structure", - "members": { - "gbPerMonthAllocated": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The amount allocated per month (in GB).

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the monthly data transfer in and out of your virtual private server (or\n instance).

" - } - }, - "com.amazonaws.lightsail#NameServersUpdateState": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#NameServersUpdateStateCode", - "traits": { - "smithy.api#documentation": "

The status code for the name servers update.

\n\n

Following are the possible values:

\n " - } - }, - "message": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The message that describes the reason for the status code.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the state of the name server records update made by Amazon Lightsail\n to an Amazon RouteĀ 53 registered domain.

\n\n

For more information, see DNS in Amazon Lightsail in the Amazon Lightsail\n Developer Guide.

" - } - }, - "com.amazonaws.lightsail#NameServersUpdateStateCode": { - "type": "enum", - "members": { - "Succeeded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCEEDED" - } - }, - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "Started": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTED" - } - } - } - }, - "com.amazonaws.lightsail#NetworkProtocol": { - "type": "enum", - "members": { - "TCP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "tcp" - } - }, - "ALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "all" - } - }, - "UDP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "udp" - } - }, - "ICMP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "icmp" - } - } - } - }, - "com.amazonaws.lightsail#NonEmptyString": { - "type": "string", - "traits": { - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.lightsail#NotFoundException": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#string" + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the bundle of your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

A distribution bundle specifies the monthly network transfer quota and monthly cost of\n your distribution.

\n

Update your distribution's bundle if your distribution is going over its monthly network\n transfer quota and is incurring an overage fee.

\n

You can update your distribution's bundle only one time within your monthly Amazon Web Services billing cycle. To determine if you can update your distribution's bundle, use the\n GetDistributions action. The ableToUpdateBundle parameter in the\n result will indicate whether you can currently update your distribution's bundle.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/UpdateDistributionBundle", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#UpdateDistributionBundleRequest": { + "type": "structure", + "members": { + "distributionName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the distribution for which to update the bundle.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

" + } + }, + "bundleId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The bundle ID of the new bundle to apply to your distribution.

\n

Use the GetDistributionBundles action to get a list of distribution bundle\n IDs that you can specify.

" + } + } + } + }, + "com.amazonaws.lightsail#UpdateDistributionBundleResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#UpdateDistributionRequest": { + "type": "structure", + "members": { + "distributionName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the distribution to update.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

", + "smithy.api#required": {} + } + }, + "origin": { + "target": "com.amazonaws.lightsail#InputOrigin", + "traits": { + "smithy.api#documentation": "

An object that describes the origin resource for the distribution, such as a Lightsail\n instance, bucket, or load balancer.

\n

The distribution pulls, caches, and serves content from the origin.

" + } + }, + "defaultCacheBehavior": { + "target": "com.amazonaws.lightsail#CacheBehavior", + "traits": { + "smithy.api#documentation": "

An object that describes the default cache behavior for the distribution.

" + } + }, + "cacheBehaviorSettings": { + "target": "com.amazonaws.lightsail#CacheSettings", + "traits": { + "smithy.api#documentation": "

An object that describes the cache behavior settings for the distribution.

\n \n

The cacheBehaviorSettings specified in your\n UpdateDistributionRequest will replace your distribution's existing\n settings.

\n " + } + }, + "cacheBehaviors": { + "target": "com.amazonaws.lightsail#CacheBehaviorList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the per-path cache behavior for the distribution.

" + } + }, + "isEnabled": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to enable the distribution.

" + } + } + } }, - "docs": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#UpdateDistributionResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } }, - "message": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#UpdateDomainEntry": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#UpdateDomainEntryRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#UpdateDomainEntryResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a domain recordset after it is created.

\n

The update domain entry operation supports tag-based access control via\n resource tags applied to the resource identified by domain name. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/UpdateDomainEntry", + "code": 200 + } + } }, - "tip": { - "target": "com.amazonaws.lightsail#string" - } - }, - "traits": { - "smithy.api#documentation": "

Lightsail throws this exception when it cannot find a resource.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.lightsail#NotificationTriggerList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#AlarmState" - } - }, - "com.amazonaws.lightsail#OpenInstancePublicPorts": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#OpenInstancePublicPortsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#OpenInstancePublicPortsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses\n allowed to connect to the instance through the ports, and the protocol.

\n

The OpenInstancePublicPorts action supports tag-based access control via\n resource tags applied to the resource identified by instanceName. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/OpenInstancePublicPorts", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#OpenInstancePublicPortsRequest": { - "type": "structure", - "members": { - "portInfo": { - "target": "com.amazonaws.lightsail#PortInfo", - "traits": { - "smithy.api#documentation": "

An object to describe the ports to open for the specified instance.

", - "smithy.api#required": {} - } - }, - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance for which to open ports.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#OpenInstancePublicPortsResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#Operation": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the operation.

" - } - }, - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The resource name.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The resource type.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the operation was initialized (e.g.,\n 1479816991.349).

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region and Availability Zone.

" - } - }, - "isTerminal": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the operation is terminal.

" - } - }, - "operationDetails": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

Details about the operation (e.g., Debian-1GB-Ohio-1).

" - } - }, - "operationType": { - "target": "com.amazonaws.lightsail#OperationType", - "traits": { - "smithy.api#documentation": "

The type of operation.

" - } - }, - "status": { - "target": "com.amazonaws.lightsail#OperationStatus", - "traits": { - "smithy.api#documentation": "

The status of the operation.

" - } - }, - "statusChangedAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the status was changed (e.g., 1479816991.349).

" - } - }, - "errorCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The error code.

" - } - }, - "errorDetails": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The error details.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the API operation.

" - } - }, - "com.amazonaws.lightsail#OperationFailureException": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#UpdateDomainEntryRequest": { + "type": "structure", + "members": { + "domainName": { + "target": "com.amazonaws.lightsail#DomainName", + "traits": { + "smithy.api#documentation": "

The name of the domain recordset to update.

", + "smithy.api#required": {} + } + }, + "domainEntry": { + "target": "com.amazonaws.lightsail#DomainEntry", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs containing information about the domain entry.

", + "smithy.api#required": {} + } + } + } }, - "docs": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#UpdateDomainEntryResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } }, - "message": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#UpdateInstanceMetadataOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#UpdateInstanceMetadataOptionsRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#UpdateInstanceMetadataOptionsResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the Amazon Lightsail instance metadata parameters on a running or stopped\n instance. When you modify the parameters on a running instance, the GetInstance\n or GetInstances API operation initially responds with a state of\n pending. After the parameter modifications are successfully applied, the state\n changes to applied in subsequent GetInstance or\n GetInstances API calls. For more information, see Use IMDSv2 with an Amazon Lightsail instance in the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/UpdateInstanceMetadataOptions", + "code": 200 + } + } }, - "tip": { - "target": "com.amazonaws.lightsail#string" - } - }, - "traits": { - "smithy.api#documentation": "

Lightsail throws this exception when an operation fails to execute.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.lightsail#OperationList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Operation" - } - }, - "com.amazonaws.lightsail#OperationStatus": { - "type": "enum", - "members": { - "NotStarted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NotStarted" - } - }, - "Started": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Started" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "Completed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "Succeeded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Succeeded" - } - } - } - }, - "com.amazonaws.lightsail#OperationType": { - "type": "enum", - "members": { - "DeleteKnownHostKeys": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteKnownHostKeys" - } - }, - "DeleteInstance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteInstance" - } - }, - "CreateInstance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateInstance" - } - }, - "StopInstance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StopInstance" - } - }, - "StartInstance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StartInstance" - } - }, - "RebootInstance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RebootInstance" - } - }, - "OpenInstancePublicPorts": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OpenInstancePublicPorts" - } - }, - "PutInstancePublicPorts": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PutInstancePublicPorts" - } - }, - "CloseInstancePublicPorts": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CloseInstancePublicPorts" - } - }, - "AllocateStaticIp": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AllocateStaticIp" - } - }, - "ReleaseStaticIp": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ReleaseStaticIp" - } - }, - "AttachStaticIp": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AttachStaticIp" - } - }, - "DetachStaticIp": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DetachStaticIp" - } - }, - "UpdateDomainEntry": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateDomainEntry" - } - }, - "DeleteDomainEntry": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteDomainEntry" - } - }, - "CreateDomain": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateDomain" - } - }, - "DeleteDomain": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteDomain" - } - }, - "CreateInstanceSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateInstanceSnapshot" - } - }, - "DeleteInstanceSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteInstanceSnapshot" - } - }, - "CreateInstancesFromSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateInstancesFromSnapshot" - } - }, - "CreateLoadBalancer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateLoadBalancer" - } - }, - "DeleteLoadBalancer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteLoadBalancer" - } - }, - "AttachInstancesToLoadBalancer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AttachInstancesToLoadBalancer" - } - }, - "DetachInstancesFromLoadBalancer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DetachInstancesFromLoadBalancer" - } - }, - "UpdateLoadBalancerAttribute": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateLoadBalancerAttribute" - } - }, - "CreateLoadBalancerTlsCertificate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateLoadBalancerTlsCertificate" - } - }, - "DeleteLoadBalancerTlsCertificate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteLoadBalancerTlsCertificate" - } - }, - "AttachLoadBalancerTlsCertificate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AttachLoadBalancerTlsCertificate" - } - }, - "CreateDisk": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateDisk" - } - }, - "DeleteDisk": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteDisk" - } - }, - "AttachDisk": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AttachDisk" - } - }, - "DetachDisk": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DetachDisk" - } - }, - "CreateDiskSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateDiskSnapshot" - } - }, - "DeleteDiskSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteDiskSnapshot" - } - }, - "CreateDiskFromSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateDiskFromSnapshot" - } - }, - "CreateRelationalDatabase": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateRelationalDatabase" - } - }, - "UpdateRelationalDatabase": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateRelationalDatabase" - } - }, - "DeleteRelationalDatabase": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteRelationalDatabase" - } - }, - "CreateRelationalDatabaseFromSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateRelationalDatabaseFromSnapshot" - } - }, - "CreateRelationalDatabaseSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateRelationalDatabaseSnapshot" - } - }, - "DeleteRelationalDatabaseSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteRelationalDatabaseSnapshot" - } - }, - "UpdateRelationalDatabaseParameters": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateRelationalDatabaseParameters" - } - }, - "StartRelationalDatabase": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StartRelationalDatabase" - } - }, - "RebootRelationalDatabase": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RebootRelationalDatabase" - } - }, - "StopRelationalDatabase": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StopRelationalDatabase" - } - }, - "EnableAddOn": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EnableAddOn" - } - }, - "DisableAddOn": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DisableAddOn" - } - }, - "PutAlarm": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PutAlarm" - } - }, - "GetAlarms": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GetAlarms" - } - }, - "DeleteAlarm": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteAlarm" - } - }, - "TestAlarm": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TestAlarm" - } - }, - "CreateContactMethod": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateContactMethod" - } - }, - "GetContactMethods": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GetContactMethods" - } - }, - "SendContactMethodVerification": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SendContactMethodVerification" - } - }, - "DeleteContactMethod": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteContactMethod" - } - }, - "CreateDistribution": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateDistribution" - } - }, - "UpdateDistribution": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateDistribution" - } - }, - "DeleteDistribution": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteDistribution" - } - }, - "ResetDistributionCache": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ResetDistributionCache" - } - }, - "AttachCertificateToDistribution": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AttachCertificateToDistribution" - } - }, - "DetachCertificateFromDistribution": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DetachCertificateFromDistribution" - } - }, - "UpdateDistributionBundle": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateDistributionBundle" - } - }, - "SetIpAddressType": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SetIpAddressType" - } - }, - "CreateCertificate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateCertificate" - } - }, - "DeleteCertificate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteCertificate" - } - }, - "CreateContainerService": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateContainerService" - } - }, - "UpdateContainerService": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateContainerService" - } - }, - "DeleteContainerService": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteContainerService" - } - }, - "CreateContainerServiceDeployment": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateContainerServiceDeployment" - } - }, - "CreateContainerServiceRegistryLogin": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateContainerServiceRegistryLogin" - } - }, - "RegisterContainerImage": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RegisterContainerImage" - } - }, - "DeleteContainerImage": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteContainerImage" - } - }, - "CreateBucket": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateBucket" - } - }, - "DeleteBucket": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteBucket" - } - }, - "CreateBucketAccessKey": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateBucketAccessKey" - } - }, - "DeleteBucketAccessKey": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeleteBucketAccessKey" - } - }, - "UpdateBucketBundle": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateBucketBundle" - } - }, - "UpdateBucket": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateBucket" - } - }, - "SetResourceAccessForBucket": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SetResourceAccessForBucket" - } - }, - "UpdateInstanceMetadataOptions": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdateInstanceMetadataOptions" - } - } - } - }, - "com.amazonaws.lightsail#Origin": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the origin resource.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The resource type of the origin resource (e.g., Instance).

" - } - }, - "regionName": { - "target": "com.amazonaws.lightsail#RegionName", - "traits": { - "smithy.api#documentation": "

The AWS Region name of the origin resource.

" - } - }, - "protocolPolicy": { - "target": "com.amazonaws.lightsail#OriginProtocolPolicyEnum", - "traits": { - "smithy.api#documentation": "

The protocol that your Amazon Lightsail distribution uses when establishing a connection\n with your origin to pull content.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the origin resource of an Amazon Lightsail content delivery network (CDN)\n distribution.

\n

An origin can be a Lightsail instance, bucket, or load balancer. A distribution pulls\n content from an origin, caches it, and serves it to viewers via a worldwide network of edge\n servers.

" - } - }, - "com.amazonaws.lightsail#OriginProtocolPolicyEnum": { - "type": "enum", - "members": { - "HTTPOnly": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "http-only" - } - }, - "HTTPSOnly": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "https-only" - } - } - } - }, - "com.amazonaws.lightsail#PartnerIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#NonEmptyString" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.lightsail#PasswordData": { - "type": "structure", - "members": { - "ciphertext": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The encrypted password. Ciphertext will be an empty string if access to your new instance\n is not ready yet. When you create an instance, it can take up to 15 minutes for the instance\n to be ready.

\n \n

If you use the default key pair (LightsailDefaultKeyPair), the decrypted\n password will be available in the password field.

\n

If you are using a custom key pair, you need to use your own means of decryption.

\n

If you change the Administrator password on the instance, Lightsail will continue to\n return the original ciphertext value. When accessing the instance using RDP, you need to\n manually enter the Administrator password after changing it from the default.

\n " - } - }, - "keyPairName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the key pair that you used when creating your instance. If no key pair name\n was specified when creating the instance, Lightsail uses the default key pair\n (LightsailDefaultKeyPair).

\n

If you are using a custom key pair, you need to use your own means of decrypting your\n password using the ciphertext. Lightsail creates the ciphertext by encrypting\n your password with the public key part of this key pair.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The password data for the Windows Server-based instance, including the ciphertext and the\n key pair name.

" - } - }, - "com.amazonaws.lightsail#PeerVpc": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#PeerVpcRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#PeerVpcResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Peers the Lightsail VPC with the user's default VPC.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/PeerVpc", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#PeerVpcRequest": { - "type": "structure", - "members": {} - }, - "com.amazonaws.lightsail#PeerVpcResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#PendingMaintenanceAction": { - "type": "structure", - "members": { - "action": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of pending database maintenance action.

" - } - }, - "description": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Additional detail about the pending database maintenance action.

" - } - }, - "currentApplyDate": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The effective date of the pending database maintenance action.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a pending database maintenance action.

" - } - }, - "com.amazonaws.lightsail#PendingMaintenanceActionList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#PendingMaintenanceAction" - } - }, - "com.amazonaws.lightsail#PendingModifiedRelationalDatabaseValues": { - "type": "structure", - "members": { - "masterUserPassword": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The password for the master user of the database.

" - } - }, - "engineVersion": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The database engine version.

" - } - }, - "backupRetentionEnabled": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether automated backup retention is enabled.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a pending database value modification.

" - } - }, - "com.amazonaws.lightsail#Port": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": -1, - "max": 65535 - } - } - }, - "com.amazonaws.lightsail#PortAccessType": { - "type": "enum", - "members": { - "Public": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Public" - } - }, - "Private": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Private" - } - } - } - }, - "com.amazonaws.lightsail#PortInfo": { - "type": "structure", - "members": { - "fromPort": { - "target": "com.amazonaws.lightsail#Port", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The first port in a range of open ports on an instance.

\n

Allowed ports:

\n " - } - }, - "toPort": { - "target": "com.amazonaws.lightsail#Port", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The last port in a range of open ports on an instance.

\n

Allowed ports:

\n " - } - }, - "protocol": { - "target": "com.amazonaws.lightsail#NetworkProtocol", - "traits": { - "smithy.api#documentation": "

The IP protocol name.

\n

The name can be one of the following:

\n " - } - }, - "cidrs": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol.

\n \n

The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to\n connect to an instance.

\n \n

Examples:

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" - } - }, - "ipv6Cidrs": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol. Only devices with an IPv6 address\n can connect to an instance through IPv6; otherwise, IPv4 should be used.

\n \n

The cidrs parameter lists the IPv4 addresses that are allowed to connect to\n an instance.

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" - } - }, - "cidrListAliases": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

An alias that defines access for a preconfigured range of IP addresses.

\n

The only alias currently supported is lightsail-connect, which allows IP\n addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your\n instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes ports to open on an instance, the IP addresses allowed to connect to the\n instance through the ports, and the protocol.

" - } - }, - "com.amazonaws.lightsail#PortInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#PortInfo" - } - }, - "com.amazonaws.lightsail#PortInfoSourceType": { - "type": "enum", - "members": { - "Default": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEFAULT" - } - }, - "Instance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INSTANCE" - } - }, - "None": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "Closed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLOSED" - } - } - } - }, - "com.amazonaws.lightsail#PortList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Port" - } - }, - "com.amazonaws.lightsail#PortMap": { - "type": "map", - "key": { - "target": "com.amazonaws.lightsail#string" - }, - "value": { - "target": "com.amazonaws.lightsail#ContainerServiceProtocol" - } - }, - "com.amazonaws.lightsail#PortState": { - "type": "enum", - "members": { - "Open": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "open" - } - }, - "Closed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "closed" - } - } - } - }, - "com.amazonaws.lightsail#PrivateRegistryAccess": { - "type": "structure", - "members": { - "ecrImagePullerRole": { - "target": "com.amazonaws.lightsail#ContainerServiceECRImagePullerRole", - "traits": { - "smithy.api#documentation": "

An object that describes the activation status of the role that you can use to grant a\n Lightsail container service access to Amazon ECR private\n repositories. If the role is activated, the Amazon Resource Name (ARN) of the role is also\n listed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the configuration for an Amazon Lightsail container service to\n access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

\n\n

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" - } - }, - "com.amazonaws.lightsail#PrivateRegistryAccessRequest": { - "type": "structure", - "members": { - "ecrImagePullerRole": { - "target": "com.amazonaws.lightsail#ContainerServiceECRImagePullerRoleRequest", - "traits": { - "smithy.api#documentation": "

An object to describe a request to activate or deactivate the role that you can use to\n grant an Amazon Lightsail container service access to Amazon Elastic Container Registry\n (Amazon ECR) private repositories.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a request to configure an Amazon Lightsail container service to\n access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

\n\n

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" - } - }, - "com.amazonaws.lightsail#PutAlarm": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#PutAlarmRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#PutAlarmResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates or updates an alarm, and associates it with the specified metric.

\n

An alarm is used to monitor a single metric for one of your resources. When a metric\n condition is met, the alarm can notify you by email, SMS text message, and a banner displayed\n on the Amazon Lightsail console. For more information, see Alarms\n in Amazon Lightsail.

\n

When this action creates an alarm, the alarm state is immediately set to\n INSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n appropriately. Any actions associated with the new state are then executed.

\n

When you update an existing alarm, its state is left unchanged, but the update completely\n overwrites the previous configuration of the alarm. The alarm is then evaluated with the\n updated configuration.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/PutAlarm", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#PutAlarmRequest": { - "type": "structure", - "members": { - "alarmName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name for the alarm. Specify the name of an existing alarm to update, and overwrite the\n previous configuration of the alarm.

", - "smithy.api#required": {} - } - }, - "metricName": { - "target": "com.amazonaws.lightsail#MetricName", - "traits": { - "smithy.api#documentation": "

The name of the metric to associate with the alarm.

\n

You can configure up to two alarms per metric.

\n

The following metrics are available for each resource type:

\n \n

For more information about these metrics, see Metrics available in Lightsail.

", - "smithy.api#required": {} - } - }, - "monitoredResourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the Lightsail resource that will be monitored.

\n

Instances, load balancers, and relational databases are the only Lightsail resources\n that can currently be monitored by alarms.

", - "smithy.api#required": {} - } - }, - "comparisonOperator": { - "target": "com.amazonaws.lightsail#ComparisonOperator", - "traits": { - "smithy.api#documentation": "

The arithmetic operation to use when comparing the specified statistic to the threshold.\n The specified statistic value is used as the first operand.

", - "smithy.api#required": {} - } - }, - "threshold": { - "target": "com.amazonaws.lightsail#double", - "traits": { - "smithy.api#documentation": "

The value against which the specified statistic is compared.

", - "smithy.api#required": {} - } - }, - "evaluationPeriods": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The number of most recent periods over which data is compared to the specified threshold.\n If you are setting an \"M out of N\" alarm, this value (evaluationPeriods) is the\n N.

\n

If you are setting an alarm that requires that a number of consecutive data points be\n breaching to trigger the alarm, this value specifies the rolling period of time in which data\n points are evaluated.

\n

Each evaluation period is five minutes long. For example, specify an evaluation period of\n 24 to evaluate a metric over a rolling period of two hours.

\n

You can specify a minimum valuation period of 1 (5 minutes), and a maximum evaluation\n period of 288 (24 hours).

", - "smithy.api#required": {} - } - }, - "datapointsToAlarm": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The number of data points that must be not within the specified threshold to trigger the\n alarm. If you are setting an \"M out of N\" alarm, this value (datapointsToAlarm)\n is the M.

" - } - }, - "treatMissingData": { - "target": "com.amazonaws.lightsail#TreatMissingData", - "traits": { - "smithy.api#documentation": "

Sets how this alarm will handle missing data points.

\n

An alarm can treat missing data in the following ways:

\n \n

If treatMissingData is not specified, the default behavior of\n missing is used.

" - } - }, - "contactProtocols": { - "target": "com.amazonaws.lightsail#ContactProtocolsList", - "traits": { - "smithy.api#documentation": "

The contact protocols to use for the alarm, such as Email, SMS\n (text messaging), or both.

\n

A notification is sent via the specified contact protocol if notifications are enabled for\n the alarm, and when the alarm is triggered.

\n

A notification is not sent if a contact protocol is not specified, if the specified\n contact protocol is not configured in the Amazon Web Services Region, or if notifications are\n not enabled for the alarm using the notificationEnabled paramater.

\n

Use the CreateContactMethod action to configure a contact protocol in an\n Amazon Web Services Region.

" - } - }, - "notificationTriggers": { - "target": "com.amazonaws.lightsail#NotificationTriggerList", - "traits": { - "smithy.api#documentation": "

The alarm states that trigger a notification.

\n

An alarm has the following possible states:

\n \n

When you specify a notification trigger, the ALARM state must be specified.\n The INSUFFICIENT_DATA and OK states can be specified in addition to\n the ALARM state.

\n \n

The notification trigger defaults to ALARM if you don't specify this\n parameter.

" - } - }, - "notificationEnabled": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the alarm is enabled.

\n

Notifications are enabled by default if you don't specify this parameter.

" - } - } - } - }, - "com.amazonaws.lightsail#PutAlarmResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#PutInstancePublicPorts": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#PutInstancePublicPortsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#PutInstancePublicPortsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses\n allowed to connect to the instance through the ports, and the protocol. This action also\n closes all currently open ports that are not included in the request. Include all of the ports\n and the protocols you want to open in your PutInstancePublicPortsrequest. Or use\n the OpenInstancePublicPorts action to open ports without closing currently open\n ports.

\n

The PutInstancePublicPorts action supports tag-based access control via\n resource tags applied to the resource identified by instanceName. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/PutInstancePublicPorts", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#PutInstancePublicPortsRequest": { - "type": "structure", - "members": { - "portInfos": { - "target": "com.amazonaws.lightsail#PortInfoList", - "traits": { - "smithy.api#documentation": "

An array of objects to describe the ports to open for the specified instance.

", - "smithy.api#required": {} - } - }, - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance for which to open ports.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#PutInstancePublicPortsResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#QueryStringObject": { - "type": "structure", - "members": { - "option": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the distribution forwards and caches based on query strings.

" - } - }, - "queryStringsAllowList": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The specific query strings that the distribution forwards to the origin.

\n

Your distribution will cache content based on the specified query strings.

\n

If the option parameter is true, then your distribution forwards all query\n strings, regardless of what you specify using the queryStringsAllowList\n parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the query string parameters that an Amazon Lightsail content delivery network\n (CDN) distribution to bases caching on.

\n

For the query strings that you specify, your distribution caches separate versions of the\n specified content based on the query string values in viewer\n requests.

" - } - }, - "com.amazonaws.lightsail#R53HostedZoneDeletionState": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#R53HostedZoneDeletionStateCode", - "traits": { - "smithy.api#documentation": "

The status code for the deletion state.

\n\n

Following are the possible values:

\n " - } - }, - "message": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The message that describes the reason for the status code.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the deletion state of an Amazon RouteĀ 53 hosted zone for a domain that is\n being automatically delegated to an Amazon Lightsail DNS zone.

" - } - }, - "com.amazonaws.lightsail#R53HostedZoneDeletionStateCode": { - "type": "enum", - "members": { - "Succeeded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCEEDED" - } - }, - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "Started": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTED" - } - } - } - }, - "com.amazonaws.lightsail#RebootInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#RebootInstanceRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#RebootInstanceResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Restarts a specific instance.

\n

The reboot instance operation supports tag-based access control via resource\n tags applied to the resource identified by instance name. For more information,\n see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/RebootInstance", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#RebootInstanceRequest": { - "type": "structure", - "members": { - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance to reboot.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#RebootInstanceResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#RebootRelationalDatabase": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#RebootRelationalDatabaseRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#RebootRelationalDatabaseResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Restarts a specific database in Amazon Lightsail.

\n

The reboot relational database operation supports tag-based access control\n via resource tags applied to the resource identified by relationalDatabaseName. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/RebootRelationalDatabase", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#RebootRelationalDatabaseRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your database to reboot.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#RebootRelationalDatabaseResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#RecordState": { - "type": "enum", - "members": { - "Started": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Started" - } - }, - "Succeeded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Succeeded" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - } - } - }, - "com.amazonaws.lightsail#Region": { - "type": "structure", - "members": { - "continentCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The continent code (e.g., NA, meaning North America).

" - } - }, - "description": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The description of the Amazon Web Services Region (e.g., This region is recommended\n to serve users in the eastern United States and eastern Canada).

" - } - }, - "displayName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The display name (e.g., Ohio).

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#RegionName", - "traits": { - "smithy.api#documentation": "

The region name (e.g., us-east-2).

" - } - }, - "availabilityZones": { - "target": "com.amazonaws.lightsail#AvailabilityZoneList", - "traits": { - "smithy.api#documentation": "

The Availability Zones. Follows the format us-east-2a\n (case-sensitive).

" - } - }, - "relationalDatabaseAvailabilityZones": { - "target": "com.amazonaws.lightsail#AvailabilityZoneList", - "traits": { - "smithy.api#documentation": "

The Availability Zones for databases. Follows the format us-east-2a\n (case-sensitive).

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Amazon Web Services Region.

" - } - }, - "com.amazonaws.lightsail#RegionList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Region" - } - }, - "com.amazonaws.lightsail#RegionName": { - "type": "enum", - "members": { - "US_EAST_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-east-1" - } - }, - "US_EAST_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-east-2" - } - }, - "US_WEST_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-1" - } - }, - "US_WEST_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-2" - } - }, - "EU_WEST_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-1" - } - }, - "EU_WEST_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-2" - } - }, - "EU_WEST_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-3" - } - }, - "EU_CENTRAL_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-central-1" - } - }, - "CA_CENTRAL_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ca-central-1" - } - }, - "AP_SOUTH_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-south-1" - } - }, - "AP_SOUTHEAST_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-1" - } - }, - "AP_SOUTHEAST_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-2" - } - }, - "AP_NORTHEAST_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-1" - } - }, - "AP_NORTHEAST_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-2" - } - }, - "EU_NORTH_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-north-1" - } - } - } - }, - "com.amazonaws.lightsail#RegisterContainerImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#RegisterContainerImageRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#RegisterContainerImageResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Registers a container image to your Amazon Lightsail container service.

\n\n \n

This action is not required if you install and use the Lightsail Control\n (lightsailctl) plugin to push container images to your Lightsail container service. For\n more information, see Pushing and managing container images on your Amazon Lightsail container services\n in the Amazon Lightsail Developer Guide.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/container-services/{serviceName}/images", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#RegisterContainerImageRequest": { - "type": "structure", - "members": { - "serviceName": { - "target": "com.amazonaws.lightsail#ContainerServiceName", - "traits": { - "smithy.api#documentation": "

The name of the container service for which to register a container image.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "label": { - "target": "com.amazonaws.lightsail#ContainerLabel", - "traits": { - "smithy.api#documentation": "

The label for the container image when it's registered to the container service.

\n\n

Use a descriptive label that you can use to track the different versions of your\n registered container images.

\n\n

Use the GetContainerImages action to return the container images registered\n to a Lightsail container service. The label is the portion\n of the following image name example:

\n \n\n

If the name of your container service is mycontainerservice, and the label\n that you specify is mystaticwebsite, then the name of the registered container\n image will be :mycontainerservice.mystaticwebsite.1.

\n\n

The number at the end of these image name examples represents the version of the\n registered container image. If you push and register another container image to the same\n Lightsail container service, with the same label, then the version number for the new\n registered container image will be 2. If you push and register another container\n image, the version number will be 3, and so on.

", - "smithy.api#required": {} - } - }, - "digest": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The digest of the container image to be registered.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#RegisterContainerImageResult": { - "type": "structure", - "members": { - "containerImage": { - "target": "com.amazonaws.lightsail#ContainerImage", - "traits": { - "smithy.api#documentation": "

An object that describes a container image that is registered to a Lightsail container\n service

" - } - } - } - }, - "com.amazonaws.lightsail#RegisteredDomainDelegationInfo": { - "type": "structure", - "members": { - "nameServersUpdateState": { - "target": "com.amazonaws.lightsail#NameServersUpdateState", - "traits": { - "smithy.api#documentation": "

An object that describes the state of the name server records that are automatically added\n to the RouteĀ 53 domain by Lightsail.

" - } - }, - "r53HostedZoneDeletionState": { - "target": "com.amazonaws.lightsail#R53HostedZoneDeletionState" - } - }, - "traits": { - "smithy.api#documentation": "

Describes the delegation state of an Amazon RouteĀ 53 registered domain to Amazon Lightsail.

\n\n

When you delegate an Amazon RouteĀ 53 registered domain to Lightsail,\n you can manage the DNS of the domain using a Lightsail DNS zone. You no longer\n use the RouteĀ 53 hosted zone to manage the DNS of the domain. To delegate the\n domain, Lightsail automatically updates the domain's name servers in RouteĀ 53 to the name servers of the Lightsail DNS zone. Then, Lightsail automatically deletes the RouteĀ 53 hosted zone for the\n domain.

\n\n

All of the following conditions must be true for automatic domain delegation to be\n successful:

\n\n \n\n

If automatic domain delegation fails, or if you manage the DNS of your domain using a\n service other than RouteĀ 53, then you must manually add the Lightsail\n DNS zone name servers to your domain in order to delegate management of its DNS to Lightsail. For more information, see Creating a DNS zone to manage your domainā€™s records in Amazon Lightsail\n in the Amazon Lightsail Developer Guide.

" - } - }, - "com.amazonaws.lightsail#RelationalDatabase": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The unique name of the database resource in Lightsail.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database.

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The support code for the database. Include this code in your email to support when you\n have questions about a database in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the database was created. Formatted in Unix time.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

The Region name and Availability Zone where the database is located.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type for the database (for example,\n RelationalDatabase).

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "relationalDatabaseBlueprintId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The blueprint ID for the database. A blueprint describes the major engine version of a\n database.

" - } - }, - "relationalDatabaseBundleId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The bundle ID for the database. A bundle describes the performance specifications for your\n database.

" - } - }, - "masterDatabaseName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the master database created when the Lightsail database resource is\n created.

" - } - }, - "hardware": { - "target": "com.amazonaws.lightsail#RelationalDatabaseHardware", - "traits": { - "smithy.api#documentation": "

Describes the hardware of the database.

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Describes the current state of the database.

" - } - }, - "secondaryAvailabilityZone": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

Describes the secondary Availability Zone of a high availability database.

\n

The secondary database is used for failover support of a high availability\n database.

" - } - }, - "backupRetentionEnabled": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether automated backup retention is enabled for the\n database.

" - } - }, - "pendingModifiedValues": { - "target": "com.amazonaws.lightsail#PendingModifiedRelationalDatabaseValues", - "traits": { - "smithy.api#documentation": "

Describes pending database value modifications.

" - } - }, - "engine": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The database software (for example, MySQL).

" - } - }, - "engineVersion": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The database engine version (for example, 5.7.23).

" - } - }, - "latestRestorableTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The latest point in time to which the database can be restored. Formatted in Unix\n time.

" - } - }, - "masterUsername": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The master user name of the database.

" - } - }, - "parameterApplyStatus": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The status of parameter updates for the database.

" - } - }, - "preferredBackupWindow": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created for the database (for\n example, 16:00-16:30).

" - } - }, - "preferredMaintenanceWindow": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur on the database.

\n

In the format ddd:hh24:mi-ddd:hh24:mi. For example,\n Tue:17:00-Tue:17:30.

" - } - }, - "publiclyAccessible": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the database is publicly accessible.

" - } - }, - "masterEndpoint": { - "target": "com.amazonaws.lightsail#RelationalDatabaseEndpoint", - "traits": { - "smithy.api#documentation": "

The master endpoint for the database.

" - } - }, - "pendingMaintenanceActions": { - "target": "com.amazonaws.lightsail#PendingMaintenanceActionList", - "traits": { - "smithy.api#documentation": "

Describes the pending maintenance actions for the database.

" - } - }, - "caCertificateIdentifier": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The certificate associated with the database.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a database.

" - } - }, - "com.amazonaws.lightsail#RelationalDatabaseBlueprint": { - "type": "structure", - "members": { - "blueprintId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The ID for the database blueprint.

" - } - }, - "engine": { - "target": "com.amazonaws.lightsail#RelationalDatabaseEngine", - "traits": { - "smithy.api#documentation": "

The database software of the database blueprint (for example, MySQL).

" - } - }, - "engineVersion": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The database engine version for the database blueprint (for example,\n 5.7.23).

" - } - }, - "engineDescription": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The description of the database engine for the database blueprint.

" - } - }, - "engineVersionDescription": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The description of the database engine version for the database blueprint.

" - } - }, - "isEngineDefault": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the engine version is the default for the database\n blueprint.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a database image, or blueprint. A blueprint describes the major engine version\n of a database.

" - } - }, - "com.amazonaws.lightsail#RelationalDatabaseBlueprintList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#RelationalDatabaseBlueprint" - } - }, - "com.amazonaws.lightsail#RelationalDatabaseBundle": { - "type": "structure", - "members": { - "bundleId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The ID for the database bundle.

" - } - }, - "name": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name for the database bundle.

" - } - }, - "price": { - "target": "com.amazonaws.lightsail#float", - "traits": { - "smithy.api#documentation": "

The cost of the database bundle in US currency.

" - } - }, - "ramSizeInGb": { - "target": "com.amazonaws.lightsail#float", - "traits": { - "smithy.api#documentation": "

The amount of RAM in GB (for example, 2.0) for the database bundle.

" - } - }, - "diskSizeInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The size of the disk for the database bundle.

" - } - }, - "transferPerMonthInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The data transfer rate per month in GB for the database bundle.

" - } - }, - "cpuCount": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The number of virtual CPUs (vCPUs) for the database bundle.

" - } - }, - "isEncrypted": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the database bundle is encrypted.

" - } - }, - "isActive": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the database bundle is active.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a database bundle. A bundle describes the performance specifications of the\n database.

" - } - }, - "com.amazonaws.lightsail#RelationalDatabaseBundleList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#RelationalDatabaseBundle" - } - }, - "com.amazonaws.lightsail#RelationalDatabaseEndpoint": { - "type": "structure", - "members": { - "port": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

Specifies the port that the database is listening on.

" - } - }, - "address": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies the DNS address of the database.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an endpoint for a database.

" - } - }, - "com.amazonaws.lightsail#RelationalDatabaseEngine": { - "type": "enum", - "members": { - "MYSQL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "mysql" - } - } - } - }, - "com.amazonaws.lightsail#RelationalDatabaseEvent": { - "type": "structure", - "members": { - "resource": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The database that the database event relates to.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the database event was created.

" - } - }, - "message": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The message of the database event.

" - } - }, - "eventCategories": { - "target": "com.amazonaws.lightsail#StringList", - "traits": { - "smithy.api#documentation": "

The category that the database event belongs to.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an event for a database.

" - } - }, - "com.amazonaws.lightsail#RelationalDatabaseEventList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#RelationalDatabaseEvent" - } - }, - "com.amazonaws.lightsail#RelationalDatabaseHardware": { - "type": "structure", - "members": { - "cpuCount": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The number of vCPUs for the database.

" - } - }, - "diskSizeInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The size of the disk for the database.

" - } - }, - "ramSizeInGb": { - "target": "com.amazonaws.lightsail#float", - "traits": { - "smithy.api#documentation": "

The amount of RAM in GB for the database.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the hardware of a database.

" - } - }, - "com.amazonaws.lightsail#RelationalDatabaseList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#RelationalDatabase" - } - }, - "com.amazonaws.lightsail#RelationalDatabaseMetricName": { - "type": "enum", - "members": { - "CPUUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CPUUtilization" - } - }, - "DatabaseConnections": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DatabaseConnections" - } - }, - "DiskQueueDepth": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DiskQueueDepth" - } - }, - "FreeStorageSpace": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FreeStorageSpace" - } - }, - "NetworkReceiveThroughput": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NetworkReceiveThroughput" - } - }, - "NetworkTransmitThroughput": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NetworkTransmitThroughput" - } - } - } - }, - "com.amazonaws.lightsail#RelationalDatabaseParameter": { - "type": "structure", - "members": { - "allowedValues": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

Specifies the valid range of values for the parameter.

" - } - }, - "applyMethod": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

Indicates when parameter updates are applied.

\n

Can be immediate or pending-reboot.

" - } - }, - "applyType": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

Specifies the engine-specific parameter type.

" - } - }, - "dataType": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

Specifies the valid data type for the parameter.

" - } - }, - "description": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

Provides a description of the parameter.

" - } - }, - "isModifiable": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the parameter can be modified.

" - } - }, - "parameterName": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

Specifies the name of the parameter.

" - } - }, - "parameterValue": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

Specifies the value of the parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the parameters of a database.

" - } - }, - "com.amazonaws.lightsail#RelationalDatabaseParameterList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#RelationalDatabaseParameter" - } - }, - "com.amazonaws.lightsail#RelationalDatabasePasswordVersion": { - "type": "enum", - "members": { - "CURRENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CURRENT" - } - }, - "PREVIOUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PREVIOUS" - } - }, - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - } - } - }, - "com.amazonaws.lightsail#RelationalDatabaseSnapshot": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the database snapshot.

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database snapshot.

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The support code for the database snapshot. Include this code in your email to support\n when you have questions about a database snapshot in Lightsail. This code enables our\n support team to look up your Lightsail information more easily.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the database snapshot was created.

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

The Region name and Availability Zone where the database snapshot is located.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "engine": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The software of the database snapshot (for example, MySQL)

" - } - }, - "engineVersion": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The database engine version for the database snapshot (for example,\n 5.7.23).

" - } - }, - "sizeInGb": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The size of the disk in GB (for example, 32) for the database\n snapshot.

" - } - }, - "state": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The state of the database snapshot.

" - } - }, - "fromRelationalDatabaseName": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the source database from which the database snapshot was created.

" - } - }, - "fromRelationalDatabaseArn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database from which the database snapshot was\n created.

" - } - }, - "fromRelationalDatabaseBundleId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The bundle ID of the database from which the database snapshot was created.

" - } - }, - "fromRelationalDatabaseBlueprintId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The blueprint ID of the database from which the database snapshot was created. A blueprint\n describes the major engine version of a database.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a database snapshot.

" - } - }, - "com.amazonaws.lightsail#RelationalDatabaseSnapshotList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#RelationalDatabaseSnapshot" - } - }, - "com.amazonaws.lightsail#ReleaseStaticIp": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#ReleaseStaticIpRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#ReleaseStaticIpResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a specific static IP from your account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/ReleaseStaticIp", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#ReleaseStaticIpRequest": { - "type": "structure", - "members": { - "staticIpName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the static IP to delete.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#ReleaseStaticIpResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#RenewalStatus": { - "type": "enum", - "members": { - "PendingAutoRenewal": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PendingAutoRenewal" - } - }, - "PendingValidation": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PendingValidation" - } - }, - "Success": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Success" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - } - } - }, - "com.amazonaws.lightsail#RenewalStatusReason": { - "type": "string" - }, - "com.amazonaws.lightsail#RenewalSummary": { - "type": "structure", - "members": { - "domainValidationRecords": { - "target": "com.amazonaws.lightsail#DomainValidationRecordList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the domain validation records of the certificate.

" - } - }, - "renewalStatus": { - "target": "com.amazonaws.lightsail#RenewalStatus", - "traits": { - "smithy.api#documentation": "

The renewal status of the certificate.

\n

The following renewal status are possible:

\n " - } - }, - "renewalStatusReason": { - "target": "com.amazonaws.lightsail#RenewalStatusReason", - "traits": { - "smithy.api#documentation": "

The reason for the renewal status of the certificate.

" - } - }, - "updatedAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the certificate was last updated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the status of a SSL/TLS certificate renewal managed by Amazon Lightsail.

" - } - }, - "com.amazonaws.lightsail#RequestFailureReason": { - "type": "string" - }, - "com.amazonaws.lightsail#ResetDistributionCache": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#ResetDistributionCacheRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#ResetDistributionCacheResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes currently cached content from your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

After resetting the cache, the next time a content request is made, your distribution\n pulls, serves, and caches it from the origin.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/ResetDistributionCache", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#ResetDistributionCacheRequest": { - "type": "structure", - "members": { - "distributionName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the distribution for which to reset cache.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

" - } - } - } - }, - "com.amazonaws.lightsail#ResetDistributionCacheResult": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The status of the reset cache request.

" - } - }, - "createTime": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp of the reset cache request (e.g., 1479734909.17) in Unix time\n format.

" - } - }, - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#ResourceArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:(aws[^:]*):([a-zA-Z0-9-]+):([a-z0-9-]+):([0-9]+):([a-zA-Z]+)/([a-zA-Z0-9-]+)$" - } - }, - "com.amazonaws.lightsail#ResourceBucketAccess": { - "type": "enum", - "members": { - "Allow": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "allow" - } - }, - "Deny": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deny" - } - } - } - }, - "com.amazonaws.lightsail#ResourceLocation": { - "type": "structure", - "members": { - "availabilityZone": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The Availability Zone. Follows the format us-east-2a (case-sensitive).

" - } - }, - "regionName": { - "target": "com.amazonaws.lightsail#RegionName", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region name.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the resource location.

" - } - }, - "com.amazonaws.lightsail#ResourceName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^\\w[\\w\\-]*\\w$" - } - }, - "com.amazonaws.lightsail#ResourceNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#ResourceName" - } - }, - "com.amazonaws.lightsail#ResourceReceivingAccess": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the Lightsail instance.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Lightsail resource type (for example, Instance).

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Amazon Lightsail instance that has access to a Lightsail bucket.

" - } - }, - "com.amazonaws.lightsail#ResourceRecord": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The name of the record.

" - } - }, - "type": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The DNS record type.

" - } - }, - "value": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The value for the DNS record.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the domain name system (DNS) records to add to your domain's DNS to validate it\n for an Amazon Lightsail certificate.

" - } - }, - "com.amazonaws.lightsail#ResourceType": { - "type": "enum", - "members": { - "ContainerService": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ContainerService" - } - }, - "Instance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Instance" - } - }, - "StaticIp": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StaticIp" - } - }, - "KeyPair": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KeyPair" - } - }, - "InstanceSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InstanceSnapshot" - } - }, - "Domain": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Domain" - } - }, - "PeeredVpc": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PeeredVpc" - } - }, - "LoadBalancer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LoadBalancer" - } - }, - "LoadBalancerTlsCertificate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LoadBalancerTlsCertificate" - } - }, - "Disk": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Disk" - } - }, - "DiskSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DiskSnapshot" - } - }, - "RelationalDatabase": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RelationalDatabase" - } - }, - "RelationalDatabaseSnapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RelationalDatabaseSnapshot" - } - }, - "ExportSnapshotRecord": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ExportSnapshotRecord" - } - }, - "CloudFormationStackRecord": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CloudFormationStackRecord" - } - }, - "Alarm": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Alarm" - } - }, - "ContactMethod": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ContactMethod" - } - }, - "Distribution": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Distribution" - } - }, - "Certificate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Certificate" - } - }, - "Bucket": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Bucket" - } - } - } - }, - "com.amazonaws.lightsail#RevocationReason": { - "type": "string" - }, - "com.amazonaws.lightsail#SendContactMethodVerification": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#SendContactMethodVerificationRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#SendContactMethodVerificationResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Sends a verification request to an email contact method to ensure it's owned by the\n requester. SMS contact methods don't need to be verified.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services\n Regions, and SMS text messages cannot be sent to some countries/regions. For more information,\n see Notifications in Amazon Lightsail.

\n

A verification request is sent to the contact method when you initially create it. Use\n this action to send another verification request if a previous verification request was\n deleted, or has expired.

\n \n

Notifications are not sent to an email contact method until after it is verified, and\n confirmed as valid.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/SendContactMethodVerification", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#SendContactMethodVerificationRequest": { - "type": "structure", - "members": { - "protocol": { - "target": "com.amazonaws.lightsail#ContactMethodVerificationProtocol", - "traits": { - "smithy.api#documentation": "

The protocol to verify, such as Email or SMS (text\n messaging).

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#SendContactMethodVerificationResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#SensitiveString": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.lightsail#SerialNumber": { - "type": "string" - }, - "com.amazonaws.lightsail#ServiceException": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#UpdateInstanceMetadataOptionsRequest": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the instance for which to update metadata parameters.

", + "smithy.api#required": {} + } + }, + "httpTokens": { + "target": "com.amazonaws.lightsail#HttpTokens", + "traits": { + "smithy.api#documentation": "

The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.

\n

If the state is optional, you can choose whether to retrieve instance\n metadata with a signed token header on your request. If you retrieve the IAM role credentials\n without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role\n credentials by using a valid signed token, the version 2.0 role credentials are\n returned.

\n

If the state is required, you must send a signed token header with all\n instance metadata retrieval requests. In this state, retrieving the IAM role credential always\n returns the version 2.0 credentials. The version 1.0 credentials are not available.

" + } + }, + "httpEndpoint": { + "target": "com.amazonaws.lightsail#HttpEndpoint", + "traits": { + "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not\n specified, the existing state is maintained.

\n

If you specify a value of disabled, you cannot access your instance\n metadata.

" + } + }, + "httpPutResponseHopLimit": { + "target": "com.amazonaws.lightsail#integer", + "traits": { + "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. A larger number\n means that the instance metadata requests can travel farther. If no parameter is specified,\n the existing state is maintained.

" + } + }, + "httpProtocolIpv6": { + "target": "com.amazonaws.lightsail#HttpProtocolIpv6", + "traits": { + "smithy.api#documentation": "

Enables or disables the IPv6 endpoint for the instance metadata service. This setting\n applies only when the HTTP metadata endpoint is enabled.

\n \n

This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region (eu-north-1).

\n " + } + } + } + }, + "com.amazonaws.lightsail#UpdateInstanceMetadataOptionsResult": { + "type": "structure", + "members": { + "operation": { + "target": "com.amazonaws.lightsail#Operation" + } + } + }, + "com.amazonaws.lightsail#UpdateLoadBalancerAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#UpdateLoadBalancerAttributeRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#UpdateLoadBalancerAttributeResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the specified attribute for a load balancer. You can only update one attribute at\n a time.

\n

The update load balancer attribute operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/UpdateLoadBalancerAttribute", + "code": 200 + } + } }, - "docs": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#UpdateLoadBalancerAttributeRequest": { + "type": "structure", + "members": { + "loadBalancerName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the load balancer that you want to modify (e.g.,\n my-load-balancer.

", + "smithy.api#required": {} + } + }, + "attributeName": { + "target": "com.amazonaws.lightsail#LoadBalancerAttributeName", + "traits": { + "smithy.api#documentation": "

The name of the attribute you want to update.

", + "smithy.api#required": {} + } + }, + "attributeValue": { + "target": "com.amazonaws.lightsail#StringMax256", + "traits": { + "smithy.api#documentation": "

The value that you want to specify for the attribute name.

\n

The following values are supported depending on what you specify for the\n attributeName request parameter:

\n ", + "smithy.api#required": {} + } + } + } }, - "message": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#UpdateLoadBalancerAttributeResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } }, - "tip": { - "target": "com.amazonaws.lightsail#string" - } - }, - "traits": { - "smithy.api#documentation": "

A general service exception.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.lightsail#SetIpAddressType": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#SetIpAddressTypeRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#SetIpAddressTypeResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Sets the IP address type for an Amazon Lightsail resource.

\n\n

Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the\n specified resource. Alternately, you can use this action to disable dual-stack, and enable\n IPv4 only.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/SetIpAddressType", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#SetIpAddressTypeRequest": { - "type": "structure", - "members": { - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The resource type.

\n

The possible values are Distribution, Instance, and\n LoadBalancer.

\n \n

Distribution-related APIs are available only in the N. Virginia (us-east-1)\n Amazon Web Services Region. Set your Amazon Web Services Region configuration to\n us-east-1 to create, view, or edit distributions.

\n ", - "smithy.api#required": {} - } - }, - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the resource for which to set the IP address type.

", - "smithy.api#required": {} - } - }, - "ipAddressType": { - "target": "com.amazonaws.lightsail#IpAddressType", - "traits": { - "smithy.api#documentation": "

The IP address type to set for the specified resource.

\n\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#SetIpAddressTypeResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#SetResourceAccessForBucket": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#SetResourceAccessForBucketRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#SetResourceAccessForBucketResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Sets the Amazon Lightsail resources that can access the specified Lightsail\n bucket.

\n\n

Lightsail buckets currently support setting access for Lightsail instances in the same\n Amazon Web Services Region.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/SetResourceAccessForBucket", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#SetResourceAccessForBucketRequest": { - "type": "structure", - "members": { - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the Lightsail instance for which to set bucket access. The instance must be\n in a running or stopped state.

", - "smithy.api#required": {} - } - }, - "bucketName": { - "target": "com.amazonaws.lightsail#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket for which to set access to another Lightsail resource.

", - "smithy.api#required": {} - } - }, - "access": { - "target": "com.amazonaws.lightsail#ResourceBucketAccess", - "traits": { - "smithy.api#documentation": "

The access setting.

\n\n

The following access settings are available:

\n\n ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#SetResourceAccessForBucketResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#StartInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#StartInstanceRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#StartInstanceResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance,\n use the reboot instance operation.

\n \n

When you start a stopped instance, Lightsail assigns a new public IP address to the\n instance. To use the same IP address after stopping and starting an instance, create a\n static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.

\n \n

The start instance operation supports tag-based access control via resource\n tags applied to the resource identified by instance name. For more information,\n see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/StartInstance", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#StartInstanceRequest": { - "type": "structure", - "members": { - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance (a virtual private server) to start.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#StartInstanceResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#StartRelationalDatabase": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#StartRelationalDatabaseRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#StartRelationalDatabaseResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts a specific database from a stopped state in Amazon Lightsail. To restart a database,\n use the reboot relational database operation.

\n

The start relational database operation supports tag-based access control via\n resource tags applied to the resource identified by relationalDatabaseName. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/StartRelationalDatabase", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#StartRelationalDatabaseRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your database to start.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#StartRelationalDatabaseResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#StaticIp": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE).

" - } - }, - "arn": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the static IP (e.g.,\n arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE).

" - } - }, - "supportCode": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" - } - }, - "createdAt": { - "target": "com.amazonaws.lightsail#IsoDate", - "traits": { - "smithy.api#documentation": "

The timestamp when the static IP was created (e.g., 1479735304.222).

" - } - }, - "location": { - "target": "com.amazonaws.lightsail#ResourceLocation", - "traits": { - "smithy.api#documentation": "

The region and Availability Zone where the static IP was created.

" - } - }, - "resourceType": { - "target": "com.amazonaws.lightsail#ResourceType", - "traits": { - "smithy.api#documentation": "

The resource type (usually StaticIp).

" - } - }, - "ipAddress": { - "target": "com.amazonaws.lightsail#IpAddress", - "traits": { - "smithy.api#documentation": "

The static IP address.

" - } - }, - "attachedTo": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The instance where the static IP is attached (e.g.,\n Amazon_Linux-1GB-Ohio-1).

" - } - }, - "isAttached": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value indicating whether the static IP is attached.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a static IP.

" - } - }, - "com.amazonaws.lightsail#StaticIpList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#StaticIp" - } - }, - "com.amazonaws.lightsail#StatusType": { - "type": "enum", - "members": { - "Active": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Active" - } - }, - "Inactive": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Inactive" - } - } - } - }, - "com.amazonaws.lightsail#StopInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#StopInstanceRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#StopInstanceResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Stops a specific Amazon Lightsail instance that is currently running.

\n \n

When you start a stopped instance, Lightsail assigns a new public IP address to the\n instance. To use the same IP address after stopping and starting an instance, create a\n static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.

\n \n

The stop instance operation supports tag-based access control via resource\n tags applied to the resource identified by instance name. For more information,\n see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/StopInstance", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#StopInstanceRequest": { - "type": "structure", - "members": { - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance (a virtual private server) to stop.

", - "smithy.api#required": {} - } - }, - "force": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

When set to True, forces a Lightsail instance that is stuck in a\n stopping state to stop.

\n \n

Only use the force parameter if your instance is stuck in the\n stopping state. In any other state, your instance should stop normally\n without adding this parameter to your API request.

\n " - } - } - } - }, - "com.amazonaws.lightsail#StopInstanceResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#StopRelationalDatabase": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#StopRelationalDatabaseRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#StopRelationalDatabaseResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Stops a specific database that is currently running in Amazon Lightsail.

\n

The stop relational database operation supports tag-based access control via\n resource tags applied to the resource identified by relationalDatabaseName. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/StopRelationalDatabase", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#StopRelationalDatabaseRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your database to stop.

", - "smithy.api#required": {} - } - }, - "relationalDatabaseSnapshotName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your new database snapshot to be created before stopping your database.

" - } - } - } - }, - "com.amazonaws.lightsail#StopRelationalDatabaseResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#StringList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#string" - } - }, - "com.amazonaws.lightsail#StringMax256": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.lightsail#SubjectAlternativeNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#DomainName" - } - }, - "com.amazonaws.lightsail#Tag": { - "type": "structure", - "members": { - "key": { - "target": "com.amazonaws.lightsail#TagKey", - "traits": { - "smithy.api#documentation": "

The key of the tag.

\n

Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the\n following characters: + - = . _ : / @

" - } - }, - "value": { - "target": "com.amazonaws.lightsail#TagValue", - "traits": { - "smithy.api#documentation": "

The value of the tag.

\n

Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the\n following characters: + - = . _ : / @

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

\n

For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

" - } - }, - "com.amazonaws.lightsail#TagKey": { - "type": "string" - }, - "com.amazonaws.lightsail#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#TagKey" - } - }, - "com.amazonaws.lightsail#TagList": { - "type": "list", - "member": { - "target": "com.amazonaws.lightsail#Tag" - } - }, - "com.amazonaws.lightsail#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#TagResourceResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a\n maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique\n per resource. For more information about tags, see the Amazon Lightsail Developer Guide.

\n

The tag resource operation supports tag-based access control via request tags\n and resource tags applied to the resource identified by resource name. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/TagResource", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#TagResourceRequest": { - "type": "structure", - "members": { - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the resource to which you are adding tags.

", - "smithy.api#required": {} - } - }, - "resourceArn": { - "target": "com.amazonaws.lightsail#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to which you want to add a tag.

" - } - }, - "tags": { - "target": "com.amazonaws.lightsail#TagList", - "traits": { - "smithy.api#documentation": "

The tag key and optional value.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#TagResourceResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#TagValue": { - "type": "string" - }, - "com.amazonaws.lightsail#TestAlarm": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#TestAlarmRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#TestAlarmResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification\n trigger is configured for the specified alarm, the test also sends a notification to the\n notification protocol (Email and/or SMS) configured for the\n alarm.

\n

An alarm is used to monitor a single metric for one of your resources. When a metric\n condition is met, the alarm can notify you by email, SMS text message, and a banner displayed\n on the Amazon Lightsail console. For more information, see Alarms\n in Amazon Lightsail.

", - "smithy.api#http": { - "method": "GET", - "uri": "/ls/api/2016-11-28/TestAlarm", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#TestAlarmRequest": { - "type": "structure", - "members": { - "alarmName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the alarm to test.

", - "smithy.api#required": {} - } - }, - "state": { - "target": "com.amazonaws.lightsail#AlarmState", - "traits": { - "smithy.api#documentation": "

The alarm state to test.

\n

An alarm has the following possible states that can be tested:

\n ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#TestAlarmResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#TimeOfDay": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$" - } - }, - "com.amazonaws.lightsail#TreatMissingData": { - "type": "enum", - "members": { - "Breaching": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "breaching" - } - }, - "NotBreaching": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "notBreaching" - } - }, - "Ignore": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ignore" - } - }, - "Missing": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "missing" - } - } - } - }, - "com.amazonaws.lightsail#UnauthenticatedException": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#UpdateRelationalDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#UpdateRelationalDatabaseRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#UpdateRelationalDatabaseResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Allows the update of one or more attributes of a database in Amazon Lightsail.

\n

Updates are applied immediately, or in cases where the updates could result in an outage,\n are applied during the database's predefined maintenance window.

\n

The update relational database operation supports tag-based access control\n via resource tags applied to the resource identified by relationalDatabaseName. For more\n information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/UpdateRelationalDatabase", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#UpdateRelationalDatabaseParameters": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#UpdateRelationalDatabaseParametersRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#UpdateRelationalDatabaseParametersResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#NotFoundException" + }, + { + "target": "com.amazonaws.lightsail#OperationFailureException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Allows the update of one or more parameters of a database in Amazon Lightsail.

\n

Parameter updates don't cause outages; therefore, their application is not subject to the\n preferred maintenance window. However, there are two ways in which parameter updates are\n applied: dynamic or pending-reboot. Parameters marked with a\n dynamic apply type are applied immediately. Parameters marked with a\n pending-reboot apply type are applied only after the database is rebooted using\n the reboot relational database operation.

\n

The update relational database parameters operation supports tag-based access\n control via resource tags applied to the resource identified by relationalDatabaseName. For\n more information, see the Amazon Lightsail Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/UpdateRelationalDatabaseParameters", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#UpdateRelationalDatabaseParametersRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your database for which to update parameters.

", + "smithy.api#required": {} + } + }, + "parameters": { + "target": "com.amazonaws.lightsail#RelationalDatabaseParameterList", + "traits": { + "smithy.api#documentation": "

The database parameters to update.

", + "smithy.api#required": {} + } + } + } }, - "docs": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#UpdateRelationalDatabaseParametersResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } }, - "message": { - "target": "com.amazonaws.lightsail#string" + "com.amazonaws.lightsail#UpdateRelationalDatabaseRequest": { + "type": "structure", + "members": { + "relationalDatabaseName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of your Lightsail database resource to update.

", + "smithy.api#required": {} + } + }, + "masterUserPassword": { + "target": "com.amazonaws.lightsail#SensitiveString", + "traits": { + "smithy.api#documentation": "

The password for the master user. The password can include any printable ASCII character\n except \"/\", \"\"\", or \"@\".

\n

MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

" + } + }, + "rotateMasterUserPassword": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

When true, the master user password is changed to a new strong password\n generated by Lightsail.

\n

Use the get relational database master user password operation to get the new\n password.

" + } + }, + "preferredBackupWindow": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are created for your database if\n automated backups are enabled.

\n

Constraints:

\n " + } + }, + "preferredMaintenanceWindow": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur on your database.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n Amazon Web Services Region, occurring on a random day of the week.

\n

Constraints:

\n " + } + }, + "enableBackupRetention": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

When true, enables automated backup retention for your database.

\n

Updates are applied during the next maintenance window because this can result in an\n outage.

" + } + }, + "disableBackupRetention": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

When true, disables automated backup retention for your database.

\n

Disabling backup retention deletes all automated database backups. Before disabling this,\n you may want to create a snapshot of your database using the create relational database\n snapshot operation.

\n

Updates are applied during the next maintenance window because this can result in an\n outage.

" + } + }, + "publiclyAccessible": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

Specifies the accessibility options for your database. A value of true\n specifies a database that is available to resources outside of your Lightsail account. A\n value of false specifies a database that is available only to your Lightsail\n resources in the same region as your database.

" + } + }, + "applyImmediately": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

When true, applies changes immediately. When false, applies\n changes during the preferred maintenance window. Some changes may cause an outage.

\n

Default: false\n

" + } + }, + "caCertificateIdentifier": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

Indicates the certificate that needs to be associated with the database.

" + } + } + } }, - "tip": { - "target": "com.amazonaws.lightsail#string" - } - }, - "traits": { - "smithy.api#documentation": "

Lightsail throws this exception when the user has not been authenticated.

", - "smithy.api#error": "client", - "smithy.api#httpError": 401 - } - }, - "com.amazonaws.lightsail#UnpeerVpc": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#UnpeerVpcRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#UnpeerVpcResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Unpeers the Lightsail VPC from the user's default VPC.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/UnpeerVpc", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#UnpeerVpcRequest": { - "type": "structure", - "members": {} - }, - "com.amazonaws.lightsail#UnpeerVpcResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#UntagResourceResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified set of tag keys and their values from the specified Amazon Lightsail\n resource.

\n

The untag resource operation supports tag-based access control via request\n tags and resource tags applied to the resource identified by resource name. For\n more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/UntagResource", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#UntagResourceRequest": { - "type": "structure", - "members": { - "resourceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the resource from which you are removing a tag.

", - "smithy.api#required": {} - } - }, - "resourceArn": { - "target": "com.amazonaws.lightsail#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource from which you want to remove a tag.

" - } - }, - "tagKeys": { - "target": "com.amazonaws.lightsail#TagKeyList", - "traits": { - "smithy.api#documentation": "

The tag keys to delete from the specified resource.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#UntagResourceResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#UpdateBucket": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#UpdateBucketRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#UpdateBucketResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an existing Amazon Lightsail bucket.

\n\n

Use this action to update the configuration of an existing bucket, such as versioning,\n public accessibility, and the Amazon Web Services accounts that can access the bucket.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/UpdateBucket", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#UpdateBucketBundle": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#UpdateBucketBundleRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#UpdateBucketBundleResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.

\n\n

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\n bucket. You can update a bucket's bundle only one time within a monthly Amazon Web Services\n billing cycle. To determine if you can update a bucket's bundle, use the GetBuckets action. The\n ableToUpdateBundle parameter in the response will indicate whether you can\n currently update a bucket's bundle.

\n\n

Update a bucket's bundle if it's consistently going over its storage space or data\n transfer quota, or if a bucket's usage is consistently in the lower range of its storage space\n or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might\n experience, we strongly recommend that you update a bucket's bundle only as a long-term\n strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle\n that will provide the bucket with ample storage space and data transfer for a long time to\n come.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/UpdateBucketBundle", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#UpdateBucketBundleRequest": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.lightsail#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket for which to update the bundle.

", - "smithy.api#required": {} - } - }, - "bundleId": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the new bundle to apply to the bucket.

\n\n

Use the GetBucketBundles action to get a list of\n bundle IDs that you can specify.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#UpdateBucketBundleResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#UpdateBucketRequest": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.lightsail#BucketName", - "traits": { - "smithy.api#documentation": "

The name of the bucket to update.

", - "smithy.api#required": {} - } - }, - "accessRules": { - "target": "com.amazonaws.lightsail#AccessRules", - "traits": { - "smithy.api#documentation": "

An object that sets the public accessibility of objects in the specified bucket.

" - } - }, - "versioning": { - "target": "com.amazonaws.lightsail#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Specifies whether to enable or suspend versioning of objects in the bucket.

\n\n

The following options can be specified:

\n " - } - }, - "readonlyAccessAccounts": { - "target": "com.amazonaws.lightsail#PartnerIdList", - "traits": { - "smithy.api#documentation": "

An array of strings to specify the Amazon Web Services account IDs that can access the\n bucket.

\n\n

You can give a maximum of 10 Amazon Web Services accounts access to a bucket.

" - } - }, - "accessLogConfig": { - "target": "com.amazonaws.lightsail#BucketAccessLogConfig", - "traits": { - "smithy.api#documentation": "

An object that describes the access log configuration for the bucket.

" - } - } - } - }, - "com.amazonaws.lightsail#UpdateBucketResult": { - "type": "structure", - "members": { - "bucket": { - "target": "com.amazonaws.lightsail#Bucket", - "traits": { - "smithy.api#documentation": "

An object that describes the bucket that is updated.

" - } - }, - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#UpdateContainerService": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#UpdateContainerServiceRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#UpdateContainerServiceResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the configuration of your Amazon Lightsail container service, such as its power,\n scale, and public domain names.

", - "smithy.api#http": { - "method": "PATCH", - "uri": "/ls/api/2016-11-28/container-services/{serviceName}", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#UpdateContainerServiceRequest": { - "type": "structure", - "members": { - "serviceName": { - "target": "com.amazonaws.lightsail#ContainerServiceName", - "traits": { - "smithy.api#documentation": "

The name of the container service to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "power": { - "target": "com.amazonaws.lightsail#ContainerServicePowerName", - "traits": { - "smithy.api#documentation": "

The power for the container service.

\n\n

The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the\n container service. The power and scale of a container service makes\n up its configured capacity. To determine the monthly price of your container service, multiply\n the base price of the power with the scale (the number of nodes) of\n the service.

\n\n

Use the GetContainerServicePowers action to view the specifications of each\n power option.

" - } - }, - "scale": { - "target": "com.amazonaws.lightsail#ContainerServiceScale", - "traits": { - "smithy.api#documentation": "

The scale for the container service.

\n\n

The scale specifies the allocated compute nodes of the container service. The\n power and scale of a container service makes up its configured\n capacity. To determine the monthly price of your container service, multiply the base price of\n the power with the scale (the number of nodes) of the\n service.

" - } - }, - "isDisabled": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

A Boolean value to indicate whether the container service is disabled.

" - } - }, - "publicDomainNames": { - "target": "com.amazonaws.lightsail#ContainerServicePublicDomains", - "traits": { - "smithy.api#documentation": "

The public domain names to use with the container service, such as\n example.com and www.example.com.

\n\n

You can specify up to four public domain names for a container service. The domain names\n that you specify are used when you create a deployment with a container configured as the\n public endpoint of your container service.

\n\n

If you don't specify public domain names, then you can use the default domain of the\n container service.

\n\n \n

You must create and validate an SSL/TLS certificate before you can use public domain\n names with your container service. Use the CreateCertificate action to create a\n certificate for the public domain names you want to use with your container service.

\n \n\n

You can specify public domain names using a string to array map as shown in the example\n later on this page.

" - } - }, - "privateRegistryAccess": { - "target": "com.amazonaws.lightsail#PrivateRegistryAccessRequest", - "traits": { - "smithy.api#documentation": "

An object to describe the configuration for the container service to access private\n container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private\n repositories.

\n\n

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" - } - } - } - }, - "com.amazonaws.lightsail#UpdateContainerServiceResult": { - "type": "structure", - "members": { - "containerService": { - "target": "com.amazonaws.lightsail#ContainerService", - "traits": { - "smithy.api#documentation": "

An object that describes a container service.

" - } - } - } - }, - "com.amazonaws.lightsail#UpdateDistribution": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#UpdateDistributionRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#UpdateDistributionResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an existing Amazon Lightsail content delivery network (CDN) distribution.

\n

Use this action to update the configuration of your existing distribution.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/UpdateDistribution", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#UpdateDistributionBundle": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#UpdateDistributionBundleRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#UpdateDistributionBundleResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the bundle of your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

A distribution bundle specifies the monthly network transfer quota and monthly cost of\n your distribution.

\n

Update your distribution's bundle if your distribution is going over its monthly network\n transfer quota and is incurring an overage fee.

\n

You can update your distribution's bundle only one time within your monthly Amazon Web Services billing cycle. To determine if you can update your distribution's bundle, use the\n GetDistributions action. The ableToUpdateBundle parameter in the\n result will indicate whether you can currently update your distribution's bundle.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/UpdateDistributionBundle", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#UpdateDistributionBundleRequest": { - "type": "structure", - "members": { - "distributionName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the distribution for which to update the bundle.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

" - } - }, - "bundleId": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The bundle ID of the new bundle to apply to your distribution.

\n

Use the GetDistributionBundles action to get a list of distribution bundle\n IDs that you can specify.

" - } - } - } - }, - "com.amazonaws.lightsail#UpdateDistributionBundleResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#UpdateDistributionRequest": { - "type": "structure", - "members": { - "distributionName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the distribution to update.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

", - "smithy.api#required": {} - } - }, - "origin": { - "target": "com.amazonaws.lightsail#InputOrigin", - "traits": { - "smithy.api#documentation": "

An object that describes the origin resource for the distribution, such as a Lightsail\n instance, bucket, or load balancer.

\n

The distribution pulls, caches, and serves content from the origin.

" - } - }, - "defaultCacheBehavior": { - "target": "com.amazonaws.lightsail#CacheBehavior", - "traits": { - "smithy.api#documentation": "

An object that describes the default cache behavior for the distribution.

" - } - }, - "cacheBehaviorSettings": { - "target": "com.amazonaws.lightsail#CacheSettings", - "traits": { - "smithy.api#documentation": "

An object that describes the cache behavior settings for the distribution.

\n \n

The cacheBehaviorSettings specified in your\n UpdateDistributionRequest will replace your distribution's existing\n settings.

\n " - } - }, - "cacheBehaviors": { - "target": "com.amazonaws.lightsail#CacheBehaviorList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the per-path cache behavior for the distribution.

" - } - }, - "isEnabled": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether to enable the distribution.

" - } - } - } - }, - "com.amazonaws.lightsail#UpdateDistributionResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#UpdateDomainEntry": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#UpdateDomainEntryRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#UpdateDomainEntryResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a domain recordset after it is created.

\n

The update domain entry operation supports tag-based access control via\n resource tags applied to the resource identified by domain name. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/UpdateDomainEntry", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#UpdateDomainEntryRequest": { - "type": "structure", - "members": { - "domainName": { - "target": "com.amazonaws.lightsail#DomainName", - "traits": { - "smithy.api#documentation": "

The name of the domain recordset to update.

", - "smithy.api#required": {} - } - }, - "domainEntry": { - "target": "com.amazonaws.lightsail#DomainEntry", - "traits": { - "smithy.api#documentation": "

An array of key-value pairs containing information about the domain entry.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#UpdateDomainEntryResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#UpdateInstanceMetadataOptions": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#UpdateInstanceMetadataOptionsRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#UpdateInstanceMetadataOptionsResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies the Amazon Lightsail instance metadata parameters on a running or stopped\n instance. When you modify the parameters on a running instance, the GetInstance\n or GetInstances API operation initially responds with a state of\n pending. After the parameter modifications are successfully applied, the state\n changes to applied in subsequent GetInstance or\n GetInstances API calls. For more information, see Use IMDSv2 with an Amazon Lightsail instance in the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/UpdateInstanceMetadataOptions", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#UpdateInstanceMetadataOptionsRequest": { - "type": "structure", - "members": { - "instanceName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the instance for which to update metadata parameters.

", - "smithy.api#required": {} - } - }, - "httpTokens": { - "target": "com.amazonaws.lightsail#HttpTokens", - "traits": { - "smithy.api#documentation": "

The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.

\n\n

If the state is optional, you can choose whether to retrieve instance\n metadata with a signed token header on your request. If you retrieve the IAM role credentials\n without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role\n credentials by using a valid signed token, the version 2.0 role credentials are\n returned.

\n\n

If the state is required, you must send a signed token header with all\n instance metadata retrieval requests. In this state, retrieving the IAM role credential always\n returns the version 2.0 credentials. The version 1.0 credentials are not available.

" - } - }, - "httpEndpoint": { - "target": "com.amazonaws.lightsail#HttpEndpoint", - "traits": { - "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not\n specified, the existing state is maintained.

\n\n

If you specify a value of disabled, you cannot access your instance\n metadata.

" - } - }, - "httpPutResponseHopLimit": { - "target": "com.amazonaws.lightsail#integer", - "traits": { - "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. A larger number\n means that the instance metadata requests can travel farther. If no parameter is specified,\n the existing state is maintained.

" - } - }, - "httpProtocolIpv6": { - "target": "com.amazonaws.lightsail#HttpProtocolIpv6", - "traits": { - "smithy.api#documentation": "

Enables or disables the IPv6 endpoint for the instance metadata service. This setting\n applies only when the HTTP metadata endpoint is enabled.

\n\n \n

This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region (eu-north-1).

\n " - } - } - } - }, - "com.amazonaws.lightsail#UpdateInstanceMetadataOptionsResult": { - "type": "structure", - "members": { - "operation": { - "target": "com.amazonaws.lightsail#Operation" - } - } - }, - "com.amazonaws.lightsail#UpdateLoadBalancerAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#UpdateLoadBalancerAttributeRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#UpdateLoadBalancerAttributeResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the specified attribute for a load balancer. You can only update one attribute at\n a time.

\n

The update load balancer attribute operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/UpdateLoadBalancerAttribute", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#UpdateLoadBalancerAttributeRequest": { - "type": "structure", - "members": { - "loadBalancerName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the load balancer that you want to modify (e.g.,\n my-load-balancer.

", - "smithy.api#required": {} - } - }, - "attributeName": { - "target": "com.amazonaws.lightsail#LoadBalancerAttributeName", - "traits": { - "smithy.api#documentation": "

The name of the attribute you want to update.

", - "smithy.api#required": {} - } - }, - "attributeValue": { - "target": "com.amazonaws.lightsail#StringMax256", - "traits": { - "smithy.api#documentation": "

The value that you want to specify for the attribute name.

\n

The following values are supported depending on what you specify for the\n attributeName request parameter:

\n ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#UpdateLoadBalancerAttributeResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#UpdateRelationalDatabase": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#UpdateRelationalDatabaseRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#UpdateRelationalDatabaseResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Allows the update of one or more attributes of a database in Amazon Lightsail.

\n

Updates are applied immediately, or in cases where the updates could result in an outage,\n are applied during the database's predefined maintenance window.

\n

The update relational database operation supports tag-based access control\n via resource tags applied to the resource identified by relationalDatabaseName. For more\n information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/UpdateRelationalDatabase", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#UpdateRelationalDatabaseParameters": { - "type": "operation", - "input": { - "target": "com.amazonaws.lightsail#UpdateRelationalDatabaseParametersRequest" - }, - "output": { - "target": "com.amazonaws.lightsail#UpdateRelationalDatabaseParametersResult" - }, - "errors": [ - { - "target": "com.amazonaws.lightsail#AccessDeniedException" - }, - { - "target": "com.amazonaws.lightsail#AccountSetupInProgressException" - }, - { - "target": "com.amazonaws.lightsail#InvalidInputException" - }, - { - "target": "com.amazonaws.lightsail#NotFoundException" - }, - { - "target": "com.amazonaws.lightsail#OperationFailureException" - }, - { - "target": "com.amazonaws.lightsail#ServiceException" - }, - { - "target": "com.amazonaws.lightsail#UnauthenticatedException" - } - ], - "traits": { - "smithy.api#documentation": "

Allows the update of one or more parameters of a database in Amazon Lightsail.

\n

Parameter updates don't cause outages; therefore, their application is not subject to the\n preferred maintenance window. However, there are two ways in which parameter updates are\n applied: dynamic or pending-reboot. Parameters marked with a\n dynamic apply type are applied immediately. Parameters marked with a\n pending-reboot apply type are applied only after the database is rebooted using\n the reboot relational database operation.

\n

The update relational database parameters operation supports tag-based access\n control via resource tags applied to the resource identified by relationalDatabaseName. For\n more information, see the Amazon Lightsail Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ls/api/2016-11-28/UpdateRelationalDatabaseParameters", - "code": 200 - } - } - }, - "com.amazonaws.lightsail#UpdateRelationalDatabaseParametersRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your database for which to update parameters.

", - "smithy.api#required": {} - } - }, - "parameters": { - "target": "com.amazonaws.lightsail#RelationalDatabaseParameterList", - "traits": { - "smithy.api#documentation": "

The database parameters to update.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.lightsail#UpdateRelationalDatabaseParametersResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } - } - } - }, - "com.amazonaws.lightsail#UpdateRelationalDatabaseRequest": { - "type": "structure", - "members": { - "relationalDatabaseName": { - "target": "com.amazonaws.lightsail#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of your Lightsail database resource to update.

", - "smithy.api#required": {} - } - }, - "masterUserPassword": { - "target": "com.amazonaws.lightsail#SensitiveString", - "traits": { - "smithy.api#documentation": "

The password for the master user. The password can include any printable ASCII character\n except \"/\", \"\"\", or \"@\".

\n

MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

" - } - }, - "rotateMasterUserPassword": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

When true, the master user password is changed to a new strong password\n generated by Lightsail.

\n

Use the get relational database master user password operation to get the new\n password.

" - } - }, - "preferredBackupWindow": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created for your database if\n automated backups are enabled.

\n

Constraints:

\n " - } - }, - "preferredMaintenanceWindow": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur on your database.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n Amazon Web Services Region, occurring on a random day of the week.

\n

Constraints:

\n " - } - }, - "enableBackupRetention": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

When true, enables automated backup retention for your database.

\n

Updates are applied during the next maintenance window because this can result in an\n outage.

" - } - }, - "disableBackupRetention": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

When true, disables automated backup retention for your database.

\n

Disabling backup retention deletes all automated database backups. Before disabling this,\n you may want to create a snapshot of your database using the create relational database\n snapshot operation.

\n

Updates are applied during the next maintenance window because this can result in an\n outage.

" - } - }, - "publiclyAccessible": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

Specifies the accessibility options for your database. A value of true\n specifies a database that is available to resources outside of your Lightsail account. A\n value of false specifies a database that is available only to your Lightsail\n resources in the same region as your database.

" - } - }, - "applyImmediately": { - "target": "com.amazonaws.lightsail#boolean", - "traits": { - "smithy.api#documentation": "

When true, applies changes immediately. When false, applies\n changes during the preferred maintenance window. Some changes may cause an outage.

\n

Default: false\n

" - } - }, - "caCertificateIdentifier": { - "target": "com.amazonaws.lightsail#string", - "traits": { - "smithy.api#documentation": "

Indicates the certificate that needs to be associated with the database.

" - } - } - } - }, - "com.amazonaws.lightsail#UpdateRelationalDatabaseResult": { - "type": "structure", - "members": { - "operations": { - "target": "com.amazonaws.lightsail#OperationList", - "traits": { - "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" - } + "com.amazonaws.lightsail#UpdateRelationalDatabaseResult": { + "type": "structure", + "members": { + "operations": { + "target": "com.amazonaws.lightsail#OperationList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" + } + } + } + }, + "com.amazonaws.lightsail#boolean": { + "type": "boolean" + }, + "com.amazonaws.lightsail#double": { + "type": "double" + }, + "com.amazonaws.lightsail#float": { + "type": "float" + }, + "com.amazonaws.lightsail#integer": { + "type": "integer" + }, + "com.amazonaws.lightsail#long": { + "type": "long" + }, + "com.amazonaws.lightsail#string": { + "type": "string" + }, + "com.amazonaws.lightsail#timestamp": { + "type": "timestamp" } - } - }, - "com.amazonaws.lightsail#boolean": { - "type": "boolean" - }, - "com.amazonaws.lightsail#double": { - "type": "double" - }, - "com.amazonaws.lightsail#float": { - "type": "float" - }, - "com.amazonaws.lightsail#integer": { - "type": "integer" - }, - "com.amazonaws.lightsail#long": { - "type": "long" - }, - "com.amazonaws.lightsail#string": { - "type": "string" - }, - "com.amazonaws.lightsail#timestamp": { - "type": "timestamp" } - } } diff --git a/codegen/sdk-codegen/aws-models/mwaa.json b/codegen/sdk-codegen/aws-models/mwaa.json index c91f520400d5..4fe98e8d48f4 100644 --- a/codegen/sdk-codegen/aws-models/mwaa.json +++ b/codegen/sdk-codegen/aws-models/mwaa.json @@ -1,3439 +1,3430 @@ { - "smithy": "2.0", - "shapes": { - "com.amazonaws.mwaa#AccessDeniedException": { - "type": "structure", - "members": { - "Message": { - "target": "smithy.api#String" - } - }, - "traits": { - "smithy.api#documentation": "

Access to the Apache Airflow Web UI or CLI has been denied due to insufficient permissions. To learn more, see Accessing an Amazon MWAA environment.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.mwaa#AirflowConfigurationOptions": { - "type": "map", - "key": { - "target": "com.amazonaws.mwaa#ConfigKey" - }, - "value": { - "target": "com.amazonaws.mwaa#ConfigValue" - }, - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.mwaa#AirflowVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - }, - "smithy.api#pattern": "^[0-9a-z.]+$" - } - }, - "com.amazonaws.mwaa#AmazonMWAA": { - "type": "service", - "version": "2020-07-01", - "operations": [ - { - "target": "com.amazonaws.mwaa#CreateCliToken" - }, - { - "target": "com.amazonaws.mwaa#CreateEnvironment" - }, - { - "target": "com.amazonaws.mwaa#CreateWebLoginToken" - }, - { - "target": "com.amazonaws.mwaa#DeleteEnvironment" - }, - { - "target": "com.amazonaws.mwaa#GetEnvironment" - }, - { - "target": "com.amazonaws.mwaa#ListEnvironments" - }, - { - "target": "com.amazonaws.mwaa#ListTagsForResource" - }, - { - "target": "com.amazonaws.mwaa#PublishMetrics" - }, - { - "target": "com.amazonaws.mwaa#TagResource" - }, - { - "target": "com.amazonaws.mwaa#UntagResource" - }, - { - "target": "com.amazonaws.mwaa#UpdateEnvironment" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "MWAA", - "arnNamespace": "airflow" - }, - "aws.auth#sigv4": { - "name": "airflow" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Amazon Managed Workflows for Apache Airflow\n

This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation. For more information, see What Is Amazon MWAA?.

\n

\n Endpoints\n

\n \n

\n Regions\n

\n

For a list of regions that Amazon MWAA supports, see Region availability in the Amazon MWAA User Guide.

", - "smithy.api#title": "AmazonMWAA", - "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" + "smithy": "2.0", + "shapes": { + "com.amazonaws.mwaa#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

Access to the Apache Airflow Web UI or CLI has been denied due to insufficient permissions. To learn more, see Accessing an Amazon MWAA environment.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.mwaa#AirflowConfigurationOptions": { + "type": "map", + "key": { + "target": "com.amazonaws.mwaa#ConfigKey" }, - "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" + "value": { + "target": "com.amazonaws.mwaa#ConfigValue" }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.mwaa#AirflowVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[0-9a-z.]+$" + } + }, + "com.amazonaws.mwaa#AmazonMWAA": { + "type": "service", + "version": "2020-07-01", + "operations": [ { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "type": "tree", - "rules": [ + "target": "com.amazonaws.mwaa#CreateCliToken" + }, { - "conditions": [ - { - "fn": "isSet", - "argv": [ + "target": "com.amazonaws.mwaa#CreateEnvironment" + }, + { + "target": "com.amazonaws.mwaa#CreateWebLoginToken" + }, + { + "target": "com.amazonaws.mwaa#DeleteEnvironment" + }, + { + "target": "com.amazonaws.mwaa#GetEnvironment" + }, + { + "target": "com.amazonaws.mwaa#ListEnvironments" + }, + { + "target": "com.amazonaws.mwaa#ListTagsForResource" + }, + { + "target": "com.amazonaws.mwaa#PublishMetrics" + }, + { + "target": "com.amazonaws.mwaa#TagResource" + }, + { + "target": "com.amazonaws.mwaa#UntagResource" + }, + { + "target": "com.amazonaws.mwaa#UpdateEnvironment" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "MWAA", + "arnNamespace": "airflow" + }, + "aws.auth#sigv4": { + "name": "airflow" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Amazon Managed Workflows for Apache Airflow\n

This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation. For more information, see What Is Amazon MWAA?.

\n

\n Endpoints\n

\n \n

\n Regions\n

\n

For a list of regions that Amazon MWAA supports, see Region availability in the Amazon MWAA User Guide.

", + "smithy.api#title": "AmazonMWAA", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": true, + "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": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "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" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://airflow-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": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://airflow-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://airflow.{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://airflow.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.ap-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow.ap-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.eu-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.eu-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow.eu-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow.eu-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.ca-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ca-central-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ca-central-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow.ca-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ca-central-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ca-central-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.eu-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-central-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-central-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow.eu-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-central-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-central-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.us-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow.us-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow.us-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.af-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "af-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.af-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "af-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow.af-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "af-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow.af-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "af-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.eu-north-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-north-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-north-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow.eu-north-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-north-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-north-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.eu-west-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-3", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-3", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow.eu-west-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-3", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-3", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.eu-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow.eu-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.eu-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow.eu-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.ap-northeast-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-3", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-3", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow.ap-northeast-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-3", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-3", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.ap-northeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow.ap-northeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-2", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-2", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow.ap-northeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-1", + "UseFIPS": false + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.me-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "me-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.me-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "me-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow.me-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "me-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow.me-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "me-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.sa-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "sa-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "sa-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow.sa-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "sa-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "sa-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.ap-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow.ap-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow.ap-southeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-2", + "UseFIPS": false + } + }, { - "ref": "Endpoint" - } - ] - }, - { - "fn": "parseURL", - "argv": [ + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-2", + "UseFIPS": false + } + }, { - "ref": "Endpoint" - } - ], - "assign": "url" - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-east-1", + "UseFIPS": true + } + }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.us-east-1.amazonaws.com" + } }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] + "params": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": true } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" }, { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow.us-east-1.api.aws" + } }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + "params": { + "UseDualStack": true, + "Region": "us-east-1", + "UseFIPS": false + } + }, { - "ref": "UseFIPS" + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": false + } }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ { - "ref": "UseDualStack" + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.us-east-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-east-2", + "UseFIPS": true + } }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-2", + "UseFIPS": true } - ] }, { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://airflow.us-east-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-east-2", + "UseFIPS": false } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://airflow-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": [ - { - "fn": "booleanEquals", - "argv": [ + }, { - "ref": "UseFIPS" + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://airflow.us-east-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-2", + "UseFIPS": false + } }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": false, + "Endpoint": "https://example.com" } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://airflow-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + }, { - "ref": "UseDualStack" + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": true, + "Endpoint": "https://example.com" + } }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseDualStack": true, + "Region": "us-east-1", + "UseFIPS": false, + "Endpoint": "https://example.com" } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://airflow.{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://airflow.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + ], + "version": "1.0" } - ] } - ] }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.ap-south-1.api.aws" - } - }, - "params": { - "Region": "ap-south-1", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow.ap-south-1.api.aws" - } - }, - "params": { - "Region": "ap-south-1", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region eu-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.eu-south-1.api.aws" - } - }, - "params": { - "Region": "eu-south-1", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region eu-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.eu-south-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-south-1", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow.eu-south-1.api.aws" - } - }, - "params": { - "Region": "eu-south-1", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow.eu-south-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-south-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.ca-central-1.api.aws" - } - }, - "params": { - "Region": "ca-central-1", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow.ca-central-1.api.aws" - } - }, - "params": { - "Region": "ca-central-1", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.eu-central-1.api.aws" - } - }, - "params": { - "Region": "eu-central-1", - "UseDualStack": true, - "UseFIPS": true - } + "com.amazonaws.mwaa#CloudWatchLogGroupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1224 + }, + "smithy.api#pattern": "^arn:aws(-[a-z]+)?:logs:[a-z0-9\\-]+:\\d{12}:log-group:\\w+" + } + }, + "com.amazonaws.mwaa#ConfigKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-z]+([a-z0-9._]*[a-z0-9_]+)?$" + } + }, + "com.amazonaws.mwaa#ConfigValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 65536 + }, + "smithy.api#pattern": "^[ -~]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.mwaa#CreateCliToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.mwaa#CreateCliTokenRequest" }, - { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseDualStack": false, - "UseFIPS": true - } + "output": { + "target": "com.amazonaws.mwaa#CreateCliTokenResponse" }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow.eu-central-1.api.aws" + "errors": [ + { + "target": "com.amazonaws.mwaa#ResourceNotFoundException" } - }, - "params": { - "Region": "eu-central-1", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow.eu-central-1.amazonaws.com" + ], + "traits": { + "smithy.api#documentation": "

Creates a CLI token for the Airflow CLI. To learn more, see Creating an Apache Airflow CLI token.

", + "smithy.api#endpoint": { + "hostPrefix": "env." + }, + "smithy.api#http": { + "uri": "/clitoken/{Name}", + "method": "POST", + "code": 200 } - }, - "params": { - "Region": "eu-central-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.us-west-1.api.aws" + } + }, + "com.amazonaws.mwaa#CreateCliTokenRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.mwaa#EnvironmentName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } - }, - "params": { - "Region": "us-west-1", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.us-west-1.amazonaws.com" + } + }, + "com.amazonaws.mwaa#CreateCliTokenResponse": { + "type": "structure", + "members": { + "CliToken": { + "target": "com.amazonaws.mwaa#Token", + "traits": { + "smithy.api#documentation": "

An Airflow CLI login token.

" + } + }, + "WebServerHostname": { + "target": "com.amazonaws.mwaa#Hostname", + "traits": { + "smithy.api#documentation": "

The Airflow web server hostname for the environment.

" + } } - }, - "params": { - "Region": "us-west-1", - "UseDualStack": false, - "UseFIPS": true - } + } + }, + "com.amazonaws.mwaa#CreateEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.mwaa#CreateEnvironmentInput" }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow.us-west-1.api.aws" - } - }, - "params": { - "Region": "us-west-1", - "UseDualStack": true, - "UseFIPS": false - } + "output": { + "target": "com.amazonaws.mwaa#CreateEnvironmentOutput" }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow.us-west-1.amazonaws.com" + "errors": [ + { + "target": "com.amazonaws.mwaa#InternalServerException" + }, + { + "target": "com.amazonaws.mwaa#ValidationException" } - }, - "params": { - "Region": "us-west-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.us-west-2.api.aws" + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/environments/{Name}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mwaa#CreateEnvironmentInput": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.mwaa#EnvironmentName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.mwaa#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the execution role for your environment. An execution role is an Amazon Web Services Identity and Access Management (IAM) role that grants MWAA permission to access Amazon Web Services services and resources used by your environment. For example, arn:aws:iam::123456789:role/my-execution-role. To learn more, see Amazon MWAA Execution role.

", + "smithy.api#required": {} + } + }, + "SourceBucketArn": { + "target": "com.amazonaws.mwaa#S3BucketArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, arn:aws:s3:::my-airflow-bucket-unique-name. To learn more, see Create an Amazon S3 bucket for Amazon MWAA.

", + "smithy.api#required": {} + } + }, + "DagS3Path": { + "target": "com.amazonaws.mwaa#RelativePath", + "traits": { + "smithy.api#documentation": "

The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. To learn more, see Adding or updating DAGs.

", + "smithy.api#required": {} + } + }, + "NetworkConfiguration": { + "target": "com.amazonaws.mwaa#NetworkConfiguration", + "traits": { + "smithy.api#documentation": "

The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. To learn more, see About networking on Amazon MWAA.

", + "smithy.api#required": {} + } + }, + "PluginsS3Path": { + "target": "com.amazonaws.mwaa#RelativePath", + "traits": { + "smithy.api#documentation": "

The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip. If specified, then the plugins.zip version is required. To learn more, see Installing custom plugins.

" + } + }, + "PluginsS3ObjectVersion": { + "target": "com.amazonaws.mwaa#S3ObjectVersion", + "traits": { + "smithy.api#documentation": "

The version of the plugins.zip file on your Amazon S3 bucket. A version must be specified each time a plugins.zip file is updated. To learn more, see How S3 Versioning works.

" + } + }, + "RequirementsS3Path": { + "target": "com.amazonaws.mwaa#RelativePath", + "traits": { + "smithy.api#documentation": "

The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. If specified, then a file version is required. To learn more, see Installing Python dependencies.

" + } + }, + "RequirementsS3ObjectVersion": { + "target": "com.amazonaws.mwaa#S3ObjectVersion", + "traits": { + "smithy.api#documentation": "

The version of the requirements.txt file on your Amazon S3 bucket. A version must be specified each time a requirements.txt file is updated. To learn more, see How S3 Versioning works.

" + } + }, + "AirflowConfigurationOptions": { + "target": "com.amazonaws.mwaa#AirflowConfigurationOptions", + "traits": { + "smithy.api#documentation": "

A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. To learn more, see Apache Airflow configuration options.

" + } + }, + "EnvironmentClass": { + "target": "com.amazonaws.mwaa#EnvironmentClass", + "traits": { + "smithy.api#documentation": "

The environment class type. Valid values: mw1.small, mw1.medium, mw1.large. To learn more, see Amazon MWAA environment class.

" + } + }, + "MaxWorkers": { + "target": "com.amazonaws.mwaa#MaxWorkers", + "traits": { + "smithy.api#documentation": "

The maximum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the MaxWorkers field. For example, 20. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the one worker that is included with your environment, or the number you specify in MinWorkers.

" + } + }, + "KmsKey": { + "target": "com.amazonaws.mwaa#KmsKey", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (KMS) key to encrypt the data in your environment. You can use an Amazon Web Services owned CMK, or a Customer managed CMK (advanced). To learn more, see Create an Amazon MWAA environment.

" + } + }, + "AirflowVersion": { + "target": "com.amazonaws.mwaa#AirflowVersion", + "traits": { + "smithy.api#documentation": "

The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version. Valid values:\n 1.10.12, 2.0.2, 2.2.2, and 2.4.3.\n For more information, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA).

" + } + }, + "LoggingConfiguration": { + "target": "com.amazonaws.mwaa#LoggingConfigurationInput", + "traits": { + "smithy.api#documentation": "

Defines the Apache Airflow logs to send to CloudWatch Logs.

" + } + }, + "WeeklyMaintenanceWindowStart": { + "target": "com.amazonaws.mwaa#WeeklyMaintenanceWindowStart", + "traits": { + "smithy.api#documentation": "

The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time to start weekly maintenance updates of your environment in the following format: DAY:HH:MM. For example: TUE:03:30. You can specify a start time in 30 minute increments only.

" + } + }, + "Tags": { + "target": "com.amazonaws.mwaa#TagMap", + "traits": { + "smithy.api#documentation": "

The key-value tag pairs you want to associate to your environment. For example, \"Environment\": \"Staging\". To learn more, see Tagging Amazon Web Services resources.

" + } + }, + "WebserverAccessMode": { + "target": "com.amazonaws.mwaa#WebserverAccessMode", + "traits": { + "smithy.api#documentation": "

The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.

" + } + }, + "MinWorkers": { + "target": "com.amazonaws.mwaa#MinWorkers", + "traits": { + "smithy.api#documentation": "

The minimum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the MaxWorkers field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the worker count you specify in the MinWorkers field. For example, 2.

" + } + }, + "Schedulers": { + "target": "com.amazonaws.mwaa#Schedulers", + "traits": { + "smithy.api#documentation": "

The number of Apache Airflow schedulers to run in your environment. Valid values:

\n " + } } - }, - "params": { - "Region": "us-west-2", - "UseDualStack": true, - "UseFIPS": true - } }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.us-west-2.amazonaws.com" + "traits": { + "smithy.api#documentation": "

This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation to create an environment. For more information, see Get started with Amazon Managed Workflows for Apache Airflow.

" + } + }, + "com.amazonaws.mwaa#CreateEnvironmentOutput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mwaa#EnvironmentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) returned in the response for the environment.

" + } } - }, - "params": { - "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": true - } + } + }, + "com.amazonaws.mwaa#CreateWebLoginToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.mwaa#CreateWebLoginTokenRequest" }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow.us-west-2.api.aws" - } - }, - "params": { - "Region": "us-west-2", - "UseDualStack": true, - "UseFIPS": false - } + "output": { + "target": "com.amazonaws.mwaa#CreateWebLoginTokenResponse" }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow.us-west-2.amazonaws.com" + "errors": [ + { + "target": "com.amazonaws.mwaa#AccessDeniedException" + }, + { + "target": "com.amazonaws.mwaa#InternalServerException" + }, + { + "target": "com.amazonaws.mwaa#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mwaa#ValidationException" } - }, - "params": { - "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.af-south-1.api.aws" + ], + "traits": { + "smithy.api#documentation": "

Creates a web login token for the Airflow Web UI. To learn more, see Creating an Apache Airflow web login token.

", + "smithy.api#endpoint": { + "hostPrefix": "env." + }, + "smithy.api#http": { + "uri": "/webtoken/{Name}", + "method": "POST", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mwaa#CreateWebLoginTokenRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.mwaa#EnvironmentName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } - }, - "params": { - "Region": "af-south-1", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.af-south-1.amazonaws.com" + } + }, + "com.amazonaws.mwaa#CreateWebLoginTokenResponse": { + "type": "structure", + "members": { + "WebToken": { + "target": "com.amazonaws.mwaa#Token", + "traits": { + "smithy.api#documentation": "

An Airflow web server login token.

" + } + }, + "WebServerHostname": { + "target": "com.amazonaws.mwaa#Hostname", + "traits": { + "smithy.api#documentation": "

The Airflow web server hostname for the environment.

" + } } - }, - "params": { - "Region": "af-south-1", - "UseDualStack": false, - "UseFIPS": true - } + } + }, + "com.amazonaws.mwaa#CreatedAt": { + "type": "timestamp" + }, + "com.amazonaws.mwaa#DeleteEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.mwaa#DeleteEnvironmentInput" }, - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow.af-south-1.api.aws" - } - }, - "params": { - "Region": "af-south-1", - "UseDualStack": true, - "UseFIPS": false - } + "output": { + "target": "com.amazonaws.mwaa#DeleteEnvironmentOutput" }, - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow.af-south-1.amazonaws.com" + "errors": [ + { + "target": "com.amazonaws.mwaa#InternalServerException" + }, + { + "target": "com.amazonaws.mwaa#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mwaa#ValidationException" } - }, - "params": { - "Region": "af-south-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.eu-north-1.api.aws" + ], + "traits": { + "smithy.api#documentation": "

Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/environments/{Name}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mwaa#DeleteEnvironmentInput": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.mwaa#EnvironmentName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } - }, - "params": { - "Region": "eu-north-1", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.eu-north-1.amazonaws.com" + } + }, + "com.amazonaws.mwaa#DeleteEnvironmentOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.mwaa#Dimension": { + "type": "structure", + "members": { + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n Internal only. The name of the dimension.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n Internal only. The value of the dimension.

", + "smithy.api#required": {} + } } - }, - "params": { - "Region": "eu-north-1", - "UseDualStack": false, - "UseFIPS": true - } }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow.eu-north-1.api.aws" + "traits": { + "smithy.api#documentation": "

\n Internal only. Represents the dimensions of a metric. To learn more about the metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in Amazon CloudWatch.

" + } + }, + "com.amazonaws.mwaa#Dimensions": { + "type": "list", + "member": { + "target": "com.amazonaws.mwaa#Dimension" + } + }, + "com.amazonaws.mwaa#Environment": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.mwaa#EnvironmentName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

" + } + }, + "Status": { + "target": "com.amazonaws.mwaa#EnvironmentStatus", + "traits": { + "smithy.api#documentation": "

The status of the Amazon MWAA environment. Valid values:

\n \n

We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. To learn more, see Amazon MWAA troubleshooting.

" + } + }, + "Arn": { + "target": "com.amazonaws.mwaa#EnvironmentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon MWAA environment.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.mwaa#CreatedAt", + "traits": { + "smithy.api#documentation": "

The day and time the environment was created.

" + } + }, + "WebserverUrl": { + "target": "com.amazonaws.mwaa#WebserverUrl", + "traits": { + "smithy.api#documentation": "

The Apache Airflow Web server host name for the Amazon MWAA environment. To learn more, see Accessing the Apache Airflow UI.

" + } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.mwaa#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services resources in your environment. For example, arn:aws:iam::123456789:role/my-execution-role. To learn more, see Amazon MWAA Execution role.

" + } + }, + "ServiceRoleArn": { + "target": "com.amazonaws.mwaa#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the service-linked role of the environment. To learn more, see Amazon MWAA Service-linked role.

" + } + }, + "KmsKey": { + "target": "com.amazonaws.mwaa#KmsKey", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (KMS) encryption key used to encrypt the data in your environment.

" + } + }, + "AirflowVersion": { + "target": "com.amazonaws.mwaa#AirflowVersion", + "traits": { + "smithy.api#documentation": "

The Apache Airflow version on your environment. Valid values: 1.10.12, 2.0.2, 2.2.2, and 2.4.3.

" + } + }, + "SourceBucketArn": { + "target": "com.amazonaws.mwaa#S3BucketArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, arn:aws:s3:::my-airflow-bucket-unique-name. To learn more, see Create an Amazon S3 bucket for Amazon MWAA.

" + } + }, + "DagS3Path": { + "target": "com.amazonaws.mwaa#RelativePath", + "traits": { + "smithy.api#documentation": "

The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. To learn more, see Adding or updating DAGs.

" + } + }, + "PluginsS3Path": { + "target": "com.amazonaws.mwaa#RelativePath", + "traits": { + "smithy.api#documentation": "

The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip. To learn more, see Installing custom plugins.

" + } + }, + "PluginsS3ObjectVersion": { + "target": "com.amazonaws.mwaa#S3ObjectVersion", + "traits": { + "smithy.api#documentation": "

The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see Installing custom plugins.

" + } + }, + "RequirementsS3Path": { + "target": "com.amazonaws.mwaa#RelativePath", + "traits": { + "smithy.api#documentation": "

The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. To learn more, see Installing Python dependencies.

" + } + }, + "RequirementsS3ObjectVersion": { + "target": "com.amazonaws.mwaa#S3ObjectVersion", + "traits": { + "smithy.api#documentation": "

The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see Installing Python dependencies.

" + } + }, + "AirflowConfigurationOptions": { + "target": "com.amazonaws.mwaa#AirflowConfigurationOptions", + "traits": { + "smithy.api#documentation": "

A list of key-value pairs containing the Apache Airflow configuration options attached to your environment. To learn more, see Apache Airflow configuration options.

" + } + }, + "EnvironmentClass": { + "target": "com.amazonaws.mwaa#EnvironmentClass", + "traits": { + "smithy.api#documentation": "

The environment class type. Valid values: mw1.small, mw1.medium, mw1.large. To learn more, see Amazon MWAA environment class.

" + } + }, + "MaxWorkers": { + "target": "com.amazonaws.mwaa#MaxWorkers", + "traits": { + "smithy.api#documentation": "

The maximum number of workers that run in your environment. For example, 20.

" + } + }, + "NetworkConfiguration": { + "target": "com.amazonaws.mwaa#NetworkConfiguration", + "traits": { + "smithy.api#documentation": "

Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. To learn more, see About networking on Amazon MWAA.

" + } + }, + "LoggingConfiguration": { + "target": "com.amazonaws.mwaa#LoggingConfiguration", + "traits": { + "smithy.api#documentation": "

The Apache Airflow logs published to CloudWatch Logs.

" + } + }, + "LastUpdate": { + "target": "com.amazonaws.mwaa#LastUpdate", + "traits": { + "smithy.api#documentation": "

The status of the last update on the environment.

" + } + }, + "WeeklyMaintenanceWindowStart": { + "target": "com.amazonaws.mwaa#WeeklyMaintenanceWindowStart", + "traits": { + "smithy.api#documentation": "

The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.

" + } + }, + "Tags": { + "target": "com.amazonaws.mwaa#TagMap", + "traits": { + "smithy.api#documentation": "

The key-value tag pairs associated to your environment. For example, \"Environment\": \"Staging\". To learn more, see Tagging Amazon Web Services resources.

" + } + }, + "WebserverAccessMode": { + "target": "com.amazonaws.mwaa#WebserverAccessMode", + "traits": { + "smithy.api#documentation": "

The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.

" + } + }, + "MinWorkers": { + "target": "com.amazonaws.mwaa#MinWorkers", + "traits": { + "smithy.api#documentation": "

The minimum number of workers that run in your environment. For example, 2.

" + } + }, + "Schedulers": { + "target": "com.amazonaws.mwaa#Schedulers", + "traits": { + "smithy.api#documentation": "

The number of Apache Airflow schedulers that run in your Amazon MWAA environment.

" + } } - }, - "params": { - "Region": "eu-north-1", - "UseDualStack": true, - "UseFIPS": false - } }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow.eu-north-1.amazonaws.com" + "traits": { + "smithy.api#documentation": "

Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

" + } + }, + "com.amazonaws.mwaa#EnvironmentArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1224 + }, + "smithy.api#pattern": "^arn:aws(-[a-z]+)?:airflow:[a-z0-9\\-]+:\\d{12}:environment/\\w+" + } + }, + "com.amazonaws.mwaa#EnvironmentClass": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 } - }, - "params": { - "Region": "eu-north-1", - "UseDualStack": false, - "UseFIPS": false - } + } + }, + "com.amazonaws.mwaa#EnvironmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.mwaa#EnvironmentName" + } + }, + "com.amazonaws.mwaa#EnvironmentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 80 + }, + "smithy.api#pattern": "^[a-zA-Z][0-9a-zA-Z-_]*$" + } + }, + "com.amazonaws.mwaa#EnvironmentStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "CREATE_FAILED", + "name": "CREATE_FAILED" + }, + { + "value": "AVAILABLE", + "name": "AVAILABLE" + }, + { + "value": "UPDATING", + "name": "UPDATING" + }, + { + "value": "DELETING", + "name": "DELETING" + }, + { + "value": "DELETED", + "name": "DELETED" + }, + { + "value": "UNAVAILABLE", + "name": "UNAVAILABLE" + }, + { + "value": "UPDATE_FAILED", + "name": "UPDATE_FAILED" + } + ] + } + }, + "com.amazonaws.mwaa#ErrorCode": { + "type": "string" + }, + "com.amazonaws.mwaa#ErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.mwaa#GetEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.mwaa#GetEnvironmentInput" }, - { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.eu-west-3.api.aws" - } - }, - "params": { - "Region": "eu-west-3", - "UseDualStack": true, - "UseFIPS": true - } + "output": { + "target": "com.amazonaws.mwaa#GetEnvironmentOutput" }, - { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.eu-west-3.amazonaws.com" + "errors": [ + { + "target": "com.amazonaws.mwaa#InternalServerException" + }, + { + "target": "com.amazonaws.mwaa#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mwaa#ValidationException" } - }, - "params": { - "Region": "eu-west-3", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow.eu-west-3.api.aws" + ], + "traits": { + "smithy.api#documentation": "

Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/environments/{Name}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mwaa#GetEnvironmentInput": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.mwaa#EnvironmentName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } - }, - "params": { - "Region": "eu-west-3", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow.eu-west-3.amazonaws.com" + } + }, + "com.amazonaws.mwaa#GetEnvironmentOutput": { + "type": "structure", + "members": { + "Environment": { + "target": "com.amazonaws.mwaa#Environment", + "traits": { + "smithy.api#documentation": "

An object containing all available details about the environment.

" + } } - }, - "params": { - "Region": "eu-west-3", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.eu-west-2.api.aws" + } + }, + "com.amazonaws.mwaa#Hostname": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$" + } + }, + "com.amazonaws.mwaa#IamRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1224 + }, + "smithy.api#pattern": "^arn:aws(-[a-z]+)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" + } + }, + "com.amazonaws.mwaa#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" } - }, - "params": { - "Region": "eu-west-2", - "UseDualStack": true, - "UseFIPS": true - } }, - { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.eu-west-2.amazonaws.com" + "traits": { + "smithy.api#documentation": "

InternalServerException: An internal error has occurred.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.mwaa#KmsKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1224 + }, + "smithy.api#pattern": "^(((arn:aws(-[a-z]+)?:kms:[a-z]{2}-[a-z]+-\\d:\\d+:)?key\\/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|(arn:aws(-[a-z]+)?:kms:[a-z]{2}-[a-z]+-\\d:\\d+:)?alias/.+)$" + } + }, + "com.amazonaws.mwaa#LastUpdate": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.mwaa#UpdateStatus", + "traits": { + "smithy.api#documentation": "

The status of the last update on the environment.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.mwaa#UpdateCreatedAt", + "traits": { + "smithy.api#documentation": "

The day and time of the last update on the environment.

" + } + }, + "Error": { + "target": "com.amazonaws.mwaa#UpdateError", + "traits": { + "smithy.api#documentation": "

The error that was encountered during the last update of the environment.

" + } + }, + "Source": { + "target": "com.amazonaws.mwaa#UpdateSource", + "traits": { + "smithy.api#documentation": "

The source of the last update to the environment. Includes internal processes by Amazon MWAA, such as an environment maintenance update.

" + } } - }, - "params": { - "Region": "eu-west-2", - "UseDualStack": false, - "UseFIPS": true - } }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow.eu-west-2.api.aws" - } - }, - "params": { - "Region": "eu-west-2", - "UseDualStack": true, - "UseFIPS": false - } + "traits": { + "smithy.api#documentation": "

Describes the status of the last update on the environment, and any errors that were encountered.

" + } + }, + "com.amazonaws.mwaa#ListEnvironments": { + "type": "operation", + "input": { + "target": "com.amazonaws.mwaa#ListEnvironmentsInput" }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseDualStack": false, - "UseFIPS": false - } + "output": { + "target": "com.amazonaws.mwaa#ListEnvironmentsOutput" }, - { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.eu-west-1.api.aws" + "errors": [ + { + "target": "com.amazonaws.mwaa#InternalServerException" + }, + { + "target": "com.amazonaws.mwaa#ValidationException" } - }, - "params": { - "Region": "eu-west-1", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.eu-west-1.amazonaws.com" + ], + "traits": { + "smithy.api#documentation": "

Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/environments" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "Environments" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mwaa#ListEnvironmentsInput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.mwaa#NextToken", + "traits": { + "smithy.api#documentation": "

Retrieves the next page of the results.

", + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results to retrieve per page. For example, 5 environments per page.

", + "smithy.api#httpQuery": "MaxResults", + "smithy.api#range": { + "min": 1, + "max": 25 + } + } } - }, - "params": { - "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow.eu-west-1.api.aws" + } + }, + "com.amazonaws.mwaa#ListEnvironmentsOutput": { + "type": "structure", + "members": { + "Environments": { + "target": "com.amazonaws.mwaa#EnvironmentList", + "traits": { + "smithy.api#documentation": "

Returns a list of Amazon MWAA environments.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.mwaa#NextToken", + "traits": { + "smithy.api#documentation": "

Retrieves the next page of the results.

" + } } - }, - "params": { - "Region": "eu-west-1", - "UseDualStack": true, - "UseFIPS": false - } + } + }, + "com.amazonaws.mwaa#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.mwaa#ListTagsForResourceInput" }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": false - } + "output": { + "target": "com.amazonaws.mwaa#ListTagsForResourceOutput" }, - { - "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.ap-northeast-3.api.aws" + "errors": [ + { + "target": "com.amazonaws.mwaa#InternalServerException" + }, + { + "target": "com.amazonaws.mwaa#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mwaa#ValidationException" } - }, - "params": { - "Region": "ap-northeast-3", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.ap-northeast-3.amazonaws.com" + ], + "traits": { + "smithy.api#documentation": "

Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, \"Environment\": \"Staging\".

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/tags/{ResourceArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mwaa#ListTagsForResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.mwaa#EnvironmentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } - }, - "params": { - "Region": "ap-northeast-3", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow.ap-northeast-3.api.aws" + } + }, + "com.amazonaws.mwaa#ListTagsForResourceOutput": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.mwaa#TagMap", + "traits": { + "smithy.api#documentation": "

The key-value tag pairs associated to your environment. To learn more, see Tagging Amazon Web Services resources.

" + } } - }, - "params": { - "Region": "ap-northeast-3", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow.ap-northeast-3.amazonaws.com" + } + }, + "com.amazonaws.mwaa#LoggingConfiguration": { + "type": "structure", + "members": { + "DagProcessingLogs": { + "target": "com.amazonaws.mwaa#ModuleLoggingConfiguration", + "traits": { + "smithy.api#documentation": "

The Airflow DAG processing logs published to CloudWatch Logs and the log level.

" + } + }, + "SchedulerLogs": { + "target": "com.amazonaws.mwaa#ModuleLoggingConfiguration", + "traits": { + "smithy.api#documentation": "

The Airflow scheduler logs published to CloudWatch Logs and the log level.

" + } + }, + "WebserverLogs": { + "target": "com.amazonaws.mwaa#ModuleLoggingConfiguration", + "traits": { + "smithy.api#documentation": "

The Airflow web server logs published to CloudWatch Logs and the log level.

" + } + }, + "WorkerLogs": { + "target": "com.amazonaws.mwaa#ModuleLoggingConfiguration", + "traits": { + "smithy.api#documentation": "

The Airflow worker logs published to CloudWatch Logs and the log level.

" + } + }, + "TaskLogs": { + "target": "com.amazonaws.mwaa#ModuleLoggingConfiguration", + "traits": { + "smithy.api#documentation": "

The Airflow task logs published to CloudWatch Logs and the log level.

" + } } - }, - "params": { - "Region": "ap-northeast-3", - "UseDualStack": false, - "UseFIPS": false - } }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.ap-northeast-2.api.aws" + "traits": { + "smithy.api#documentation": "

Describes the Apache Airflow log types that are published to CloudWatch Logs.

" + } + }, + "com.amazonaws.mwaa#LoggingConfigurationInput": { + "type": "structure", + "members": { + "DagProcessingLogs": { + "target": "com.amazonaws.mwaa#ModuleLoggingConfigurationInput", + "traits": { + "smithy.api#documentation": "

Publishes Airflow DAG processing logs to CloudWatch Logs.

" + } + }, + "SchedulerLogs": { + "target": "com.amazonaws.mwaa#ModuleLoggingConfigurationInput", + "traits": { + "smithy.api#documentation": "

Publishes Airflow scheduler logs to CloudWatch Logs.

" + } + }, + "WebserverLogs": { + "target": "com.amazonaws.mwaa#ModuleLoggingConfigurationInput", + "traits": { + "smithy.api#documentation": "

Publishes Airflow web server logs to CloudWatch Logs.

" + } + }, + "WorkerLogs": { + "target": "com.amazonaws.mwaa#ModuleLoggingConfigurationInput", + "traits": { + "smithy.api#documentation": "

Publishes Airflow worker logs to CloudWatch Logs.

" + } + }, + "TaskLogs": { + "target": "com.amazonaws.mwaa#ModuleLoggingConfigurationInput", + "traits": { + "smithy.api#documentation": "

Publishes Airflow task logs to CloudWatch Logs.

" + } } - }, - "params": { - "Region": "ap-northeast-2", - "UseDualStack": true, - "UseFIPS": true - } }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.ap-northeast-2.amazonaws.com" + "traits": { + "smithy.api#documentation": "

Defines the Apache Airflow log types to send to CloudWatch Logs.

" + } + }, + "com.amazonaws.mwaa#LoggingEnabled": { + "type": "boolean" + }, + "com.amazonaws.mwaa#LoggingLevel": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CRITICAL", + "name": "CRITICAL" + }, + { + "value": "ERROR", + "name": "ERROR" + }, + { + "value": "WARNING", + "name": "WARNING" + }, + { + "value": "INFO", + "name": "INFO" + }, + { + "value": "DEBUG", + "name": "DEBUG" + } + ] + } + }, + "com.amazonaws.mwaa#MaxWorkers": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 } - }, - "params": { - "Region": "ap-northeast-2", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow.ap-northeast-2.api.aws" + } + }, + "com.amazonaws.mwaa#MetricData": { + "type": "list", + "member": { + "target": "com.amazonaws.mwaa#MetricDatum" + } + }, + "com.amazonaws.mwaa#MetricDatum": { + "type": "structure", + "members": { + "MetricName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n Internal only. The name of the metric.

", + "smithy.api#required": {} + } + }, + "Timestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

\n Internal only. The time the metric data was received.

", + "smithy.api#required": {} + } + }, + "Dimensions": { + "target": "com.amazonaws.mwaa#Dimensions", + "traits": { + "smithy.api#documentation": "

\n Internal only. The dimensions associated with the metric.

" + } + }, + "Value": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

\n Internal only. The value for the metric.

" + } + }, + "Unit": { + "target": "com.amazonaws.mwaa#Unit", + "traits": { + "smithy.api#documentation": "

\n Internal only. The unit used to store the metric.

" + } + }, + "StatisticValues": { + "target": "com.amazonaws.mwaa#StatisticSet", + "traits": { + "smithy.api#documentation": "

\n Internal only. The statistical values for the metric.

" + } } - }, - "params": { - "Region": "ap-northeast-2", - "UseDualStack": true, - "UseFIPS": false - } }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow.ap-northeast-2.amazonaws.com" + "traits": { + "smithy.api#documentation": "

\n Internal only. Collects Apache Airflow metrics. To learn more about the metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in Amazon CloudWatch.

" + } + }, + "com.amazonaws.mwaa#MinWorkers": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 } - }, - "params": { - "Region": "ap-northeast-2", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.ap-northeast-1.api.aws" + } + }, + "com.amazonaws.mwaa#ModuleLoggingConfiguration": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.mwaa#LoggingEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether the Apache Airflow log type (e.g. DagProcessingLogs) is enabled.

" + } + }, + "LogLevel": { + "target": "com.amazonaws.mwaa#LoggingLevel", + "traits": { + "smithy.api#documentation": "

The Apache Airflow log level for the log type (e.g. DagProcessingLogs).

" + } + }, + "CloudWatchLogGroupArn": { + "target": "com.amazonaws.mwaa#CloudWatchLogGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the CloudWatch Logs group where the Apache Airflow log type (e.g. DagProcessingLogs) is published. For example, arn:aws:logs:us-east-1:123456789012:log-group:airflow-MyMWAAEnvironment-MwaaEnvironment-DAGProcessing:*.

" + } } - }, - "params": { - "Region": "ap-northeast-1", - "UseDualStack": true, - "UseFIPS": true - } }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.ap-northeast-1.amazonaws.com" + "traits": { + "smithy.api#documentation": "

Describes the Apache Airflow log details for the log type (e.g. DagProcessingLogs).

" + } + }, + "com.amazonaws.mwaa#ModuleLoggingConfigurationInput": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.mwaa#LoggingEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs).

", + "smithy.api#required": {} + } + }, + "LogLevel": { + "target": "com.amazonaws.mwaa#LoggingLevel", + "traits": { + "smithy.api#documentation": "

Defines the Apache Airflow log level (e.g. INFO) to send to CloudWatch Logs.

", + "smithy.api#required": {} + } } - }, - "params": { - "Region": "ap-northeast-1", - "UseDualStack": false, - "UseFIPS": true - } }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow.ap-northeast-1.api.aws" + "traits": { + "smithy.api#documentation": "

Enables the Apache Airflow log type (e.g. DagProcessingLogs) and defines the log level to send to CloudWatch Logs (e.g. INFO).

" + } + }, + "com.amazonaws.mwaa#NetworkConfiguration": { + "type": "structure", + "members": { + "SubnetIds": { + "target": "com.amazonaws.mwaa#SubnetList", + "traits": { + "smithy.api#documentation": "

A list of subnet IDs. To learn more, see About networking on Amazon MWAA.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.mwaa#SecurityGroupList", + "traits": { + "smithy.api#documentation": "

A list of security group IDs. To learn more, see Security in your VPC on Amazon MWAA.

" + } } - }, - "params": { - "Region": "ap-northeast-1", - "UseDualStack": true, - "UseFIPS": false - } }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow.ap-northeast-1.amazonaws.com" + "traits": { + "smithy.api#documentation": "

Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. To learn more, see About networking on Amazon MWAA.

" + } + }, + "com.amazonaws.mwaa#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 } - }, - "params": { - "Region": "ap-northeast-1", - "UseDualStack": false, - "UseFIPS": false - } + } + }, + "com.amazonaws.mwaa#PublishMetrics": { + "type": "operation", + "input": { + "target": "com.amazonaws.mwaa#PublishMetricsInput" }, - { - "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.me-south-1.api.aws" - } - }, - "params": { - "Region": "me-south-1", - "UseDualStack": true, - "UseFIPS": true - } + "output": { + "target": "com.amazonaws.mwaa#PublishMetricsOutput" }, - { - "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.me-south-1.amazonaws.com" + "errors": [ + { + "target": "com.amazonaws.mwaa#InternalServerException" + }, + { + "target": "com.amazonaws.mwaa#ValidationException" } - }, - "params": { - "Region": "me-south-1", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow.me-south-1.api.aws" + ], + "traits": { + "smithy.api#documentation": "

\n Internal only. Publishes environment health metrics to Amazon CloudWatch.

", + "smithy.api#endpoint": { + "hostPrefix": "ops." + }, + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/metrics/environments/{EnvironmentName}" } - }, - "params": { - "Region": "me-south-1", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow.me-south-1.amazonaws.com" + } + }, + "com.amazonaws.mwaa#PublishMetricsInput": { + "type": "structure", + "members": { + "EnvironmentName": { + "target": "com.amazonaws.mwaa#EnvironmentName", + "traits": { + "smithy.api#documentation": "

\n Internal only. The name of the environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MetricData": { + "target": "com.amazonaws.mwaa#MetricData", + "traits": { + "smithy.api#documentation": "

\n Internal only. Publishes metrics to Amazon CloudWatch. To learn more about the metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in Amazon CloudWatch.

", + "smithy.api#required": {} + } } - }, - "params": { - "Region": "me-south-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.sa-east-1.api.aws" + } + }, + "com.amazonaws.mwaa#PublishMetricsOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.mwaa#RelativePath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.mwaa#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" } - }, - "params": { - "Region": "sa-east-1", - "UseDualStack": true, - "UseFIPS": true - } }, - { - "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.sa-east-1.amazonaws.com" + "traits": { + "smithy.api#documentation": "

ResourceNotFoundException: The resource is not available.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.mwaa#S3BucketArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1224 + }, + "smithy.api#pattern": "^arn:aws(-[a-z]+)?:s3:::[a-z0-9.\\-]+$" + } + }, + "com.amazonaws.mwaa#S3ObjectVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 } - }, - "params": { - "Region": "sa-east-1", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow.sa-east-1.api.aws" + } + }, + "com.amazonaws.mwaa#Schedulers": { + "type": "integer", + "traits": { + "smithy.api#range": { + "max": 5 } - }, - "params": { - "Region": "sa-east-1", - "UseDualStack": true, - "UseFIPS": false - } + } + }, + "com.amazonaws.mwaa#SecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^sg-[a-zA-Z0-9\\-._]+$" + } + }, + "com.amazonaws.mwaa#SecurityGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.mwaa#SecurityGroupId" }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow.sa-east-1.amazonaws.com" + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 } - }, - "params": { - "Region": "sa-east-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region ap-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.ap-east-1.api.aws" + } + }, + "com.amazonaws.mwaa#StatisticSet": { + "type": "structure", + "members": { + "SampleCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

\n Internal only. The number of samples used for the statistic set.

" + } + }, + "Sum": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

\n Internal only. The sum of values for the sample set.

" + } + }, + "Minimum": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

\n Internal only. The minimum value of the sample set.

" + } + }, + "Maximum": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

\n Internal only. The maximum value of the sample set.

" + } } - }, - "params": { - "Region": "ap-east-1", - "UseDualStack": true, - "UseFIPS": true - } }, - { - "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.ap-east-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-east-1", - "UseDualStack": false, - "UseFIPS": true - } + "traits": { + "smithy.api#documentation": "

\n Internal only. Represents a set of statistics that describe a specific metric. To learn more about the metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in Amazon CloudWatch.

" + } + }, + "com.amazonaws.mwaa#SubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^subnet-[a-zA-Z0-9\\-._]+$" + } + }, + "com.amazonaws.mwaa#SubnetList": { + "type": "list", + "member": { + "target": "com.amazonaws.mwaa#SubnetId" }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow.ap-east-1.api.aws" + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 } - }, - "params": { - "Region": "ap-east-1", - "UseDualStack": true, - "UseFIPS": false - } + } + }, + "com.amazonaws.mwaa#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.mwaa#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.mwaa#TagKey" }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow.ap-east-1.amazonaws.com" + "traits": { + "smithy.api#length": { + "max": 50 } - }, - "params": { - "Region": "ap-east-1", - "UseDualStack": false, - "UseFIPS": false - } + } + }, + "com.amazonaws.mwaa#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.mwaa#TagKey" }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.ap-southeast-1.api.aws" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseDualStack": true, - "UseFIPS": true - } + "value": { + "target": "com.amazonaws.mwaa#TagValue" }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.ap-southeast-1.amazonaws.com" + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 } - }, - "params": { - "Region": "ap-southeast-1", - "UseDualStack": false, - "UseFIPS": true - } + } + }, + "com.amazonaws.mwaa#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.mwaa#TagResourceInput" }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow.ap-southeast-1.api.aws" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseDualStack": true, - "UseFIPS": false - } + "output": { + "target": "com.amazonaws.mwaa#TagResourceOutput" }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow.ap-southeast-1.amazonaws.com" + "errors": [ + { + "target": "com.amazonaws.mwaa#InternalServerException" + }, + { + "target": "com.amazonaws.mwaa#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mwaa#ValidationException" } - }, - "params": { - "Region": "ap-southeast-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.ap-southeast-2.api.aws" + ], + "traits": { + "smithy.api#documentation": "

Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/tags/{ResourceArn}" } - }, - "params": { - "Region": "ap-southeast-2", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.ap-southeast-2.amazonaws.com" + } + }, + "com.amazonaws.mwaa#TagResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.mwaa#EnvironmentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.mwaa#TagMap", + "traits": { + "smithy.api#documentation": "

The key-value tag pairs you want to associate to your environment. For example, \"Environment\": \"Staging\". To learn more, see Tagging Amazon Web Services resources.

", + "smithy.api#required": {} + } } - }, - "params": { - "Region": "ap-southeast-2", - "UseDualStack": false, - "UseFIPS": true - } + } + }, + "com.amazonaws.mwaa#TagResourceOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.mwaa#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.mwaa#Token": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.mwaa#Unit": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Seconds", + "name": "SECONDS" + }, + { + "value": "Microseconds", + "name": "MICROSECONDS" + }, + { + "value": "Milliseconds", + "name": "MILLISECONDS" + }, + { + "value": "Bytes", + "name": "BYTES" + }, + { + "value": "Kilobytes", + "name": "KILOBYTES" + }, + { + "value": "Megabytes", + "name": "MEGABYTES" + }, + { + "value": "Gigabytes", + "name": "GIGABYTES" + }, + { + "value": "Terabytes", + "name": "TERABYTES" + }, + { + "value": "Bits", + "name": "BITS" + }, + { + "value": "Kilobits", + "name": "KILOBITS" + }, + { + "value": "Megabits", + "name": "MEGABITS" + }, + { + "value": "Gigabits", + "name": "GIGABITS" + }, + { + "value": "Terabits", + "name": "TERABITS" + }, + { + "value": "Percent", + "name": "PERCENT" + }, + { + "value": "Count", + "name": "COUNT" + }, + { + "value": "Bytes/Second", + "name": "BYTES_PER_SECOND" + }, + { + "value": "Kilobytes/Second", + "name": "KILOBYTES_PER_SECOND" + }, + { + "value": "Megabytes/Second", + "name": "MEGABYTES_PER_SECOND" + }, + { + "value": "Gigabytes/Second", + "name": "GIGABYTES_PER_SECOND" + }, + { + "value": "Terabytes/Second", + "name": "TERABYTES_PER_SECOND" + }, + { + "value": "Bits/Second", + "name": "BITS_PER_SECOND" + }, + { + "value": "Kilobits/Second", + "name": "KILOBITS_PER_SECOND" + }, + { + "value": "Megabits/Second", + "name": "MEGABITS_PER_SECOND" + }, + { + "value": "Gigabits/Second", + "name": "GIGABITS_PER_SECOND" + }, + { + "value": "Terabits/Second", + "name": "TERABITS_PER_SECOND" + }, + { + "value": "Count/Second", + "name": "COUNT_PER_SECOND" + }, + { + "value": "None", + "name": "NONE" + } + ] + } + }, + "com.amazonaws.mwaa#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.mwaa#UntagResourceInput" }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow.ap-southeast-2.api.aws" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseDualStack": true, - "UseFIPS": false - } + "output": { + "target": "com.amazonaws.mwaa#UntagResourceOutput" }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow.ap-southeast-2.amazonaws.com" + "errors": [ + { + "target": "com.amazonaws.mwaa#InternalServerException" + }, + { + "target": "com.amazonaws.mwaa#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mwaa#ValidationException" } - }, - "params": { - "Region": "ap-southeast-2", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.us-east-1.api.aws" + ], + "traits": { + "smithy.api#documentation": "

Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, \"Environment\": \"Staging\".

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/tags/{ResourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mwaa#UntagResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.mwaa#EnvironmentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.mwaa#TagKeyList", + "traits": { + "smithy.api#documentation": "

The key-value tag pair you want to remove. For example, \"Environment\": \"Staging\".

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } } - }, - "params": { - "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true - } + } + }, + "com.amazonaws.mwaa#UntagResourceOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.mwaa#UpdateCreatedAt": { + "type": "timestamp" + }, + "com.amazonaws.mwaa#UpdateEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.mwaa#UpdateEnvironmentInput" }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": true - } + "output": { + "target": "com.amazonaws.mwaa#UpdateEnvironmentOutput" }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow.us-east-1.api.aws" + "errors": [ + { + "target": "com.amazonaws.mwaa#InternalServerException" + }, + { + "target": "com.amazonaws.mwaa#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mwaa#ValidationException" } - }, - "params": { - "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow.us-east-1.amazonaws.com" + ], + "traits": { + "smithy.api#documentation": "

Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/environments/{Name}" } - }, - "params": { - "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.us-east-2.api.aws" + } + }, + "com.amazonaws.mwaa#UpdateEnvironmentInput": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.mwaa#EnvironmentName", + "traits": { + "smithy.api#documentation": "

The name of your Amazon MWAA environment. For example, MyMWAAEnvironment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.mwaa#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services resources in your environment. For example, arn:aws:iam::123456789:role/my-execution-role. To learn more, see Amazon MWAA Execution role.

" + } + }, + "AirflowVersion": { + "target": "com.amazonaws.mwaa#AirflowVersion", + "traits": { + "smithy.api#documentation": "

The Apache Airflow version for your environment. If no value is specified, defaults to the latest version.\n Valid values: 1.10.12, 2.0.2, 2.2.2, and 2.4.3.

" + } + }, + "SourceBucketArn": { + "target": "com.amazonaws.mwaa#S3BucketArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, arn:aws:s3:::my-airflow-bucket-unique-name. To learn more, see Create an Amazon S3 bucket for Amazon MWAA.

" + } + }, + "DagS3Path": { + "target": "com.amazonaws.mwaa#RelativePath", + "traits": { + "smithy.api#documentation": "

The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. To learn more, see Adding or updating DAGs.

" + } + }, + "PluginsS3Path": { + "target": "com.amazonaws.mwaa#RelativePath", + "traits": { + "smithy.api#documentation": "

The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip. If specified, then the plugins.zip version is required. To learn more, see Installing custom plugins.

" + } + }, + "PluginsS3ObjectVersion": { + "target": "com.amazonaws.mwaa#S3ObjectVersion", + "traits": { + "smithy.api#documentation": "

The version of the plugins.zip file on your Amazon S3 bucket. A version must be specified each time a plugins.zip file is updated. To learn more, see How S3 Versioning works.

" + } + }, + "RequirementsS3Path": { + "target": "com.amazonaws.mwaa#RelativePath", + "traits": { + "smithy.api#documentation": "

The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. If specified, then a file version is required. To learn more, see Installing Python dependencies.

" + } + }, + "RequirementsS3ObjectVersion": { + "target": "com.amazonaws.mwaa#S3ObjectVersion", + "traits": { + "smithy.api#documentation": "

The version of the requirements.txt file on your Amazon S3 bucket. A version must be specified each time a requirements.txt file is updated. To learn more, see How S3 Versioning works.

" + } + }, + "AirflowConfigurationOptions": { + "target": "com.amazonaws.mwaa#AirflowConfigurationOptions", + "traits": { + "smithy.api#documentation": "

A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. To learn more, see Apache Airflow configuration options.

" + } + }, + "EnvironmentClass": { + "target": "com.amazonaws.mwaa#EnvironmentClass", + "traits": { + "smithy.api#documentation": "

The environment class type. Valid values: mw1.small, mw1.medium, mw1.large. To learn more, see Amazon MWAA environment class.

" + } + }, + "MaxWorkers": { + "target": "com.amazonaws.mwaa#MaxWorkers", + "traits": { + "smithy.api#documentation": "

The maximum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the MaxWorkers field. For example, 20. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the one worker that is included with your environment, or the number you specify in MinWorkers.

" + } + }, + "NetworkConfiguration": { + "target": "com.amazonaws.mwaa#UpdateNetworkConfigurationInput", + "traits": { + "smithy.api#documentation": "

The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. To learn more, see About networking on Amazon MWAA.

" + } + }, + "LoggingConfiguration": { + "target": "com.amazonaws.mwaa#LoggingConfigurationInput", + "traits": { + "smithy.api#documentation": "

The Apache Airflow log types to send to CloudWatch Logs.

" + } + }, + "WeeklyMaintenanceWindowStart": { + "target": "com.amazonaws.mwaa#WeeklyMaintenanceWindowStart", + "traits": { + "smithy.api#documentation": "

The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time to start weekly maintenance updates of your environment in the following format: DAY:HH:MM. For example: TUE:03:30. You can specify a start time in 30 minute increments only.

" + } + }, + "WebserverAccessMode": { + "target": "com.amazonaws.mwaa#WebserverAccessMode", + "traits": { + "smithy.api#documentation": "

The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.

" + } + }, + "MinWorkers": { + "target": "com.amazonaws.mwaa#MinWorkers", + "traits": { + "smithy.api#documentation": "

The minimum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the MaxWorkers field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the worker count you specify in the MinWorkers field. For example, 2.

" + } + }, + "Schedulers": { + "target": "com.amazonaws.mwaa#Schedulers", + "traits": { + "smithy.api#documentation": "

The number of Apache Airflow schedulers to run in your Amazon MWAA environment.

" + } } - }, - "params": { - "Region": "us-east-2", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow-fips.us-east-2.amazonaws.com" + } + }, + "com.amazonaws.mwaa#UpdateEnvironmentOutput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mwaa#EnvironmentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.

" + } } - }, - "params": { - "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://airflow.us-east-2.api.aws" + } + }, + "com.amazonaws.mwaa#UpdateError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.mwaa#ErrorCode", + "traits": { + "smithy.api#documentation": "

The error code that corresponds to the error with the last update.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.mwaa#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The error message that corresponds to the error code.

" + } } - }, - "params": { - "Region": "us-east-2", - "UseDualStack": true, - "UseFIPS": false - } }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://airflow.us-east-2.amazonaws.com" + "traits": { + "smithy.api#documentation": "

Describes the error(s) encountered with the last update of the environment.

" + } + }, + "com.amazonaws.mwaa#UpdateNetworkConfigurationInput": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.mwaa#SecurityGroupList", + "traits": { + "smithy.api#documentation": "

A list of security group IDs. A security group must be attached to the same VPC as the subnets. To learn more, see Security in your VPC on Amazon MWAA.

", + "smithy.api#required": {} + } } - }, - "params": { - "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": false - } }, - { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" + "traits": { + "smithy.api#documentation": "

Defines the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. To learn more, see About networking on Amazon MWAA.

" + } + }, + "com.amazonaws.mwaa#UpdateSource": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.mwaa#UpdateStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SUCCESS", + "name": "SUCCESS" + }, + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.mwaa#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" } - }, - "params": { - "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": 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", - "UseDualStack": false, - "UseFIPS": true, - "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", - "UseDualStack": true, - "UseFIPS": false, - "Endpoint": "https://example.com" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.mwaa#CloudWatchLogGroupArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1224 - }, - "smithy.api#pattern": "^arn:aws(-[a-z]+)?:logs:[a-z0-9\\-]+:\\d{12}:log-group:\\w+" - } - }, - "com.amazonaws.mwaa#ConfigKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[a-z]+([a-z0-9._]*[a-z0-9_]+)?$" - } - }, - "com.amazonaws.mwaa#ConfigValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 65536 - }, - "smithy.api#pattern": "^[ -~]+$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.mwaa#CreateCliToken": { - "type": "operation", - "input": { - "target": "com.amazonaws.mwaa#CreateCliTokenRequest" - }, - "output": { - "target": "com.amazonaws.mwaa#CreateCliTokenResponse" - }, - "errors": [ - { - "target": "com.amazonaws.mwaa#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a CLI token for the Airflow CLI. To learn more, see Creating an Apache Airflow CLI token.

", - "smithy.api#endpoint": { - "hostPrefix": "env." - }, - "smithy.api#http": { - "uri": "/clitoken/{Name}", - "method": "POST", - "code": 200 - } - } - }, - "com.amazonaws.mwaa#CreateCliTokenRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.mwaa#EnvironmentName", - "traits": { - "smithy.api#documentation": "

The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mwaa#CreateCliTokenResponse": { - "type": "structure", - "members": { - "CliToken": { - "target": "com.amazonaws.mwaa#Token", - "traits": { - "smithy.api#documentation": "

An Airflow CLI login token.

" - } - }, - "WebServerHostname": { - "target": "com.amazonaws.mwaa#Hostname", - "traits": { - "smithy.api#documentation": "

The Airflow web server hostname for the environment.

" - } - } - } - }, - "com.amazonaws.mwaa#CreateEnvironment": { - "type": "operation", - "input": { - "target": "com.amazonaws.mwaa#CreateEnvironmentInput" - }, - "output": { - "target": "com.amazonaws.mwaa#CreateEnvironmentOutput" - }, - "errors": [ - { - "target": "com.amazonaws.mwaa#InternalServerException" - }, - { - "target": "com.amazonaws.mwaa#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

", - "smithy.api#endpoint": { - "hostPrefix": "api." - }, - "smithy.api#http": { - "code": 200, - "method": "PUT", - "uri": "/environments/{Name}" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mwaa#CreateEnvironmentInput": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.mwaa#EnvironmentName", - "traits": { - "smithy.api#documentation": "

The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExecutionRoleArn": { - "target": "com.amazonaws.mwaa#IamRoleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the execution role for your environment. An execution role is an Amazon Web Services Identity and Access Management (IAM) role that grants MWAA permission to access Amazon Web Services services and resources used by your environment. For example, arn:aws:iam::123456789:role/my-execution-role. To learn more, see Amazon MWAA Execution role.

", - "smithy.api#required": {} - } - }, - "SourceBucketArn": { - "target": "com.amazonaws.mwaa#S3BucketArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, arn:aws:s3:::my-airflow-bucket-unique-name. To learn more, see Create an Amazon S3 bucket for Amazon MWAA.

", - "smithy.api#required": {} - } - }, - "DagS3Path": { - "target": "com.amazonaws.mwaa#RelativePath", - "traits": { - "smithy.api#documentation": "

The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. To learn more, see Adding or updating DAGs.

", - "smithy.api#required": {} - } - }, - "NetworkConfiguration": { - "target": "com.amazonaws.mwaa#NetworkConfiguration", - "traits": { - "smithy.api#documentation": "

The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. To learn more, see About networking on Amazon MWAA.

", - "smithy.api#required": {} - } - }, - "PluginsS3Path": { - "target": "com.amazonaws.mwaa#RelativePath", - "traits": { - "smithy.api#documentation": "

The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip. If specified, then the plugins.zip version is required. To learn more, see Installing custom plugins.

" - } - }, - "PluginsS3ObjectVersion": { - "target": "com.amazonaws.mwaa#S3ObjectVersion", - "traits": { - "smithy.api#documentation": "

The version of the plugins.zip file on your Amazon S3 bucket. A version must be specified each time a plugins.zip file is updated. To learn more, see How S3 Versioning works.

" - } - }, - "RequirementsS3Path": { - "target": "com.amazonaws.mwaa#RelativePath", - "traits": { - "smithy.api#documentation": "

The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. If specified, then a file version is required. To learn more, see Installing Python dependencies.

" - } - }, - "RequirementsS3ObjectVersion": { - "target": "com.amazonaws.mwaa#S3ObjectVersion", - "traits": { - "smithy.api#documentation": "

The version of the requirements.txt file on your Amazon S3 bucket. A version must be specified each time a requirements.txt file is updated. To learn more, see How S3 Versioning works.

" - } - }, - "AirflowConfigurationOptions": { - "target": "com.amazonaws.mwaa#AirflowConfigurationOptions", - "traits": { - "smithy.api#documentation": "

A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. To learn more, see Apache Airflow configuration options.

" - } - }, - "EnvironmentClass": { - "target": "com.amazonaws.mwaa#EnvironmentClass", - "traits": { - "smithy.api#documentation": "

The environment class type. Valid values: mw1.small, mw1.medium, mw1.large. To learn more, see Amazon MWAA environment class.

" - } - }, - "MaxWorkers": { - "target": "com.amazonaws.mwaa#MaxWorkers", - "traits": { - "smithy.api#documentation": "

The maximum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the MaxWorkers field. For example, 20. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the one worker that is included with your environment, or the number you specify in MinWorkers.

" - } - }, - "KmsKey": { - "target": "com.amazonaws.mwaa#KmsKey", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Key Management Service (KMS) key to encrypt the data in your environment. You can use an Amazon Web Services owned CMK, or a Customer managed CMK (advanced). To learn more, see Create an Amazon MWAA environment.

" - } - }, - "AirflowVersion": { - "target": "com.amazonaws.mwaa#AirflowVersion", - "traits": { - "smithy.api#documentation": "

The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version. Valid values:\n 1.10.12, 2.0.2, and 2.2.2.\n To learn more, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA).

" - } - }, - "LoggingConfiguration": { - "target": "com.amazonaws.mwaa#LoggingConfigurationInput", - "traits": { - "smithy.api#documentation": "

Defines the Apache Airflow logs to send to CloudWatch Logs.

" - } - }, - "WeeklyMaintenanceWindowStart": { - "target": "com.amazonaws.mwaa#WeeklyMaintenanceWindowStart", - "traits": { - "smithy.api#documentation": "

The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time to start weekly maintenance updates of your environment in the following format: DAY:HH:MM. For example: TUE:03:30. You can specify a start time in 30 minute increments only.

" - } - }, - "Tags": { - "target": "com.amazonaws.mwaa#TagMap", - "traits": { - "smithy.api#documentation": "

The key-value tag pairs you want to associate to your environment. For example, \"Environment\": \"Staging\". To learn more, see Tagging Amazon Web Services resources.

" - } - }, - "WebserverAccessMode": { - "target": "com.amazonaws.mwaa#WebserverAccessMode", - "traits": { - "smithy.api#documentation": "

The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.

" - } - }, - "MinWorkers": { - "target": "com.amazonaws.mwaa#MinWorkers", - "traits": { - "smithy.api#documentation": "

The minimum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the MaxWorkers field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the worker count you specify in the MinWorkers field. For example, 2.

" - } - }, - "Schedulers": { - "target": "com.amazonaws.mwaa#Schedulers", - "traits": { - "smithy.api#documentation": "

The number of Apache Airflow schedulers to run in your environment. Valid values:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation to create an environment. For more information, see Get started with Amazon Managed Workflows for Apache Airflow.

" - } - }, - "com.amazonaws.mwaa#CreateEnvironmentOutput": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.mwaa#EnvironmentArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) returned in the response for the environment.

" - } - } - } - }, - "com.amazonaws.mwaa#CreateWebLoginToken": { - "type": "operation", - "input": { - "target": "com.amazonaws.mwaa#CreateWebLoginTokenRequest" - }, - "output": { - "target": "com.amazonaws.mwaa#CreateWebLoginTokenResponse" - }, - "errors": [ - { - "target": "com.amazonaws.mwaa#AccessDeniedException" - }, - { - "target": "com.amazonaws.mwaa#InternalServerException" - }, - { - "target": "com.amazonaws.mwaa#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.mwaa#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a web login token for the Airflow Web UI. To learn more, see Creating an Apache Airflow web login token.

", - "smithy.api#endpoint": { - "hostPrefix": "env." - }, - "smithy.api#http": { - "uri": "/webtoken/{Name}", - "method": "POST", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mwaa#CreateWebLoginTokenRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.mwaa#EnvironmentName", - "traits": { - "smithy.api#documentation": "

The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mwaa#CreateWebLoginTokenResponse": { - "type": "structure", - "members": { - "WebToken": { - "target": "com.amazonaws.mwaa#Token", - "traits": { - "smithy.api#documentation": "

An Airflow web server login token.

" - } - }, - "WebServerHostname": { - "target": "com.amazonaws.mwaa#Hostname", - "traits": { - "smithy.api#documentation": "

The Airflow web server hostname for the environment.

" - } - } - } - }, - "com.amazonaws.mwaa#CreatedAt": { - "type": "timestamp" - }, - "com.amazonaws.mwaa#DeleteEnvironment": { - "type": "operation", - "input": { - "target": "com.amazonaws.mwaa#DeleteEnvironmentInput" - }, - "output": { - "target": "com.amazonaws.mwaa#DeleteEnvironmentOutput" - }, - "errors": [ - { - "target": "com.amazonaws.mwaa#InternalServerException" - }, - { - "target": "com.amazonaws.mwaa#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.mwaa#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

", - "smithy.api#endpoint": { - "hostPrefix": "api." - }, - "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/environments/{Name}" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mwaa#DeleteEnvironmentInput": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.mwaa#EnvironmentName", - "traits": { - "smithy.api#documentation": "

The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mwaa#DeleteEnvironmentOutput": { - "type": "structure", - "members": {} - }, - "com.amazonaws.mwaa#Dimension": { - "type": "structure", - "members": { - "Name": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

\n Internal only. The name of the dimension.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

\n Internal only. The value of the dimension.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Internal only. Represents the dimensions of a metric. To learn more about the metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in Amazon CloudWatch.

" - } - }, - "com.amazonaws.mwaa#Dimensions": { - "type": "list", - "member": { - "target": "com.amazonaws.mwaa#Dimension" - } - }, - "com.amazonaws.mwaa#Environment": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.mwaa#EnvironmentName", - "traits": { - "smithy.api#documentation": "

The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

" - } - }, - "Status": { - "target": "com.amazonaws.mwaa#EnvironmentStatus", - "traits": { - "smithy.api#documentation": "

The status of the Amazon MWAA environment. Valid values:

\n \n

We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. To learn more, see Amazon MWAA troubleshooting.

" - } - }, - "Arn": { - "target": "com.amazonaws.mwaa#EnvironmentArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon MWAA environment.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.mwaa#CreatedAt", - "traits": { - "smithy.api#documentation": "

The day and time the environment was created.

" - } - }, - "WebserverUrl": { - "target": "com.amazonaws.mwaa#WebserverUrl", - "traits": { - "smithy.api#documentation": "

The Apache Airflow Web server host name for the Amazon MWAA environment. To learn more, see Accessing the Apache Airflow UI.

" - } - }, - "ExecutionRoleArn": { - "target": "com.amazonaws.mwaa#IamRoleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services resources in your environment. For example, arn:aws:iam::123456789:role/my-execution-role. To learn more, see Amazon MWAA Execution role.

" - } - }, - "ServiceRoleArn": { - "target": "com.amazonaws.mwaa#IamRoleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the service-linked role of the environment. To learn more, see Amazon MWAA Service-linked role.

" - } - }, - "KmsKey": { - "target": "com.amazonaws.mwaa#KmsKey", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Key Management Service (KMS) encryption key used to encrypt the data in your environment.

" - } - }, - "AirflowVersion": { - "target": "com.amazonaws.mwaa#AirflowVersion", - "traits": { - "smithy.api#documentation": "

The Apache Airflow version on your environment. Valid values: 1.10.12, 2.0.2, and 2.2.2.

" - } - }, - "SourceBucketArn": { - "target": "com.amazonaws.mwaa#S3BucketArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, arn:aws:s3:::my-airflow-bucket-unique-name. To learn more, see Create an Amazon S3 bucket for Amazon MWAA.

" - } - }, - "DagS3Path": { - "target": "com.amazonaws.mwaa#RelativePath", - "traits": { - "smithy.api#documentation": "

The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. To learn more, see Adding or updating DAGs.

" - } - }, - "PluginsS3Path": { - "target": "com.amazonaws.mwaa#RelativePath", - "traits": { - "smithy.api#documentation": "

The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip. To learn more, see Installing custom plugins.

" - } - }, - "PluginsS3ObjectVersion": { - "target": "com.amazonaws.mwaa#S3ObjectVersion", - "traits": { - "smithy.api#documentation": "

The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see Installing custom plugins.

" - } - }, - "RequirementsS3Path": { - "target": "com.amazonaws.mwaa#RelativePath", - "traits": { - "smithy.api#documentation": "

The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. To learn more, see Installing Python dependencies.

" - } - }, - "RequirementsS3ObjectVersion": { - "target": "com.amazonaws.mwaa#S3ObjectVersion", - "traits": { - "smithy.api#documentation": "

The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see Installing Python dependencies.

" - } - }, - "AirflowConfigurationOptions": { - "target": "com.amazonaws.mwaa#AirflowConfigurationOptions", - "traits": { - "smithy.api#documentation": "

A list of key-value pairs containing the Apache Airflow configuration options attached to your environment. To learn more, see Apache Airflow configuration options.

" - } - }, - "EnvironmentClass": { - "target": "com.amazonaws.mwaa#EnvironmentClass", - "traits": { - "smithy.api#documentation": "

The environment class type. Valid values: mw1.small, mw1.medium, mw1.large. To learn more, see Amazon MWAA environment class.

" - } - }, - "MaxWorkers": { - "target": "com.amazonaws.mwaa#MaxWorkers", - "traits": { - "smithy.api#documentation": "

The maximum number of workers that run in your environment. For example, 20.

" - } - }, - "NetworkConfiguration": { - "target": "com.amazonaws.mwaa#NetworkConfiguration", - "traits": { - "smithy.api#documentation": "

Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. To learn more, see About networking on Amazon MWAA.

" - } - }, - "LoggingConfiguration": { - "target": "com.amazonaws.mwaa#LoggingConfiguration", - "traits": { - "smithy.api#documentation": "

The Apache Airflow logs published to CloudWatch Logs.

" - } - }, - "LastUpdate": { - "target": "com.amazonaws.mwaa#LastUpdate", - "traits": { - "smithy.api#documentation": "

The status of the last update on the environment.

" - } - }, - "WeeklyMaintenanceWindowStart": { - "target": "com.amazonaws.mwaa#WeeklyMaintenanceWindowStart", - "traits": { - "smithy.api#documentation": "

The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.

" - } - }, - "Tags": { - "target": "com.amazonaws.mwaa#TagMap", - "traits": { - "smithy.api#documentation": "

The key-value tag pairs associated to your environment. For example, \"Environment\": \"Staging\". To learn more, see Tagging Amazon Web Services resources.

" - } - }, - "WebserverAccessMode": { - "target": "com.amazonaws.mwaa#WebserverAccessMode", - "traits": { - "smithy.api#documentation": "

The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.

" - } - }, - "MinWorkers": { - "target": "com.amazonaws.mwaa#MinWorkers", - "traits": { - "smithy.api#documentation": "

The minimum number of workers that run in your environment. For example, 2.

" - } - }, - "Schedulers": { - "target": "com.amazonaws.mwaa#Schedulers", - "traits": { - "smithy.api#documentation": "

The number of Apache Airflow schedulers that run in your Amazon MWAA environment.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

" - } - }, - "com.amazonaws.mwaa#EnvironmentArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1224 - }, - "smithy.api#pattern": "^arn:aws(-[a-z]+)?:airflow:[a-z0-9\\-]+:\\d{12}:environment/\\w+" - } - }, - "com.amazonaws.mwaa#EnvironmentClass": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.mwaa#EnvironmentList": { - "type": "list", - "member": { - "target": "com.amazonaws.mwaa#EnvironmentName" - } - }, - "com.amazonaws.mwaa#EnvironmentName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 80 - }, - "smithy.api#pattern": "^[a-zA-Z][0-9a-zA-Z-_]*$" - } - }, - "com.amazonaws.mwaa#EnvironmentStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "CREATE_FAILED", - "name": "CREATE_FAILED" - }, - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "UPDATING", - "name": "UPDATING" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "DELETED", - "name": "DELETED" - }, - { - "value": "UNAVAILABLE", - "name": "UNAVAILABLE" - }, - { - "value": "UPDATE_FAILED", - "name": "UPDATE_FAILED" - } - ] - } - }, - "com.amazonaws.mwaa#ErrorCode": { - "type": "string" - }, - "com.amazonaws.mwaa#ErrorMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^.+$" - } - }, - "com.amazonaws.mwaa#GetEnvironment": { - "type": "operation", - "input": { - "target": "com.amazonaws.mwaa#GetEnvironmentInput" - }, - "output": { - "target": "com.amazonaws.mwaa#GetEnvironmentOutput" - }, - "errors": [ - { - "target": "com.amazonaws.mwaa#InternalServerException" - }, - { - "target": "com.amazonaws.mwaa#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.mwaa#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

", - "smithy.api#endpoint": { - "hostPrefix": "api." - }, - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/environments/{Name}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.mwaa#GetEnvironmentInput": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.mwaa#EnvironmentName", - "traits": { - "smithy.api#documentation": "

The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mwaa#GetEnvironmentOutput": { - "type": "structure", - "members": { - "Environment": { - "target": "com.amazonaws.mwaa#Environment", - "traits": { - "smithy.api#documentation": "

An object containing all available details about the environment.

" - } - } - } - }, - "com.amazonaws.mwaa#Hostname": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$" - } - }, - "com.amazonaws.mwaa#IamRoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1224 - }, - "smithy.api#pattern": "^arn:aws(-[a-z]+)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" - } - }, - "com.amazonaws.mwaa#InternalServerException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String" - } - }, - "traits": { - "smithy.api#documentation": "

InternalServerException: An internal error has occurred.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.mwaa#KmsKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1224 - }, - "smithy.api#pattern": "^(((arn:aws(-[a-z]+)?:kms:[a-z]{2}-[a-z]+-\\d:\\d+:)?key\\/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|(arn:aws(-[a-z]+)?:kms:[a-z]{2}-[a-z]+-\\d:\\d+:)?alias/.+)$" - } - }, - "com.amazonaws.mwaa#LastUpdate": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.mwaa#UpdateStatus", - "traits": { - "smithy.api#documentation": "

The status of the last update on the environment.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.mwaa#UpdateCreatedAt", - "traits": { - "smithy.api#documentation": "

The day and time of the last update on the environment.

" - } - }, - "Error": { - "target": "com.amazonaws.mwaa#UpdateError", - "traits": { - "smithy.api#documentation": "

The error that was encountered during the last update of the environment.

" - } - }, - "Source": { - "target": "com.amazonaws.mwaa#UpdateSource", - "traits": { - "smithy.api#documentation": "

The source of the last update to the environment. Includes internal processes by Amazon MWAA, such as an environment maintenance update.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the status of the last update on the environment, and any errors that were encountered.

" - } - }, - "com.amazonaws.mwaa#ListEnvironments": { - "type": "operation", - "input": { - "target": "com.amazonaws.mwaa#ListEnvironmentsInput" - }, - "output": { - "target": "com.amazonaws.mwaa#ListEnvironmentsOutput" - }, - "errors": [ - { - "target": "com.amazonaws.mwaa#InternalServerException" - }, - { - "target": "com.amazonaws.mwaa#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.

", - "smithy.api#endpoint": { - "hostPrefix": "api." - }, - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/environments" - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults", - "items": "Environments" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.mwaa#ListEnvironmentsInput": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.mwaa#NextToken", - "traits": { - "smithy.api#documentation": "

Retrieves the next page of the results.

", - "smithy.api#httpQuery": "NextToken" - } - }, - "MaxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of results to retrieve per page. For example, 5 environments per page.

", - "smithy.api#httpQuery": "MaxResults", - "smithy.api#range": { - "min": 1, - "max": 25 - } - } - } - } - }, - "com.amazonaws.mwaa#ListEnvironmentsOutput": { - "type": "structure", - "members": { - "Environments": { - "target": "com.amazonaws.mwaa#EnvironmentList", - "traits": { - "smithy.api#documentation": "

Returns a list of Amazon MWAA environments.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.mwaa#NextToken", - "traits": { - "smithy.api#documentation": "

Retrieves the next page of the results.

" - } - } - } - }, - "com.amazonaws.mwaa#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.mwaa#ListTagsForResourceInput" - }, - "output": { - "target": "com.amazonaws.mwaa#ListTagsForResourceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.mwaa#InternalServerException" - }, - { - "target": "com.amazonaws.mwaa#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.mwaa#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, \"Environment\": \"Staging\".

", - "smithy.api#endpoint": { - "hostPrefix": "api." - }, - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/tags/{ResourceArn}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.mwaa#ListTagsForResourceInput": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.mwaa#EnvironmentArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mwaa#ListTagsForResourceOutput": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.mwaa#TagMap", - "traits": { - "smithy.api#documentation": "

The key-value tag pairs associated to your environment. To learn more, see Tagging Amazon Web Services resources.

" - } - } - } - }, - "com.amazonaws.mwaa#LoggingConfiguration": { - "type": "structure", - "members": { - "DagProcessingLogs": { - "target": "com.amazonaws.mwaa#ModuleLoggingConfiguration", - "traits": { - "smithy.api#documentation": "

The Airflow DAG processing logs published to CloudWatch Logs and the log level.

" - } - }, - "SchedulerLogs": { - "target": "com.amazonaws.mwaa#ModuleLoggingConfiguration", - "traits": { - "smithy.api#documentation": "

The Airflow scheduler logs published to CloudWatch Logs and the log level.

" - } - }, - "WebserverLogs": { - "target": "com.amazonaws.mwaa#ModuleLoggingConfiguration", - "traits": { - "smithy.api#documentation": "

The Airflow web server logs published to CloudWatch Logs and the log level.

" - } - }, - "WorkerLogs": { - "target": "com.amazonaws.mwaa#ModuleLoggingConfiguration", - "traits": { - "smithy.api#documentation": "

The Airflow worker logs published to CloudWatch Logs and the log level.

" - } - }, - "TaskLogs": { - "target": "com.amazonaws.mwaa#ModuleLoggingConfiguration", - "traits": { - "smithy.api#documentation": "

The Airflow task logs published to CloudWatch Logs and the log level.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Apache Airflow log types that are published to CloudWatch Logs.

" - } - }, - "com.amazonaws.mwaa#LoggingConfigurationInput": { - "type": "structure", - "members": { - "DagProcessingLogs": { - "target": "com.amazonaws.mwaa#ModuleLoggingConfigurationInput", - "traits": { - "smithy.api#documentation": "

Publishes Airflow DAG processing logs to CloudWatch Logs.

" - } - }, - "SchedulerLogs": { - "target": "com.amazonaws.mwaa#ModuleLoggingConfigurationInput", - "traits": { - "smithy.api#documentation": "

Publishes Airflow scheduler logs to CloudWatch Logs.

" - } - }, - "WebserverLogs": { - "target": "com.amazonaws.mwaa#ModuleLoggingConfigurationInput", - "traits": { - "smithy.api#documentation": "

Publishes Airflow web server logs to CloudWatch Logs.

" - } - }, - "WorkerLogs": { - "target": "com.amazonaws.mwaa#ModuleLoggingConfigurationInput", - "traits": { - "smithy.api#documentation": "

Publishes Airflow worker logs to CloudWatch Logs.

" - } - }, - "TaskLogs": { - "target": "com.amazonaws.mwaa#ModuleLoggingConfigurationInput", - "traits": { - "smithy.api#documentation": "

Publishes Airflow task logs to CloudWatch Logs.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Defines the Apache Airflow log types to send to CloudWatch Logs.

" - } - }, - "com.amazonaws.mwaa#LoggingEnabled": { - "type": "boolean" - }, - "com.amazonaws.mwaa#LoggingLevel": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CRITICAL", - "name": "CRITICAL" - }, - { - "value": "ERROR", - "name": "ERROR" - }, - { - "value": "WARNING", - "name": "WARNING" - }, - { - "value": "INFO", - "name": "INFO" - }, - { - "value": "DEBUG", - "name": "DEBUG" - } - ] - } - }, - "com.amazonaws.mwaa#MaxWorkers": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.mwaa#MetricData": { - "type": "list", - "member": { - "target": "com.amazonaws.mwaa#MetricDatum" - } - }, - "com.amazonaws.mwaa#MetricDatum": { - "type": "structure", - "members": { - "MetricName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

\n Internal only. The name of the metric.

", - "smithy.api#required": {} - } - }, - "Timestamp": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

\n Internal only. The time the metric data was received.

", - "smithy.api#required": {} - } - }, - "Dimensions": { - "target": "com.amazonaws.mwaa#Dimensions", - "traits": { - "smithy.api#documentation": "

\n Internal only. The dimensions associated with the metric.

" - } - }, - "Value": { - "target": "smithy.api#Double", - "traits": { - "smithy.api#documentation": "

\n Internal only. The value for the metric.

" - } - }, - "Unit": { - "target": "com.amazonaws.mwaa#Unit", - "traits": { - "smithy.api#documentation": "

\n Internal only. The unit used to store the metric.

" - } - }, - "StatisticValues": { - "target": "com.amazonaws.mwaa#StatisticSet", - "traits": { - "smithy.api#documentation": "

\n Internal only. The statistical values for the metric.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Internal only. Collects Apache Airflow metrics. To learn more about the metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in Amazon CloudWatch.

" - } - }, - "com.amazonaws.mwaa#MinWorkers": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.mwaa#ModuleLoggingConfiguration": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.mwaa#LoggingEnabled", - "traits": { - "smithy.api#documentation": "

Indicates whether the Apache Airflow log type (e.g. DagProcessingLogs) is enabled.

" - } - }, - "LogLevel": { - "target": "com.amazonaws.mwaa#LoggingLevel", - "traits": { - "smithy.api#documentation": "

The Apache Airflow log level for the log type (e.g. DagProcessingLogs).

" - } - }, - "CloudWatchLogGroupArn": { - "target": "com.amazonaws.mwaa#CloudWatchLogGroupArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the CloudWatch Logs group where the Apache Airflow log type (e.g. DagProcessingLogs) is published. For example, arn:aws:logs:us-east-1:123456789012:log-group:airflow-MyMWAAEnvironment-MwaaEnvironment-DAGProcessing:*.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Apache Airflow log details for the log type (e.g. DagProcessingLogs).

" - } - }, - "com.amazonaws.mwaa#ModuleLoggingConfigurationInput": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.mwaa#LoggingEnabled", - "traits": { - "smithy.api#documentation": "

Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs).

", - "smithy.api#required": {} - } - }, - "LogLevel": { - "target": "com.amazonaws.mwaa#LoggingLevel", - "traits": { - "smithy.api#documentation": "

Defines the Apache Airflow log level (e.g. INFO) to send to CloudWatch Logs.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Enables the Apache Airflow log type (e.g. DagProcessingLogs) and defines the log level to send to CloudWatch Logs (e.g. INFO).

" - } - }, - "com.amazonaws.mwaa#NetworkConfiguration": { - "type": "structure", - "members": { - "SubnetIds": { - "target": "com.amazonaws.mwaa#SubnetList", - "traits": { - "smithy.api#documentation": "

A list of subnet IDs. To learn more, see About networking on Amazon MWAA.

" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.mwaa#SecurityGroupList", - "traits": { - "smithy.api#documentation": "

A list of security group IDs. To learn more, see Security in your VPC on Amazon MWAA.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. To learn more, see About networking on Amazon MWAA.

" - } - }, - "com.amazonaws.mwaa#NextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - } - } - }, - "com.amazonaws.mwaa#PublishMetrics": { - "type": "operation", - "input": { - "target": "com.amazonaws.mwaa#PublishMetricsInput" - }, - "output": { - "target": "com.amazonaws.mwaa#PublishMetricsOutput" - }, - "errors": [ - { - "target": "com.amazonaws.mwaa#InternalServerException" - }, - { - "target": "com.amazonaws.mwaa#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Internal only. Publishes environment health metrics to Amazon CloudWatch.

", - "smithy.api#endpoint": { - "hostPrefix": "ops." - }, - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/metrics/environments/{EnvironmentName}" - } - } - }, - "com.amazonaws.mwaa#PublishMetricsInput": { - "type": "structure", - "members": { - "EnvironmentName": { - "target": "com.amazonaws.mwaa#EnvironmentName", - "traits": { - "smithy.api#documentation": "

\n Internal only. The name of the environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MetricData": { - "target": "com.amazonaws.mwaa#MetricData", - "traits": { - "smithy.api#documentation": "

\n Internal only. Publishes metrics to Amazon CloudWatch. To learn more about the metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in Amazon CloudWatch.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mwaa#PublishMetricsOutput": { - "type": "structure", - "members": {} - }, - "com.amazonaws.mwaa#RelativePath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.mwaa#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String" - } - }, - "traits": { - "smithy.api#documentation": "

ResourceNotFoundException: The resource is not available.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.mwaa#S3BucketArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1224 - }, - "smithy.api#pattern": "^arn:aws(-[a-z]+)?:s3:::[a-z0-9.\\-]+$" - } - }, - "com.amazonaws.mwaa#S3ObjectVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.mwaa#Schedulers": { - "type": "integer", - "traits": { - "smithy.api#range": { - "max": 5 - } - } - }, - "com.amazonaws.mwaa#SecurityGroupId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^sg-[a-zA-Z0-9\\-._]+$" - } - }, - "com.amazonaws.mwaa#SecurityGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.mwaa#SecurityGroupId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.mwaa#StatisticSet": { - "type": "structure", - "members": { - "SampleCount": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

\n Internal only. The number of samples used for the statistic set.

" - } - }, - "Sum": { - "target": "smithy.api#Double", - "traits": { - "smithy.api#documentation": "

\n Internal only. The sum of values for the sample set.

" - } - }, - "Minimum": { - "target": "smithy.api#Double", - "traits": { - "smithy.api#documentation": "

\n Internal only. The minimum value of the sample set.

" - } - }, - "Maximum": { - "target": "smithy.api#Double", - "traits": { - "smithy.api#documentation": "

\n Internal only. The maximum value of the sample set.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Internal only. Represents a set of statistics that describe a specific metric. To learn more about the metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in Amazon CloudWatch.

" - } - }, - "com.amazonaws.mwaa#SubnetId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^subnet-[a-zA-Z0-9\\-._]+$" - } - }, - "com.amazonaws.mwaa#SubnetList": { - "type": "list", - "member": { - "target": "com.amazonaws.mwaa#SubnetId" - }, - "traits": { - "smithy.api#length": { - "min": 2, - "max": 2 - } - } - }, - "com.amazonaws.mwaa#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - } - }, - "com.amazonaws.mwaa#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.mwaa#TagKey" - }, - "traits": { - "smithy.api#length": { - "max": 50 - } - } - }, - "com.amazonaws.mwaa#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.mwaa#TagKey" - }, - "value": { - "target": "com.amazonaws.mwaa#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.mwaa#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.mwaa#TagResourceInput" - }, - "output": { - "target": "com.amazonaws.mwaa#TagResourceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.mwaa#InternalServerException" - }, - { - "target": "com.amazonaws.mwaa#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.mwaa#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.

", - "smithy.api#endpoint": { - "hostPrefix": "api." - }, - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/tags/{ResourceArn}" - } - } - }, - "com.amazonaws.mwaa#TagResourceInput": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.mwaa#EnvironmentArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.mwaa#TagMap", - "traits": { - "smithy.api#documentation": "

The key-value tag pairs you want to associate to your environment. For example, \"Environment\": \"Staging\". To learn more, see Tagging Amazon Web Services resources.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mwaa#TagResourceOutput": { - "type": "structure", - "members": {} - }, - "com.amazonaws.mwaa#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - } - }, - "com.amazonaws.mwaa#Token": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.mwaa#Unit": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Seconds", - "name": "SECONDS" - }, - { - "value": "Microseconds", - "name": "MICROSECONDS" - }, - { - "value": "Milliseconds", - "name": "MILLISECONDS" - }, - { - "value": "Bytes", - "name": "BYTES" - }, - { - "value": "Kilobytes", - "name": "KILOBYTES" - }, - { - "value": "Megabytes", - "name": "MEGABYTES" - }, - { - "value": "Gigabytes", - "name": "GIGABYTES" - }, - { - "value": "Terabytes", - "name": "TERABYTES" - }, - { - "value": "Bits", - "name": "BITS" - }, - { - "value": "Kilobits", - "name": "KILOBITS" - }, - { - "value": "Megabits", - "name": "MEGABITS" - }, - { - "value": "Gigabits", - "name": "GIGABITS" - }, - { - "value": "Terabits", - "name": "TERABITS" - }, - { - "value": "Percent", - "name": "PERCENT" - }, - { - "value": "Count", - "name": "COUNT" - }, - { - "value": "Bytes/Second", - "name": "BYTES_PER_SECOND" - }, - { - "value": "Kilobytes/Second", - "name": "KILOBYTES_PER_SECOND" - }, - { - "value": "Megabytes/Second", - "name": "MEGABYTES_PER_SECOND" - }, - { - "value": "Gigabytes/Second", - "name": "GIGABYTES_PER_SECOND" - }, - { - "value": "Terabytes/Second", - "name": "TERABYTES_PER_SECOND" - }, - { - "value": "Bits/Second", - "name": "BITS_PER_SECOND" - }, - { - "value": "Kilobits/Second", - "name": "KILOBITS_PER_SECOND" - }, - { - "value": "Megabits/Second", - "name": "MEGABITS_PER_SECOND" - }, - { - "value": "Gigabits/Second", - "name": "GIGABITS_PER_SECOND" - }, - { - "value": "Terabits/Second", - "name": "TERABITS_PER_SECOND" - }, - { - "value": "Count/Second", - "name": "COUNT_PER_SECOND" - }, - { - "value": "None", - "name": "NONE" - } - ] - } - }, - "com.amazonaws.mwaa#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.mwaa#UntagResourceInput" - }, - "output": { - "target": "com.amazonaws.mwaa#UntagResourceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.mwaa#InternalServerException" - }, - { - "target": "com.amazonaws.mwaa#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.mwaa#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, \"Environment\": \"Staging\".

", - "smithy.api#endpoint": { - "hostPrefix": "api." - }, - "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/tags/{ResourceArn}" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mwaa#UntagResourceInput": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.mwaa#EnvironmentArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tagKeys": { - "target": "com.amazonaws.mwaa#TagKeyList", - "traits": { - "smithy.api#documentation": "

The key-value tag pair you want to remove. For example, \"Environment\": \"Staging\".

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mwaa#UntagResourceOutput": { - "type": "structure", - "members": {} - }, - "com.amazonaws.mwaa#UpdateCreatedAt": { - "type": "timestamp" - }, - "com.amazonaws.mwaa#UpdateEnvironment": { - "type": "operation", - "input": { - "target": "com.amazonaws.mwaa#UpdateEnvironmentInput" - }, - "output": { - "target": "com.amazonaws.mwaa#UpdateEnvironmentOutput" - }, - "errors": [ - { - "target": "com.amazonaws.mwaa#InternalServerException" - }, - { - "target": "com.amazonaws.mwaa#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.mwaa#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

", - "smithy.api#endpoint": { - "hostPrefix": "api." - }, - "smithy.api#http": { - "code": 200, - "method": "PATCH", - "uri": "/environments/{Name}" - } - } - }, - "com.amazonaws.mwaa#UpdateEnvironmentInput": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.mwaa#EnvironmentName", - "traits": { - "smithy.api#documentation": "

The name of your Amazon MWAA environment. For example, MyMWAAEnvironment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExecutionRoleArn": { - "target": "com.amazonaws.mwaa#IamRoleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services resources in your environment. For example, arn:aws:iam::123456789:role/my-execution-role. To learn more, see Amazon MWAA Execution role.

" - } - }, - "AirflowVersion": { - "target": "com.amazonaws.mwaa#AirflowVersion", - "traits": { - "smithy.api#documentation": "

The Apache Airflow version for your environment. If no value is specified, defaults to the latest version.\n Valid values: 1.10.12, 2.0.2, and 2.2.2.

" - } - }, - "SourceBucketArn": { - "target": "com.amazonaws.mwaa#S3BucketArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, arn:aws:s3:::my-airflow-bucket-unique-name. To learn more, see Create an Amazon S3 bucket for Amazon MWAA.

" - } - }, - "DagS3Path": { - "target": "com.amazonaws.mwaa#RelativePath", - "traits": { - "smithy.api#documentation": "

The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. To learn more, see Adding or updating DAGs.

" - } - }, - "PluginsS3Path": { - "target": "com.amazonaws.mwaa#RelativePath", - "traits": { - "smithy.api#documentation": "

The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip. If specified, then the plugins.zip version is required. To learn more, see Installing custom plugins.

" - } - }, - "PluginsS3ObjectVersion": { - "target": "com.amazonaws.mwaa#S3ObjectVersion", - "traits": { - "smithy.api#documentation": "

The version of the plugins.zip file on your Amazon S3 bucket. A version must be specified each time a plugins.zip file is updated. To learn more, see How S3 Versioning works.

" - } - }, - "RequirementsS3Path": { - "target": "com.amazonaws.mwaa#RelativePath", - "traits": { - "smithy.api#documentation": "

The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. If specified, then a file version is required. To learn more, see Installing Python dependencies.

" - } - }, - "RequirementsS3ObjectVersion": { - "target": "com.amazonaws.mwaa#S3ObjectVersion", - "traits": { - "smithy.api#documentation": "

The version of the requirements.txt file on your Amazon S3 bucket. A version must be specified each time a requirements.txt file is updated. To learn more, see How S3 Versioning works.

" - } - }, - "AirflowConfigurationOptions": { - "target": "com.amazonaws.mwaa#AirflowConfigurationOptions", - "traits": { - "smithy.api#documentation": "

A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. To learn more, see Apache Airflow configuration options.

" - } - }, - "EnvironmentClass": { - "target": "com.amazonaws.mwaa#EnvironmentClass", - "traits": { - "smithy.api#documentation": "

The environment class type. Valid values: mw1.small, mw1.medium, mw1.large. To learn more, see Amazon MWAA environment class.

" - } - }, - "MaxWorkers": { - "target": "com.amazonaws.mwaa#MaxWorkers", - "traits": { - "smithy.api#documentation": "

The maximum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the MaxWorkers field. For example, 20. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the one worker that is included with your environment, or the number you specify in MinWorkers.

" - } - }, - "NetworkConfiguration": { - "target": "com.amazonaws.mwaa#UpdateNetworkConfigurationInput", - "traits": { - "smithy.api#documentation": "

The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. To learn more, see About networking on Amazon MWAA.

" - } - }, - "LoggingConfiguration": { - "target": "com.amazonaws.mwaa#LoggingConfigurationInput", - "traits": { - "smithy.api#documentation": "

The Apache Airflow log types to send to CloudWatch Logs.

" - } - }, - "WeeklyMaintenanceWindowStart": { - "target": "com.amazonaws.mwaa#WeeklyMaintenanceWindowStart", - "traits": { - "smithy.api#documentation": "

The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time to start weekly maintenance updates of your environment in the following format: DAY:HH:MM. For example: TUE:03:30. You can specify a start time in 30 minute increments only.

" - } - }, - "WebserverAccessMode": { - "target": "com.amazonaws.mwaa#WebserverAccessMode", - "traits": { - "smithy.api#documentation": "

The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.

" - } - }, - "MinWorkers": { - "target": "com.amazonaws.mwaa#MinWorkers", - "traits": { - "smithy.api#documentation": "

The minimum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the MaxWorkers field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the worker count you specify in the MinWorkers field. For example, 2.

" - } - }, - "Schedulers": { - "target": "com.amazonaws.mwaa#Schedulers", - "traits": { - "smithy.api#documentation": "

The number of Apache Airflow schedulers to run in your Amazon MWAA environment.

" - } - } - } - }, - "com.amazonaws.mwaa#UpdateEnvironmentOutput": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.mwaa#EnvironmentArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.

" - } - } - } - }, - "com.amazonaws.mwaa#UpdateError": { - "type": "structure", - "members": { - "ErrorCode": { - "target": "com.amazonaws.mwaa#ErrorCode", - "traits": { - "smithy.api#documentation": "

The error code that corresponds to the error with the last update.

" - } - }, - "ErrorMessage": { - "target": "com.amazonaws.mwaa#ErrorMessage", - "traits": { - "smithy.api#documentation": "

The error message that corresponds to the error code.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the error(s) encountered with the last update of the environment.

" - } - }, - "com.amazonaws.mwaa#UpdateNetworkConfigurationInput": { - "type": "structure", - "members": { - "SecurityGroupIds": { - "target": "com.amazonaws.mwaa#SecurityGroupList", - "traits": { - "smithy.api#documentation": "

A list of security group IDs. A security group must be attached to the same VPC as the subnets. To learn more, see Security in your VPC on Amazon MWAA.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Defines the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. To learn more, see About networking on Amazon MWAA.

" - } - }, - "com.amazonaws.mwaa#UpdateSource": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^.+$" - } - }, - "com.amazonaws.mwaa#UpdateStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SUCCESS", - "name": "SUCCESS" - }, - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "FAILED", - "name": "FAILED" - } - ] - } - }, - "com.amazonaws.mwaa#ValidationException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String" + "traits": { + "smithy.api#documentation": "

ValidationException: The provided input is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.mwaa#WebserverAccessMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PRIVATE_ONLY", + "name": "PRIVATE_ONLY" + }, + { + "value": "PUBLIC_ONLY", + "name": "PUBLIC_ONLY" + } + ] + } + }, + "com.amazonaws.mwaa#WebserverUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^https://.+$" + } + }, + "com.amazonaws.mwaa#WeeklyMaintenanceWindowStart": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 9 + }, + "smithy.api#pattern": "(MON|TUE|WED|THU|FRI|SAT|SUN):([01]\\d|2[0-3]):(00|30)" + } } - }, - "traits": { - "smithy.api#documentation": "

ValidationException: The provided input is not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.mwaa#WebserverAccessMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PRIVATE_ONLY", - "name": "PRIVATE_ONLY" - }, - { - "value": "PUBLIC_ONLY", - "name": "PUBLIC_ONLY" - } - ] - } - }, - "com.amazonaws.mwaa#WebserverUrl": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^https://.+$" - } - }, - "com.amazonaws.mwaa#WeeklyMaintenanceWindowStart": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 9 - }, - "smithy.api#pattern": "(MON|TUE|WED|THU|FRI|SAT|SUN):([01]\\d|2[0-3]):(00|30)" - } } - } } \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/rds.json b/codegen/sdk-codegen/aws-models/rds.json index e6189099eb9d..d602e8881042 100644 --- a/codegen/sdk-codegen/aws-models/rds.json +++ b/codegen/sdk-codegen/aws-models/rds.json @@ -1,24311 +1,24368 @@ { - "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.rds#AccountAttributesMessage": { - "type": "structure", - "members": { - "AccountQuotas": { - "target": "com.amazonaws.rds#AccountQuotaList", - "traits": { - "smithy.api#documentation": "

A list of AccountQuota objects. Within this list, each quota has a name, \n a count of usage toward the quota maximum, and a maximum value for the quota.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Data returned by the DescribeAccountAttributes action.

" - } - }, - "com.amazonaws.rds#AccountQuota": { - "type": "structure", - "members": { - "AccountQuotaName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon RDS quota for this Amazon Web Services account.

" - } - }, - "Used": { - "target": "com.amazonaws.rds#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount currently used toward the quota maximum.

" - } - }, - "Max": { - "target": "com.amazonaws.rds#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum allowed value for the quota.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a quota for an Amazon Web Services account.

\n

The following are account quotas:

\n \n

For more information, see Quotas for Amazon RDS in the\n Amazon RDS User Guide and Quotas for Amazon Aurora in the\n Amazon Aurora User Guide.

" - } - }, - "com.amazonaws.rds#AccountQuotaList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#AccountQuota", - "traits": { - "smithy.api#xmlName": "AccountQuota" - } - } - }, - "com.amazonaws.rds#ActivityStreamMode": { - "type": "enum", - "members": { - "sync": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sync" - } - }, - "async": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "async" - } - } - } - }, - "com.amazonaws.rds#ActivityStreamModeList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String" - } - }, - "com.amazonaws.rds#ActivityStreamPolicyStatus": { - "type": "enum", - "members": { - "locked": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "locked" - } - }, - "unlocked": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unlocked" - } - }, - "locking_policy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "locking-policy" - } - }, - "unlocking_policy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unlocking-policy" - } - } - } - }, - "com.amazonaws.rds#ActivityStreamStatus": { - "type": "enum", - "members": { - "stopped": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "stopped" - } - }, - "starting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "starting" - } - }, - "started": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "started" - } - }, - "stopping": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "stopping" - } - } - } - }, - "com.amazonaws.rds#AddRoleToDBCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#AddRoleToDBClusterMessage" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterRoleAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBClusterRoleQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Associates an Identity and Access Management (IAM) role with a DB cluster.

" - } - }, - "com.amazonaws.rds#AddRoleToDBClusterMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster to associate the IAM role with.

", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB\n cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.

", - "smithy.api#required": {} - } - }, - "FeatureName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the feature for the DB cluster that the IAM role is to be associated with. \n For information about supported feature names, see DBEngineVersion.

" - } - } - } - }, - "com.amazonaws.rds#AddRoleToDBInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#AddRoleToDBInstanceMessage" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceRoleAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceRoleQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.

\n \n

To add a role to a DB instance, the status of the DB instance must be available.

\n \n

This command doesn't apply to RDS Custom.

" - } - }, - "com.amazonaws.rds#AddRoleToDBInstanceMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB instance to associate the IAM role with.

", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for\n example arn:aws:iam::123456789012:role/AccessRole.

", - "smithy.api#required": {} - } - }, - "FeatureName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the feature for the DB instance that the IAM role is to be associated with. \n For information about supported feature names, see DBEngineVersion.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.rds#AddSourceIdentifierToSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#AddSourceIdentifierToSubscriptionMessage" - }, - "output": { - "target": "com.amazonaws.rds#AddSourceIdentifierToSubscriptionResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#SourceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#SubscriptionNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Adds a source identifier to an existing RDS event notification subscription.

" - } - }, - "com.amazonaws.rds#AddSourceIdentifierToSubscriptionMessage": { - "type": "structure", - "members": { - "SubscriptionName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the RDS event notification subscription you want to add a source identifier to.

", - "smithy.api#required": {} - } - }, - "SourceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the event source to be added.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#AddSourceIdentifierToSubscriptionResult": { - "type": "structure", - "members": { - "EventSubscription": { - "target": "com.amazonaws.rds#EventSubscription" - } - } - }, - "com.amazonaws.rds#AddTagsToResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#AddTagsToResourceMessage" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.

\n

For an overview on tagging Amazon RDS resources, \n see Tagging Amazon RDS Resources.

" - } - }, - "com.amazonaws.rds#AddTagsToResourceMessage": { - "type": "structure", - "members": { - "ResourceName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, \n see \n Constructing an RDS Amazon Resource Name (ARN).

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

The tags to be assigned to the Amazon RDS resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#AmazonRDSv19": { - "type": "service", - "version": "2014-10-31", - "operations": [ - { - "target": "com.amazonaws.rds#AddRoleToDBCluster" - }, - { - "target": "com.amazonaws.rds#AddRoleToDBInstance" - }, - { - "target": "com.amazonaws.rds#AddSourceIdentifierToSubscription" - }, - { - "target": "com.amazonaws.rds#AddTagsToResource" - }, - { - "target": "com.amazonaws.rds#ApplyPendingMaintenanceAction" - }, - { - "target": "com.amazonaws.rds#AuthorizeDBSecurityGroupIngress" - }, - { - "target": "com.amazonaws.rds#BacktrackDBCluster" - }, - { - "target": "com.amazonaws.rds#CancelExportTask" - }, - { - "target": "com.amazonaws.rds#CopyDBClusterParameterGroup" - }, - { - "target": "com.amazonaws.rds#CopyDBClusterSnapshot" - }, - { - "target": "com.amazonaws.rds#CopyDBParameterGroup" - }, - { - "target": "com.amazonaws.rds#CopyDBSnapshot" - }, - { - "target": "com.amazonaws.rds#CopyOptionGroup" - }, - { - "target": "com.amazonaws.rds#CreateBlueGreenDeployment" - }, - { - "target": "com.amazonaws.rds#CreateCustomDBEngineVersion" - }, - { - "target": "com.amazonaws.rds#CreateDBCluster" - }, - { - "target": "com.amazonaws.rds#CreateDBClusterEndpoint" - }, - { - "target": "com.amazonaws.rds#CreateDBClusterParameterGroup" - }, - { - "target": "com.amazonaws.rds#CreateDBClusterSnapshot" - }, - { - "target": "com.amazonaws.rds#CreateDBInstance" - }, - { - "target": "com.amazonaws.rds#CreateDBInstanceReadReplica" - }, - { - "target": "com.amazonaws.rds#CreateDBParameterGroup" - }, - { - "target": "com.amazonaws.rds#CreateDBProxy" - }, - { - "target": "com.amazonaws.rds#CreateDBProxyEndpoint" - }, - { - "target": "com.amazonaws.rds#CreateDBSecurityGroup" - }, - { - "target": "com.amazonaws.rds#CreateDBSnapshot" - }, - { - "target": "com.amazonaws.rds#CreateDBSubnetGroup" - }, - { - "target": "com.amazonaws.rds#CreateEventSubscription" - }, - { - "target": "com.amazonaws.rds#CreateGlobalCluster" - }, - { - "target": "com.amazonaws.rds#CreateOptionGroup" - }, - { - "target": "com.amazonaws.rds#DeleteBlueGreenDeployment" - }, - { - "target": "com.amazonaws.rds#DeleteCustomDBEngineVersion" - }, - { - "target": "com.amazonaws.rds#DeleteDBCluster" - }, - { - "target": "com.amazonaws.rds#DeleteDBClusterEndpoint" - }, - { - "target": "com.amazonaws.rds#DeleteDBClusterParameterGroup" - }, - { - "target": "com.amazonaws.rds#DeleteDBClusterSnapshot" - }, - { - "target": "com.amazonaws.rds#DeleteDBInstance" - }, - { - "target": "com.amazonaws.rds#DeleteDBInstanceAutomatedBackup" - }, - { - "target": "com.amazonaws.rds#DeleteDBParameterGroup" - }, - { - "target": "com.amazonaws.rds#DeleteDBProxy" - }, - { - "target": "com.amazonaws.rds#DeleteDBProxyEndpoint" - }, - { - "target": "com.amazonaws.rds#DeleteDBSecurityGroup" - }, - { - "target": "com.amazonaws.rds#DeleteDBSnapshot" - }, - { - "target": "com.amazonaws.rds#DeleteDBSubnetGroup" - }, - { - "target": "com.amazonaws.rds#DeleteEventSubscription" - }, - { - "target": "com.amazonaws.rds#DeleteGlobalCluster" - }, - { - "target": "com.amazonaws.rds#DeleteOptionGroup" - }, - { - "target": "com.amazonaws.rds#DeregisterDBProxyTargets" - }, - { - "target": "com.amazonaws.rds#DescribeAccountAttributes" - }, - { - "target": "com.amazonaws.rds#DescribeBlueGreenDeployments" - }, - { - "target": "com.amazonaws.rds#DescribeCertificates" - }, - { - "target": "com.amazonaws.rds#DescribeDBClusterBacktracks" - }, - { - "target": "com.amazonaws.rds#DescribeDBClusterEndpoints" - }, - { - "target": "com.amazonaws.rds#DescribeDBClusterParameterGroups" - }, - { - "target": "com.amazonaws.rds#DescribeDBClusterParameters" - }, - { - "target": "com.amazonaws.rds#DescribeDBClusters" - }, - { - "target": "com.amazonaws.rds#DescribeDBClusterSnapshotAttributes" - }, - { - "target": "com.amazonaws.rds#DescribeDBClusterSnapshots" - }, - { - "target": "com.amazonaws.rds#DescribeDBEngineVersions" - }, - { - "target": "com.amazonaws.rds#DescribeDBInstanceAutomatedBackups" - }, - { - "target": "com.amazonaws.rds#DescribeDBInstances" - }, - { - "target": "com.amazonaws.rds#DescribeDBLogFiles" - }, - { - "target": "com.amazonaws.rds#DescribeDBParameterGroups" - }, - { - "target": "com.amazonaws.rds#DescribeDBParameters" - }, - { - "target": "com.amazonaws.rds#DescribeDBProxies" - }, - { - "target": "com.amazonaws.rds#DescribeDBProxyEndpoints" - }, - { - "target": "com.amazonaws.rds#DescribeDBProxyTargetGroups" - }, - { - "target": "com.amazonaws.rds#DescribeDBProxyTargets" - }, - { - "target": "com.amazonaws.rds#DescribeDBSecurityGroups" - }, - { - "target": "com.amazonaws.rds#DescribeDBSnapshotAttributes" - }, - { - "target": "com.amazonaws.rds#DescribeDBSnapshots" - }, - { - "target": "com.amazonaws.rds#DescribeDBSubnetGroups" - }, - { - "target": "com.amazonaws.rds#DescribeEngineDefaultClusterParameters" - }, - { - "target": "com.amazonaws.rds#DescribeEngineDefaultParameters" - }, - { - "target": "com.amazonaws.rds#DescribeEventCategories" - }, - { - "target": "com.amazonaws.rds#DescribeEvents" - }, - { - "target": "com.amazonaws.rds#DescribeEventSubscriptions" - }, - { - "target": "com.amazonaws.rds#DescribeExportTasks" - }, - { - "target": "com.amazonaws.rds#DescribeGlobalClusters" - }, - { - "target": "com.amazonaws.rds#DescribeOptionGroupOptions" - }, - { - "target": "com.amazonaws.rds#DescribeOptionGroups" - }, - { - "target": "com.amazonaws.rds#DescribeOrderableDBInstanceOptions" - }, - { - "target": "com.amazonaws.rds#DescribePendingMaintenanceActions" - }, - { - "target": "com.amazonaws.rds#DescribeReservedDBInstances" - }, - { - "target": "com.amazonaws.rds#DescribeReservedDBInstancesOfferings" - }, - { - "target": "com.amazonaws.rds#DescribeSourceRegions" - }, - { - "target": "com.amazonaws.rds#DescribeValidDBInstanceModifications" - }, - { - "target": "com.amazonaws.rds#DownloadDBLogFilePortion" - }, - { - "target": "com.amazonaws.rds#FailoverDBCluster" - }, - { - "target": "com.amazonaws.rds#FailoverGlobalCluster" - }, - { - "target": "com.amazonaws.rds#ListTagsForResource" - }, - { - "target": "com.amazonaws.rds#ModifyActivityStream" - }, - { - "target": "com.amazonaws.rds#ModifyCertificates" - }, - { - "target": "com.amazonaws.rds#ModifyCurrentDBClusterCapacity" - }, - { - "target": "com.amazonaws.rds#ModifyCustomDBEngineVersion" - }, - { - "target": "com.amazonaws.rds#ModifyDBCluster" - }, - { - "target": "com.amazonaws.rds#ModifyDBClusterEndpoint" - }, - { - "target": "com.amazonaws.rds#ModifyDBClusterParameterGroup" - }, - { - "target": "com.amazonaws.rds#ModifyDBClusterSnapshotAttribute" - }, - { - "target": "com.amazonaws.rds#ModifyDBInstance" + "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.rds#AccountAttributesMessage": { + "type": "structure", + "members": { + "AccountQuotas": { + "target": "com.amazonaws.rds#AccountQuotaList", + "traits": { + "smithy.api#documentation": "

A list of AccountQuota objects. Within this list, each quota has a name, \n a count of usage toward the quota maximum, and a maximum value for the quota.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Data returned by the DescribeAccountAttributes action.

" + } }, - { - "target": "com.amazonaws.rds#ModifyDBParameterGroup" + "com.amazonaws.rds#AccountQuota": { + "type": "structure", + "members": { + "AccountQuotaName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon RDS quota for this Amazon Web Services account.

" + } + }, + "Used": { + "target": "com.amazonaws.rds#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount currently used toward the quota maximum.

" + } + }, + "Max": { + "target": "com.amazonaws.rds#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum allowed value for the quota.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a quota for an Amazon Web Services account.

\n

The following are account quotas:

\n \n

For more information, see Quotas for Amazon RDS in the\n Amazon RDS User Guide and Quotas for Amazon Aurora in the\n Amazon Aurora User Guide.

" + } }, - { - "target": "com.amazonaws.rds#ModifyDBProxy" + "com.amazonaws.rds#AccountQuotaList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#AccountQuota", + "traits": { + "smithy.api#xmlName": "AccountQuota" + } + } }, - { - "target": "com.amazonaws.rds#ModifyDBProxyEndpoint" + "com.amazonaws.rds#ActivityStreamMode": { + "type": "enum", + "members": { + "sync": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sync" + } + }, + "async": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "async" + } + } + } }, - { - "target": "com.amazonaws.rds#ModifyDBProxyTargetGroup" + "com.amazonaws.rds#ActivityStreamModeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } }, - { - "target": "com.amazonaws.rds#ModifyDBSnapshot" + "com.amazonaws.rds#ActivityStreamPolicyStatus": { + "type": "enum", + "members": { + "locked": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "locked" + } + }, + "unlocked": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unlocked" + } + }, + "locking_policy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "locking-policy" + } + }, + "unlocking_policy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unlocking-policy" + } + } + } }, - { - "target": "com.amazonaws.rds#ModifyDBSnapshotAttribute" + "com.amazonaws.rds#ActivityStreamStatus": { + "type": "enum", + "members": { + "stopped": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stopped" + } + }, + "starting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "starting" + } + }, + "started": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "started" + } + }, + "stopping": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stopping" + } + } + } }, - { - "target": "com.amazonaws.rds#ModifyDBSubnetGroup" + "com.amazonaws.rds#AddRoleToDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#AddRoleToDBClusterMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterRoleAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBClusterRoleQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Associates an Identity and Access Management (IAM) role with a DB cluster.

" + } }, - { - "target": "com.amazonaws.rds#ModifyEventSubscription" + "com.amazonaws.rds#AddRoleToDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster to associate the IAM role with.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB\n cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.

", + "smithy.api#required": {} + } + }, + "FeatureName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the feature for the DB cluster that the IAM role is to be associated with. \n For information about supported feature names, see DBEngineVersion.

" + } + } + } }, - { - "target": "com.amazonaws.rds#ModifyGlobalCluster" + "com.amazonaws.rds#AddRoleToDBInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#AddRoleToDBInstanceMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceRoleAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceRoleQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.

\n \n

To add a role to a DB instance, the status of the DB instance must be available.

\n \n

This command doesn't apply to RDS Custom.

" + } }, - { - "target": "com.amazonaws.rds#ModifyOptionGroup" + "com.amazonaws.rds#AddRoleToDBInstanceMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB instance to associate the IAM role with.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for\n example arn:aws:iam::123456789012:role/AccessRole.

", + "smithy.api#required": {} + } + }, + "FeatureName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the feature for the DB instance that the IAM role is to be associated with. \n For information about supported feature names, see DBEngineVersion.

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.rds#PromoteReadReplica" + "com.amazonaws.rds#AddSourceIdentifierToSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#AddSourceIdentifierToSubscriptionMessage" + }, + "output": { + "target": "com.amazonaws.rds#AddSourceIdentifierToSubscriptionResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#SourceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#SubscriptionNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Adds a source identifier to an existing RDS event notification subscription.

" + } }, - { - "target": "com.amazonaws.rds#PromoteReadReplicaDBCluster" + "com.amazonaws.rds#AddSourceIdentifierToSubscriptionMessage": { + "type": "structure", + "members": { + "SubscriptionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the RDS event notification subscription you want to add a source identifier to.

", + "smithy.api#required": {} + } + }, + "SourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the event source to be added.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } }, - { - "target": "com.amazonaws.rds#PurchaseReservedDBInstancesOffering" + "com.amazonaws.rds#AddSourceIdentifierToSubscriptionResult": { + "type": "structure", + "members": { + "EventSubscription": { + "target": "com.amazonaws.rds#EventSubscription" + } + } }, - { - "target": "com.amazonaws.rds#RebootDBCluster" + "com.amazonaws.rds#AddTagsToResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#AddTagsToResourceMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.

\n

For an overview on tagging Amazon RDS resources, \n see Tagging Amazon RDS Resources.

" + } }, - { - "target": "com.amazonaws.rds#RebootDBInstance" + "com.amazonaws.rds#AddTagsToResourceMessage": { + "type": "structure", + "members": { + "ResourceName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, \n see \n Constructing an RDS Amazon Resource Name (ARN).

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

The tags to be assigned to the Amazon RDS resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } }, - { - "target": "com.amazonaws.rds#RegisterDBProxyTargets" - }, - { - "target": "com.amazonaws.rds#RemoveFromGlobalCluster" - }, - { - "target": "com.amazonaws.rds#RemoveRoleFromDBCluster" - }, - { - "target": "com.amazonaws.rds#RemoveRoleFromDBInstance" - }, - { - "target": "com.amazonaws.rds#RemoveSourceIdentifierFromSubscription" - }, - { - "target": "com.amazonaws.rds#RemoveTagsFromResource" - }, - { - "target": "com.amazonaws.rds#ResetDBClusterParameterGroup" - }, - { - "target": "com.amazonaws.rds#ResetDBParameterGroup" - }, - { - "target": "com.amazonaws.rds#RestoreDBClusterFromS3" - }, - { - "target": "com.amazonaws.rds#RestoreDBClusterFromSnapshot" - }, - { - "target": "com.amazonaws.rds#RestoreDBClusterToPointInTime" - }, - { - "target": "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshot" - }, - { - "target": "com.amazonaws.rds#RestoreDBInstanceFromS3" - }, - { - "target": "com.amazonaws.rds#RestoreDBInstanceToPointInTime" - }, - { - "target": "com.amazonaws.rds#RevokeDBSecurityGroupIngress" - }, - { - "target": "com.amazonaws.rds#StartActivityStream" - }, - { - "target": "com.amazonaws.rds#StartDBCluster" - }, - { - "target": "com.amazonaws.rds#StartDBInstance" - }, - { - "target": "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplication" - }, - { - "target": "com.amazonaws.rds#StartExportTask" - }, - { - "target": "com.amazonaws.rds#StopActivityStream" - }, - { - "target": "com.amazonaws.rds#StopDBCluster" - }, - { - "target": "com.amazonaws.rds#StopDBInstance" - }, - { - "target": "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplication" - }, - { - "target": "com.amazonaws.rds#SwitchoverBlueGreenDeployment" - }, - { - "target": "com.amazonaws.rds#SwitchoverReadReplica" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "RDS", - "arnNamespace": "rds", - "cloudFormationName": "RDS", - "cloudTrailEventSource": "rds.amazonaws.com", - "endpointPrefix": "rds" - }, - "aws.auth#sigv4": { - "name": "rds" - }, - "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "Amazon Relational Database Service\n

\n

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and \n scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational \n database and manages common database administration tasks, freeing up developers to focus on what makes their applications \n and businesses unique.

\n

Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, \n Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools \n you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS \n automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS \n is flexible: you can scale your DB instance's compute resources and storage capacity to meet your \n application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for \n the resources you use.

\n

This interface reference for Amazon RDS contains documentation for a programming or command line interface \n you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might \n require techniques such as polling or callback functions to determine when a command has been applied. In this \n reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, \n or during the maintenance window. The reference structure is as follows, and we list following some related topics \n from the user guide.

\n

\n Amazon RDS API Reference\n

\n \n

\n Amazon RDS User Guide\n

\n ", - "smithy.api#title": "Amazon Relational Database Service", - "smithy.api#xmlNamespace": { - "uri": "http://rds.amazonaws.com/doc/2014-10-31/" - }, - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": true, - "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": [ + "com.amazonaws.rds#AmazonRDSv19": { + "type": "service", + "version": "2014-10-31", + "operations": [ { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "type": "tree", - "rules": [ + "target": "com.amazonaws.rds#AddRoleToDBCluster" + }, { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "type": "tree", - "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" - } - ] - } - ] + "target": "com.amazonaws.rds#AddRoleToDBInstance" }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://rds-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" - } - ] + "target": "com.amazonaws.rds#AddSourceIdentifierToSubscription" }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "rds.ca-central-1" - ] - } - ], - "endpoint": { - "url": "https://rds-fips.ca-central-1.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "rds.us-east-1" - ] - } - ], - "endpoint": { - "url": "https://rds-fips.us-east-1.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "rds.us-east-2" - ] - } - ], - "endpoint": { - "url": "https://rds-fips.us-east-2.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "rds.us-west-1" - ] - } - ], - "endpoint": { - "url": "https://rds-fips.us-west-1.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "rds.us-west-2" - ] - } - ], - "endpoint": { - "url": "https://rds-fips.us-west-2.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - "aws-us-gov", - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - } - ] - } - ], - "endpoint": { - "url": "https://rds.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://rds-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] + "target": "com.amazonaws.rds#AddTagsToResource" }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://rds.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] + "target": "com.amazonaws.rds#ApplyPendingMaintenanceAction" }, { - "conditions": [], - "endpoint": { - "url": "https://rds.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-south-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.ap-south-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-south-2", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-south-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.ap-south-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-south-2", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-south-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-south-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-south-2", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-south-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-south-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-south-2", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.ap-south-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-south-1", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.ap-south-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-south-1", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-south-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-south-1", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-south-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-south-1", - "UseFIPS": false - } - }, - { - "documentation": "For region eu-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.eu-south-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "eu-south-1", - "UseFIPS": true - } - }, - { - "documentation": "For region eu-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.eu-south-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "eu-south-1", - "UseFIPS": true - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.eu-south-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "eu-south-1", - "UseFIPS": false - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.eu-south-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "eu-south-1", - "UseFIPS": false - } - }, - { - "documentation": "For region eu-south-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.eu-south-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "eu-south-2", - "UseFIPS": true - } - }, - { - "documentation": "For region eu-south-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.eu-south-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "eu-south-2", - "UseFIPS": true - } - }, - { - "documentation": "For region eu-south-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.eu-south-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "eu-south-2", - "UseFIPS": false - } - }, - { - "documentation": "For region eu-south-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.eu-south-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "eu-south-2", - "UseFIPS": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "us-gov-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-gov-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.us-gov-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "us-gov-east-1", - "UseFIPS": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-gov-east-1", - "UseFIPS": false - } - }, - { - "documentation": "For region me-central-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.me-central-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "me-central-1", - "UseFIPS": true - } - }, - { - "documentation": "For region me-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.me-central-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "me-central-1", - "UseFIPS": true - } - }, - { - "documentation": "For region me-central-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.me-central-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "me-central-1", - "UseFIPS": false - } - }, - { - "documentation": "For region me-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.me-central-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "me-central-1", - "UseFIPS": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.ca-central-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ca-central-1", - "UseFIPS": true - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.ca-central-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ca-central-1", - "UseFIPS": true - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.ca-central-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ca-central-1", - "UseFIPS": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.ca-central-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ca-central-1", - "UseFIPS": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.eu-central-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "eu-central-1", - "UseFIPS": true - } - }, - { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.eu-central-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "eu-central-1", - "UseFIPS": true - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.eu-central-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "eu-central-1", - "UseFIPS": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.eu-central-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "eu-central-1", - "UseFIPS": false - } - }, - { - "documentation": "For region us-iso-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "UseDualStack": true, - "Region": "us-iso-west-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-iso-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.us-iso-west-1.c2s.ic.gov" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-iso-west-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "UseDualStack": true, - "Region": "us-iso-west-1", - "UseFIPS": false - } - }, - { - "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.us-iso-west-1.c2s.ic.gov" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-iso-west-1", - "UseFIPS": false - } - }, - { - "documentation": "For region eu-central-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.eu-central-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "eu-central-2", - "UseFIPS": true - } - }, - { - "documentation": "For region eu-central-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.eu-central-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "eu-central-2", - "UseFIPS": true - } - }, - { - "documentation": "For region eu-central-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.eu-central-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "eu-central-2", - "UseFIPS": false - } - }, - { - "documentation": "For region eu-central-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.eu-central-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "eu-central-2", - "UseFIPS": false - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.us-west-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "us-west-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.us-west-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-west-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.us-west-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "us-west-1", - "UseFIPS": false - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.us-west-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-west-1", - "UseFIPS": false - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.us-west-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "us-west-2", - "UseFIPS": true - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-west-2", - "UseFIPS": true - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.us-west-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "us-west-2", - "UseFIPS": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.us-west-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-west-2", - "UseFIPS": false - } - }, - { - "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.af-south-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "af-south-1", - "UseFIPS": true - } - }, - { - "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.af-south-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "af-south-1", - "UseFIPS": true - } - }, - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.af-south-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "af-south-1", - "UseFIPS": false - } - }, - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.af-south-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "af-south-1", - "UseFIPS": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.eu-north-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "eu-north-1", - "UseFIPS": true - } - }, - { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.eu-north-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "eu-north-1", - "UseFIPS": true - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.eu-north-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "eu-north-1", - "UseFIPS": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.eu-north-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "eu-north-1", - "UseFIPS": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.eu-west-3.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "eu-west-3", - "UseFIPS": true - } - }, - { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.eu-west-3.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "eu-west-3", - "UseFIPS": true - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.eu-west-3.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "eu-west-3", - "UseFIPS": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.eu-west-3.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "eu-west-3", - "UseFIPS": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.eu-west-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "eu-west-2", - "UseFIPS": true - } - }, - { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.eu-west-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "eu-west-2", - "UseFIPS": true - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.eu-west-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "eu-west-2", - "UseFIPS": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.eu-west-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "eu-west-2", - "UseFIPS": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.eu-west-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "eu-west-1", - "UseFIPS": true - } - }, - { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.eu-west-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "eu-west-1", - "UseFIPS": true - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.eu-west-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "eu-west-1", - "UseFIPS": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.eu-west-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "eu-west-1", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.ap-northeast-3.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-northeast-3", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-northeast-3", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-northeast-3.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-northeast-3", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-northeast-3", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.ap-northeast-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-northeast-2", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-northeast-2", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-northeast-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-northeast-2", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-northeast-2", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.ap-northeast-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-northeast-1", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-northeast-1", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-northeast-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-northeast-1", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-northeast-1", - "UseFIPS": false - } - }, - { - "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.me-south-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "me-south-1", - "UseFIPS": true - } - }, - { - "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.me-south-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "me-south-1", - "UseFIPS": true - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.me-south-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "me-south-1", - "UseFIPS": false - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.me-south-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "me-south-1", - "UseFIPS": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.sa-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "sa-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.sa-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "sa-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.sa-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "sa-east-1", - "UseFIPS": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.sa-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "sa-east-1", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.ap-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.ap-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-east-1", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-east-1", - "UseFIPS": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "UseDualStack": true, - "Region": "cn-north-1", - "UseFIPS": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "UseDualStack": false, - "Region": "cn-north-1", - "UseFIPS": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "UseDualStack": true, - "Region": "cn-north-1", - "UseFIPS": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "UseDualStack": false, - "Region": "cn-north-1", - "UseFIPS": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.us-gov-west-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "us-gov-west-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-gov-west-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.us-gov-west-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "us-gov-west-1", - "UseFIPS": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-gov-west-1", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.ap-southeast-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-southeast-1", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-southeast-1", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-southeast-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-southeast-1", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-southeast-1", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.ap-southeast-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-southeast-2", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-southeast-2", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-southeast-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-southeast-2", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-southeast-2", - "UseFIPS": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "UseDualStack": true, - "Region": "us-iso-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-iso-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "UseDualStack": true, - "Region": "us-iso-east-1", - "UseFIPS": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-iso-east-1", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.ap-southeast-3.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-southeast-3", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.ap-southeast-3.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-southeast-3", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-southeast-3.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-southeast-3", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-southeast-3.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-southeast-3", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-southeast-4 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.ap-southeast-4.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-southeast-4", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-southeast-4 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.ap-southeast-4.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-southeast-4", - "UseFIPS": true - } - }, - { - "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-southeast-4.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "ap-southeast-4", - "UseFIPS": false - } - }, - { - "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.ap-southeast-4.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "ap-southeast-4", - "UseFIPS": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.us-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "us-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.us-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "us-east-1", - "UseFIPS": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.us-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-east-1", - "UseFIPS": false - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.us-east-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "us-east-2", - "UseFIPS": true - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.us-east-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-east-2", - "UseFIPS": true - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.us-east-2.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "us-east-2", - "UseFIPS": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.us-east-2.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-east-2", - "UseFIPS": false - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.cn-northwest-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "UseDualStack": true, - "Region": "cn-northwest-1", - "UseFIPS": true - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "UseDualStack": false, - "Region": "cn-northwest-1", - "UseFIPS": true - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://rds.cn-northwest-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "UseDualStack": true, - "Region": "cn-northwest-1", - "UseFIPS": false - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "UseDualStack": false, - "Region": "cn-northwest-1", - "UseFIPS": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "UseDualStack": true, - "Region": "us-isob-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-isob-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "UseDualStack": true, - "Region": "us-isob-east-1", - "UseFIPS": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://rds.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-isob-east-1", - "UseFIPS": false - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-east-1", - "UseFIPS": 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": { - "UseDualStack": false, - "Region": "us-east-1", - "UseFIPS": true, - "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": { - "UseDualStack": true, - "Region": "us-east-1", - "UseFIPS": false, - "Endpoint": "https://example.com" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.rds#ApplyMethod": { - "type": "enum", - "members": { - "immediate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "immediate" - } - }, - "pending_reboot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending-reboot" - } - } - } - }, - "com.amazonaws.rds#ApplyPendingMaintenanceAction": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ApplyPendingMaintenanceActionMessage" - }, - "output": { - "target": "com.amazonaws.rds#ApplyPendingMaintenanceActionResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#ResourceNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Applies a pending maintenance action to a resource (for example, to a DB instance).

" - } - }, - "com.amazonaws.rds#ApplyPendingMaintenanceActionMessage": { - "type": "structure", - "members": { - "ResourceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The RDS Amazon Resource Name (ARN) of the resource that the \n pending maintenance action applies to. For information about \n creating an ARN, \n see \n Constructing an RDS Amazon Resource Name (ARN).

", - "smithy.api#required": {} - } - }, - "ApplyAction": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The pending maintenance action to apply to this resource.

\n

Valid values: system-update, db-upgrade, \n hardware-maintenance, ca-certificate-rotation\n

", - "smithy.api#required": {} - } - }, - "OptInType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in \n request of type immediate can't be undone.

\n

Valid values:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#ApplyPendingMaintenanceActionResult": { - "type": "structure", - "members": { - "ResourcePendingMaintenanceActions": { - "target": "com.amazonaws.rds#ResourcePendingMaintenanceActions" - } - } - }, - "com.amazonaws.rds#AttributeValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#xmlName": "AttributeValue" - } - } - }, - "com.amazonaws.rds#AuditPolicyState": { - "type": "enum", - "members": { - "LOCKED_POLICY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "locked" - } - }, - "UNLOCKED_POLICY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unlocked" - } - } - } - }, - "com.amazonaws.rds#AuthScheme": { - "type": "enum", - "members": { - "SECRETS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SECRETS" - } - } - } - }, - "com.amazonaws.rds#AuthorizationAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "AuthorizationAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The specified CIDR IP range or Amazon EC2 security group is already authorized for\n the specified DB security group.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#AuthorizationNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "AuthorizationNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The specified CIDR IP range or Amazon EC2 security group might not be authorized\n for the specified DB security group.

\n

Or, RDS might not be authorized to perform necessary actions using IAM on your\n behalf.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#AuthorizationQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "AuthorizationQuotaExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The DB security group authorization quota has been reached.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#AuthorizeDBSecurityGroupIngress": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressMessage" - }, - "output": { - "target": "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#AuthorizationAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#AuthorizationQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security \n groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC \n instances. Second, IP ranges are available if the application accessing your database is running on the internet. \n Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId \n and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

\n

You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in \n another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

\n

For an overview of CIDR ranges, go to the \n Wikipedia Tutorial.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring ā€“ \n Hereā€™s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n " - } - }, - "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressMessage": { - "type": "structure", - "members": { - "DBSecurityGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB security group to add authorization to.

", - "smithy.api#required": {} - } - }, - "CIDRIP": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The IP range to authorize.

" - } - }, - "EC2SecurityGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Name of the EC2 security group to authorize.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName \n or EC2SecurityGroupId must be provided.

" - } - }, - "EC2SecurityGroupId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Id of the EC2 security group to authorize.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" - } - }, - "EC2SecurityGroupOwnerId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Amazon Web Services account number of the owner of the EC2 security group\n specified in the EC2SecurityGroupName parameter.\n The Amazon Web Services access key ID isn't an acceptable value.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressResult": { - "type": "structure", - "members": { - "DBSecurityGroup": { - "target": "com.amazonaws.rds#DBSecurityGroup" - } - } - }, - "com.amazonaws.rds#AutomationMode": { - "type": "enum", - "members": { - "FULL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "full" - } - }, - "ALL_PAUSED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "all-paused" - } - } - } - }, - "com.amazonaws.rds#AvailabilityZone": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the Availability Zone.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains Availability Zone information.

\n

This data type is used as an element in the OrderableDBInstanceOption\n data type.

" - } - }, - "com.amazonaws.rds#AvailabilityZoneList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#AvailabilityZone", - "traits": { - "smithy.api#xmlName": "AvailabilityZone" - } - } - }, - "com.amazonaws.rds#AvailabilityZones": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#xmlName": "AvailabilityZone" - } - } - }, - "com.amazonaws.rds#AvailableProcessorFeature": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the processor feature. Valid names are coreCount \n and threadsPerCore.

" - } - }, - "DefaultValue": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The default value for the processor feature of the DB instance class.

" - } - }, - "AllowedValues": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The allowed values for the processor feature of the DB instance class.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the available processor feature information for the DB instance class of a DB instance.

\n

For more information, see Configuring the\n Processor of the DB Instance Class in the Amazon RDS User Guide.\n \n

" - } - }, - "com.amazonaws.rds#AvailableProcessorFeatureList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#AvailableProcessorFeature", - "traits": { - "smithy.api#xmlName": "AvailableProcessorFeature" - } - } - }, - "com.amazonaws.rds#AwsBackupRecoveryPointArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 43, - "max": 350 - }, - "smithy.api#pattern": "^arn:aws[a-z-]*:backup:[-a-z0-9]+:[0-9]{12}:[-a-z]+:([a-z0-9\\-]+:)?[a-z][a-z0-9\\-]{0,255}$" - } - }, - "com.amazonaws.rds#BacktrackDBCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#BacktrackDBClusterMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBClusterBacktrack" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Backtracks a DB cluster to a specific time, without creating a new DB cluster.

\n

For more information on backtracking, see \n \n Backtracking an Aurora DB Cluster in the \n Amazon Aurora User Guide.

\n \n

This action applies only to Aurora MySQL DB clusters.

\n " - } - }, - "com.amazonaws.rds#BacktrackDBClusterMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier of the DB cluster to be backtracked. This parameter is\n stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster1\n

", - "smithy.api#required": {} - } - }, - "BacktrackTo": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The timestamp of the time to backtrack the DB cluster to, specified in ISO\n 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia\n page.\n

\n \n

If the specified time isn't a consistent time for the DB cluster, \n Aurora automatically chooses the nearest possible consistent time for the DB cluster.

\n \n

Constraints:

\n \n

Example: 2017-07-08T18:00Z\n

", - "smithy.api#required": {} - } - }, - "Force": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to force the DB cluster to backtrack when binary logging is\n enabled. Otherwise, an error occurs when binary logging is enabled.

" - } - }, - "UseEarliestTimeOnPointInTimeUnavailable": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to backtrack the DB cluster to the earliest possible\n backtrack time when BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time, an error occurs.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#BackupPolicyNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "BackupPolicyNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#deprecated": { - "message": "Please avoid using this fault" - }, - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#BlueGreenDeployment": { - "type": "structure", - "members": { - "BlueGreenDeploymentIdentifier": { - "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", - "traits": { - "smithy.api#documentation": "

The system-generated identifier of the blue/green deployment.

" - } - }, - "BlueGreenDeploymentName": { - "target": "com.amazonaws.rds#BlueGreenDeploymentName", - "traits": { - "smithy.api#documentation": "

The user-supplied name of the blue/green deployment.

" - } - }, - "Source": { - "target": "com.amazonaws.rds#DatabaseArn", - "traits": { - "smithy.api#documentation": "

The source database for the blue/green deployment.

\n

Before switchover, the source database is the production database in the blue environment.

" - } - }, - "Target": { - "target": "com.amazonaws.rds#DatabaseArn", - "traits": { - "smithy.api#documentation": "

The target database for the blue/green deployment.

\n

Before switchover, the target database is the clone database in the green environment.

" - } - }, - "SwitchoverDetails": { - "target": "com.amazonaws.rds#SwitchoverDetailList", - "traits": { - "smithy.api#documentation": "

The details about each source and target resource in the blue/green deployment.

" - } - }, - "Tasks": { - "target": "com.amazonaws.rds#BlueGreenDeploymentTaskList", - "traits": { - "smithy.api#documentation": "

Either tasks to be performed or tasks that have been completed on the target database before switchover.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#BlueGreenDeploymentStatus", - "traits": { - "smithy.api#documentation": "

The status of the blue/green deployment.

\n

Values:

\n " - } - }, - "StatusDetails": { - "target": "com.amazonaws.rds#BlueGreenDeploymentStatusDetails", - "traits": { - "smithy.api#documentation": "

Additional information about the status of the blue/green deployment.

" - } - }, - "CreateTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

Specifies the time when the blue/green deployment was created, in Universal Coordinated Time (UTC).

" - } - }, - "DeleteTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

Specifies the time when the blue/green deployment was deleted, in Universal Coordinated Time (UTC).

" - } - }, - "TagList": { - "target": "com.amazonaws.rds#TagList" - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details about a blue/green deployment.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

" - } - }, - "com.amazonaws.rds#BlueGreenDeploymentAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "BlueGreenDeploymentAlreadyExistsFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

A blue/green deployment with the specified name already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#BlueGreenDeploymentIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[A-Za-z][0-9A-Za-z-:._]*$" - } - }, - "com.amazonaws.rds#BlueGreenDeploymentList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#BlueGreenDeployment" - } - }, - "com.amazonaws.rds#BlueGreenDeploymentName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 60 - }, - "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" - } - }, - "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "BlueGreenDeploymentNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n BlueGreenDeploymentIdentifier doesn't refer to an existing blue/green deployment.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#BlueGreenDeploymentStatus": { - "type": "string" - }, - "com.amazonaws.rds#BlueGreenDeploymentStatusDetails": { - "type": "string" - }, - "com.amazonaws.rds#BlueGreenDeploymentTask": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.rds#BlueGreenDeploymentTaskName", - "traits": { - "smithy.api#documentation": "

The name of the blue/green deployment task.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#BlueGreenDeploymentTaskStatus", - "traits": { - "smithy.api#documentation": "

The status of the blue/green deployment task.

\n

Values:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details about a task for a blue/green deployment.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

" - } - }, - "com.amazonaws.rds#BlueGreenDeploymentTaskList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#BlueGreenDeploymentTask" - } - }, - "com.amazonaws.rds#BlueGreenDeploymentTaskName": { - "type": "string" - }, - "com.amazonaws.rds#BlueGreenDeploymentTaskStatus": { - "type": "string" - }, - "com.amazonaws.rds#Boolean": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.rds#BooleanOptional": { - "type": "boolean" - }, - "com.amazonaws.rds#BucketName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.rds#CancelExportTask": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CancelExportTaskMessage" - }, - "output": { - "target": "com.amazonaws.rds#ExportTask" - }, - "errors": [ - { - "target": "com.amazonaws.rds#ExportTaskNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidExportTaskStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Cancels an export task in progress that is exporting a snapshot to Amazon S3. \n Any data that has already been written to the S3 bucket isn't removed.

" - } - }, - "com.amazonaws.rds#CancelExportTaskMessage": { - "type": "structure", - "members": { - "ExportTaskIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the snapshot export task to cancel.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.rds#Certificate": { - "type": "structure", - "members": { - "CertificateIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The unique key that identifies a certificate.

" - } - }, - "CertificateType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The type of the certificate.

" - } - }, - "Thumbprint": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The thumbprint of the certificate.

" - } - }, - "ValidFrom": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The starting date from which the certificate is valid.

" - } - }, - "ValidTill": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The final date that the certificate continues to be valid.

" - } - }, - "CertificateArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the certificate.

" - } - }, - "CustomerOverride": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Whether there is an override for the default certificate identifier.

" - } - }, - "CustomerOverrideValidTill": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

If there is an override for the default certificate identifier, when the override\n expires.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A CA certificate for an Amazon Web Services account.

" - } - }, - "com.amazonaws.rds#CertificateList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#Certificate", - "traits": { - "smithy.api#xmlName": "Certificate" - } - } - }, - "com.amazonaws.rds#CertificateMessage": { - "type": "structure", - "members": { - "Certificates": { - "target": "com.amazonaws.rds#CertificateList", - "traits": { - "smithy.api#documentation": "

The list of Certificate objects for the Amazon Web Services account.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeCertificates request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Data returned by the DescribeCertificates action.

" - } - }, - "com.amazonaws.rds#CertificateNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "CertificateNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n CertificateIdentifier doesn't refer to an\n existing certificate.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#CharacterSet": { - "type": "structure", - "members": { - "CharacterSetName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the character set.

" - } - }, - "CharacterSetDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description of the character set.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the action DescribeDBEngineVersions.

" - } - }, - "com.amazonaws.rds#ClientPasswordAuthType": { - "type": "enum", - "members": { - "MYSQL_NATIVE_PASSWORD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MYSQL_NATIVE_PASSWORD" - } - }, - "POSTGRES_SCRAM_SHA_256": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POSTGRES_SCRAM_SHA_256" - } - }, - "POSTGRES_MD5": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POSTGRES_MD5" - } - }, - "SQL_SERVER_AUTHENTICATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SQL_SERVER_AUTHENTICATION" - } - } - } - }, - "com.amazonaws.rds#CloudwatchLogsExportConfiguration": { - "type": "structure", - "members": { - "EnableLogTypes": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

The list of log types to enable.

" - } - }, - "DisableLogTypes": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

The list of log types to disable.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration setting for the log types to be enabled for export to CloudWatch\n Logs for a specific DB instance or DB cluster.

\n

The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported\n (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB\n engine being used.

\n

For more information about exporting CloudWatch Logs for Amazon RDS DB instances, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

" - } - }, - "com.amazonaws.rds#ClusterPendingModifiedValues": { - "type": "structure", - "members": { - "PendingCloudwatchLogsExports": { - "target": "com.amazonaws.rds#PendingCloudwatchLogsExports" - }, - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DBClusterIdentifier value for the DB cluster.

" - } - }, - "MasterUserPassword": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The master credentials for the DB cluster.

" - } - }, - "IAMDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database engine version.

" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days for which automatic DB snapshots are retained.

" - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The allocated storage size in gibibytes (GiB) for all database engines except Amazon Aurora. For Aurora, \n AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but \n instead automatically adjusts as needed.

" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the ModifyDBCluster operation and \n contains changes that will be applied during the next maintenance window.

" - } - }, - "com.amazonaws.rds#ConnectionPoolConfiguration": { - "type": "structure", - "members": { - "MaxConnectionsPercent": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

\n

If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter.

\n

Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines

\n

Constraints: Must be between 1 and 100.

" - } - }, - "MaxIdleConnectionsPercent": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Controls how actively the proxy closes idle database connections in the connection pool.\n The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.

\n

If you specify this parameter, then you must also include a value for MaxConnectionsPercent.

\n

Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of \n MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and \n for all other engines, the default is 50.

\n

Constraints: Must be between 0 and the value of MaxConnectionsPercent.

" - } - }, - "ConnectionBorrowTimeout": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the\n proxy has opened its maximum number of connections and all connections are busy with client sessions.

\n

Default: 120

\n

Constraints: between 1 and 3600, or 0 representing unlimited

" - } - }, - "SessionPinningFilters": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

Each item in the list represents a class of SQL operations that normally cause all later statements\n in a session using a proxy to be pinned to the same underlying database connection. Including an item\n in the list exempts that class of SQL operations from the pinning behavior.

\n

Default: no session pinning filters

" - } - }, - "InitQuery": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

One or more SQL statements for the proxy to run when opening each new database connection.\n Typically used with SET statements to make sure that each connection has identical\n settings such as time zone and character set. For multiple statements, use semicolons as the separator.\n You can also include multiple variables in a single SET statement, such as\n SET x=1, y=2.

\n

Default: no initialization query

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the settings that control the size and behavior of the connection pool associated with a DBProxyTargetGroup.

" - } - }, - "com.amazonaws.rds#ConnectionPoolConfigurationInfo": { - "type": "structure", - "members": { - "MaxConnectionsPercent": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

" - } - }, - "MaxIdleConnectionsPercent": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Controls how actively the proxy closes idle database connections in the connection pool.\n The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.

" - } - }, - "ConnectionBorrowTimeout": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the\n proxy has opened its maximum number of connections and all connections are busy with client sessions.

" - } - }, - "SessionPinningFilters": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

Each item in the list represents a class of SQL operations that normally cause all later statements\n in a session using a proxy to be pinned to the same underlying database connection. Including an item\n in the list exempts that class of SQL operations from the pinning behavior. This setting is only supported for MySQL engine family databases. \n Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

" - } - }, - "InitQuery": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

One or more SQL statements for the proxy to run when opening each new database connection.\n Typically used with SET statements to make sure that each connection has identical\n settings such as time zone and character set. This setting is empty by default.\n For multiple statements, use semicolons as the separator.\n You can also include multiple variables in a single SET statement, such as\n SET x=1, y=2.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget.

" - } - }, - "com.amazonaws.rds#CopyDBClusterParameterGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CopyDBClusterParameterGroupMessage" - }, - "output": { - "target": "com.amazonaws.rds#CopyDBClusterParameterGroupResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBParameterGroupQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Copies the specified DB cluster parameter group.

" - } - }, - "com.amazonaws.rds#CopyDBClusterParameterGroupMessage": { - "type": "structure", - "members": { - "SourceDBClusterParameterGroupIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group.\n For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "TargetDBClusterParameterGroupIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the copied DB cluster parameter group.

\n

Constraints:

\n \n

Example: my-cluster-param-group1\n

", - "smithy.api#required": {} - } - }, - "TargetDBClusterParameterGroupDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A description for the copied DB cluster parameter group.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - } - } - }, - "com.amazonaws.rds#CopyDBClusterParameterGroupResult": { - "type": "structure", - "members": { - "DBClusterParameterGroup": { - "target": "com.amazonaws.rds#DBClusterParameterGroup" - } - } - }, - "com.amazonaws.rds#CopyDBClusterSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CopyDBClusterSnapshotMessage" - }, - "output": { - "target": "com.amazonaws.rds#CopyDBClusterSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterSnapshotAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - }, - { - "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Copies a snapshot of a DB cluster.

\n

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier\n must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

\n

You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case,\n the Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is the\n destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy\n an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the\n following values:

\n \n

To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified\n by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in \"copying\" status.

\n

For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see \n \n Copying a Snapshot in the Amazon Aurora User Guide.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" - } - }, - "com.amazonaws.rds#CopyDBClusterSnapshotMessage": { - "type": "structure", - "members": { - "SourceDBClusterSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.

\n

You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.

\n

Constraints:

\n \n

Example: my-cluster-snapshot1\n

", - "smithy.api#required": {} - } - }, - "TargetDBClusterSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.

\n

Constraints:

\n \n

Example: my-cluster-snapshot2\n

", - "smithy.api#required": {} - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.

\n

If you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS key. \n If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

\n

If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.

\n

To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier \n you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services \n Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region \n in another Amazon Web Services Region.

\n

If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, \n an error is returned.

" - } - }, - "PreSignedUrl": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud (US) Region\n to another, the URL that contains a Signature Version 4 signed request for the\n CopyDBClusterSnapshot API operation in the Amazon Web Services Region that contains\n the source DB cluster snapshot to copy. Use the PreSignedUrl parameter when\n copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify\n PreSignedUrl when copying an encrypted DB cluster snapshot in the same\n Amazon Web Services Region.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\n

The presigned URL must be a valid request for the\n CopyDBClusterSnapshot API operation that can run in the source\n Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request\n must contain the following parameter values:

\n \n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n " - } - }, - "CopyTags": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. \n By default, tags are not copied.

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#CopyDBClusterSnapshotResult": { - "type": "structure", - "members": { - "DBClusterSnapshot": { - "target": "com.amazonaws.rds#DBClusterSnapshot" - } - } - }, - "com.amazonaws.rds#CopyDBParameterGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CopyDBParameterGroupMessage" - }, - "output": { - "target": "com.amazonaws.rds#CopyDBParameterGroupResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBParameterGroupQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Copies the specified DB parameter group.

" - } - }, - "com.amazonaws.rds#CopyDBParameterGroupMessage": { - "type": "structure", - "members": { - "SourceDBParameterGroupIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier or ARN for the source DB parameter group.\n For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "TargetDBParameterGroupIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the copied DB parameter group.

\n

Constraints:

\n \n

Example: my-db-parameter-group\n

", - "smithy.api#required": {} - } - }, - "TargetDBParameterGroupDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A description for the copied DB parameter group.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#CopyDBParameterGroupResult": { - "type": "structure", - "members": { - "DBParameterGroup": { - "target": "com.amazonaws.rds#DBParameterGroup" - } - } - }, - "com.amazonaws.rds#CopyDBSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CopyDBSnapshotMessage" - }, - "output": { - "target": "com.amazonaws.rds#CopyDBSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#CustomAvailabilityZoneNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSnapshotAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" - }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - }, - { - "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Copies the specified DB snapshot. The source DB snapshot must be in the available state.

\n

You can copy a snapshot from one Amazon Web Services Region to another. In that case, the\n Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination\n Amazon Web Services Region for the DB snapshot copy.

\n

This command doesn't apply to RDS Custom.

\n

For more information about copying snapshots, see \n Copying a DB Snapshot in the Amazon RDS User Guide.

" - } - }, - "com.amazonaws.rds#CopyDBSnapshotMessage": { - "type": "structure", - "members": { - "SourceDBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the source DB snapshot.

\n

If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB\n snapshot identifier. For example, you might specify\n rds:mysql-instance1-snapshot-20130805.

\n

If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB\n snapshot ARN. For example, you might specify\n arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

\n

If you are copying from a shared manual DB snapshot, \n this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

\n

If you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region.

\n

Constraints:

\n \n

Example: rds:mydb-2012-04-02-00-01\n

\n

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805\n

", - "smithy.api#required": {} - } - }, - "TargetDBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the copy of the snapshot.

\n

Constraints:

\n \n

Example: my-db-snapshot\n

", - "smithy.api#required": {} - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB snapshot. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you copy an encrypted DB snapshot from your Amazon Web Services account, \n you can specify a value for this parameter to encrypt the copy with a new KMS key. \n If you don't specify a value for this parameter, \n then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot.

\n

If you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, \n then you must specify a value for this parameter.

\n

If you specify this parameter when you copy an unencrypted snapshot, \n the copy is encrypted.

\n

If you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify\n an Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region\n that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another\n Amazon Web Services Region.

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - }, - "CopyTags": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. \n By default, tags aren't copied.

" - } - }, - "PreSignedUrl": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, \n the URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API \n operation in the source Amazon Web Services Region that contains the source DB snapshot to copy.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\n

You must specify this parameter when you copy an encrypted DB snapshot from another\n Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are \n copying an encrypted DB snapshot in the same Amazon Web Services Region.

\n

The presigned URL must be a valid request for the\n CopyDBClusterSnapshot API operation that can run in the source\n Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request\n must contain the following parameter values:

\n \n

To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n " - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of an option group to associate with the copy of the snapshot.

\n

Specify this option if you are copying a snapshot from one Amazon Web Services Region to another,\n and your DB instance uses a nondefault option group. \n If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, \n you must specify this option when copying across Amazon Web Services Regions. \n For more information, see \n Option group considerations in the Amazon RDS User Guide.

" - } - }, - "TargetCustomAvailabilityZone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The external custom Availability Zone (CAZ) identifier for the target CAZ.

\n

Example: rds-caz-aiqhTgQv.

" - } - }, - "CopyOptionGroup": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy the DB option group associated with the source DB snapshot to the target \n Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with \n cross-account snapshot copy calls.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#CopyDBSnapshotResult": { - "type": "structure", - "members": { - "DBSnapshot": { - "target": "com.amazonaws.rds#DBSnapshot" - } - } - }, - "com.amazonaws.rds#CopyOptionGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CopyOptionGroupMessage" - }, - "output": { - "target": "com.amazonaws.rds#CopyOptionGroupResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#OptionGroupAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#OptionGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#OptionGroupQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Copies the specified option group.

" - } - }, - "com.amazonaws.rds#CopyOptionGroupMessage": { - "type": "structure", - "members": { - "SourceOptionGroupIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the source option group.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "TargetOptionGroupIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the copied option group.

\n

Constraints:

\n \n

Example: my-option-group\n

", - "smithy.api#required": {} - } - }, - "TargetOptionGroupDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description for the copied option group.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#CopyOptionGroupResult": { - "type": "structure", - "members": { - "OptionGroup": { - "target": "com.amazonaws.rds#OptionGroup" - } - } - }, - "com.amazonaws.rds#CreateBlueGreenDeployment": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateBlueGreenDeploymentRequest" - }, - "output": { - "target": "com.amazonaws.rds#CreateBlueGreenDeploymentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#BlueGreenDeploymentAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InstanceQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#SourceClusterNotSupportedFault" - }, - { - "target": "com.amazonaws.rds#SourceDatabaseNotSupportedFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a blue/green deployment.

\n

A blue/green deployment creates a staging environment that copies the production environment. \n In a blue/green deployment, the blue environment is the current production environment. \n The green environment is the staging environment. The staging environment stays in sync \n with the current production environment using logical replication.

\n

You can make changes to the databases in the green environment without affecting \n production workloads. For example, you can upgrade the major or minor DB engine version, change \n database parameters, or make schema changes in the staging environment. You can thoroughly test \n changes in the green environment. When ready, you can switch over the environments to promote the \n green environment to be the new production environment. The switchover typically takes under a minute.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

" - } - }, - "com.amazonaws.rds#CreateBlueGreenDeploymentRequest": { - "type": "structure", - "members": { - "BlueGreenDeploymentName": { - "target": "com.amazonaws.rds#BlueGreenDeploymentName", - "traits": { - "smithy.api#documentation": "

The name of the blue/green deployment.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "Source": { - "target": "com.amazonaws.rds#DatabaseArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source production database.

\n

Specify the database that you want to clone. The blue/green deployment creates this database in \n the green environment. You can make updates to the database in the green environment, such as an engine \n version upgrade. When you are ready, you can switch the database in the green environment to be the \n production database.

", - "smithy.api#required": {} - } - }, - "TargetEngineVersion": { - "target": "com.amazonaws.rds#TargetEngineVersion", - "traits": { - "smithy.api#documentation": "

The engine version of the database in the green environment.

\n

Specify the engine version to upgrade to in the green environment.

" - } - }, - "TargetDBParameterGroupName": { - "target": "com.amazonaws.rds#TargetDBParameterGroupName", - "traits": { - "smithy.api#documentation": "

The DB parameter group associated with the DB instance in the green environment.

\n

To test parameter changes, specify a DB parameter group that is different from the one associated \n with the source DB instance.

" - } - }, - "TargetDBClusterParameterGroupName": { - "target": "com.amazonaws.rds#TargetDBClusterParameterGroupName", - "traits": { - "smithy.api#documentation": "

The DB cluster parameter group associated with the Aurora DB cluster in the green environment.

\n

To test parameter changes, specify a DB cluster parameter group that is different from the one associated \n with the source DB cluster.

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

Tags to assign to the blue/green deployment.

" - } - } - } - }, - "com.amazonaws.rds#CreateBlueGreenDeploymentResponse": { - "type": "structure", - "members": { - "BlueGreenDeployment": { - "target": "com.amazonaws.rds#BlueGreenDeployment" - } - } - }, - "com.amazonaws.rds#CreateCustomDBEngineVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateCustomDBEngineVersionMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBEngineVersion" - }, - "errors": [ - { - "target": "com.amazonaws.rds#CustomDBEngineVersionAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#CustomDBEngineVersionQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#Ec2ImagePropertiesNotSupportedFault" - }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a custom DB engine version (CEV).

" - } - }, - "com.amazonaws.rds#CreateCustomDBEngineVersionMessage": { - "type": "structure", - "members": { - "Engine": { - "target": "com.amazonaws.rds#CustomEngineName", - "traits": { - "smithy.api#documentation": "

The database engine to use for your custom engine version (CEV). The only supported value is \n custom-oracle-ee.

", - "smithy.api#required": {} - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#CustomEngineVersion", - "traits": { - "smithy.api#documentation": "

The name of your CEV. The name format is 19.customized_string.\n For example, a valid CEV name is 19.my_cev1. This setting is required for RDS\n Custom for Oracle, but optional for Amazon RDS. The combination of Engine\n and EngineVersion is unique per customer per Region.

", - "smithy.api#required": {} - } - }, - "DatabaseInstallationFilesS3BucketName": { - "target": "com.amazonaws.rds#BucketName", - "traits": { - "smithy.api#documentation": "

The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid \n bucket name is my-custom-installation-files.

" - } - }, - "DatabaseInstallationFilesS3Prefix": { - "target": "com.amazonaws.rds#String255", - "traits": { - "smithy.api#documentation": "

The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid \n bucket name is 123456789012/cev1. If this setting isn't specified, no prefix is assumed.

" - } - }, - "ImageId": { - "target": "com.amazonaws.rds#String255", - "traits": { - "smithy.api#documentation": "

The ID of the AMI. An AMI ID is required to create a CEV for RDS Custom for SQL Server.

" - } - }, - "KMSKeyId": { - "target": "com.amazonaws.rds#KmsKeyIdOrArn", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for \n RDS Custom, but optional for Amazon RDS.

\n

If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. \n No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, \n follow the instructions in \n Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service\n Developer Guide.

\n

You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.

" - } - }, - "Description": { - "target": "com.amazonaws.rds#Description", - "traits": { - "smithy.api#documentation": "

An optional description of your CEV.

" - } - }, - "Manifest": { - "target": "com.amazonaws.rds#CustomDBEngineVersionManifest", - "traits": { - "smithy.api#documentation": "

The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. \n Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which \n they are listed.

\n

The following JSON fields are valid:

\n
\n
MediaImportTemplateVersion
\n
\n

Version of the CEV manifest. The date is in the format YYYY-MM-DD.

\n
\n
databaseInstallationFileNames
\n
\n

Ordered list of installation files for the CEV.

\n
\n
opatchFileNames
\n
\n

Ordered list of OPatch installers used for the Oracle DB engine.

\n
\n
psuRuPatchFileNames
\n
\n

The PSU and RU patches for this CEV.

\n
\n
OtherPatchFileNames
\n
\n

The patches that are not in the list of PSU and RU patches. \n Amazon RDS applies these patches after applying the PSU and RU patches.

\n
\n
\n

For more information, see \n Creating the CEV manifest in the Amazon RDS User Guide.

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - } - } - }, - "com.amazonaws.rds#CreateDBCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateDBClusterMessage" - }, - "output": { - "target": "com.amazonaws.rds#CreateDBClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DomainNotFoundFault" - }, - { - "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InsufficientStorageClusterCapacityFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBSubnetGroupStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidSubnet" - }, - { - "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" - }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - }, - { - "target": "com.amazonaws.rds#StorageQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.

\n

You can use the ReplicationSourceIdentifier parameter to create an Amazon\n Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or\n PostgreSQL DB instance.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" - } - }, - "com.amazonaws.rds#CreateDBClusterEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateDBClusterEndpointMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBClusterEndpoint" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterEndpointAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBClusterEndpointQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

\n \n

This action applies only to Aurora DB clusters.

\n " - } - }, - "com.amazonaws.rds#CreateDBClusterEndpointMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is\n stored as a lowercase string.

", - "smithy.api#required": {} - } - }, - "DBClusterEndpointIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

", - "smithy.api#required": {} - } - }, - "EndpointType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The type of the endpoint, one of: READER, WRITER, ANY.

", - "smithy.api#required": {} - } - }, - "StaticMembers": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

List of DB instance identifiers that are part of the custom endpoint group.

" - } - }, - "ExcludedMembers": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

List of DB instance identifiers that aren't part of the custom endpoint group.\n All other eligible instances are reachable through the custom endpoint.\n This parameter is relevant only if the list of static members is empty.

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

The tags to be assigned to the Amazon RDS resource.

" - } - } - } - }, - "com.amazonaws.rds#CreateDBClusterMessage": { - "type": "structure", - "members": { - "AvailabilityZones": { - "target": "com.amazonaws.rds#AvailabilityZones", - "traits": { - "smithy.api#documentation": "

A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.

\n

For information on Amazon Web Services Regions and Availability Zones, see \n Choosing the Regions and \n Availability Zones in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days for which automated backups are retained.

\n

Default: 1

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "CharacterSetName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A value that indicates that the DB cluster should be associated with the specified CharacterSet.

\n

Valid for: Aurora DB clusters only

" - } - }, - "DatabaseName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name for your database of up to 64 alphanumeric characters. If you do not\n provide a name, Amazon RDS doesn't create a database in the DB cluster you are\n creating.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster1\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", - "smithy.api#required": {} - } - }, - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group to associate\n with this DB cluster. If you do not specify a value, then \n the default DB cluster parameter group for the specified DB engine and version is used.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A DB subnet group to associate with this DB cluster.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mydbsubnetgroup\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the database engine to be used for this DB cluster.

\n

Valid Values:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", - "smithy.api#required": {} - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.

\n

To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

For information, see MySQL on Amazon RDS Versions in the \n Amazon Aurora User Guide.

\n

\n Aurora PostgreSQL\n

\n

For information, see Amazon Aurora PostgreSQL releases and engine versions in the \n Amazon Aurora User Guide.

\n

\n MySQL\n

\n

For information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.

\n

\n PostgreSQL\n

\n

For information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port number on which the instances in the DB cluster accept connections.

\n

\n RDS for MySQL and Aurora MySQL\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

\n

\n RDS for PostgreSQL and Aurora PostgreSQL\n

\n

Default: 5432\n

\n

Valid values: 1150-65535\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "MasterUsername": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the master user for the DB cluster.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "MasterUserPassword": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A value that indicates that the DB cluster should be associated with the specified option group.

\n

DB clusters are associated with a default option group that can't be modified.

" - } - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "ReplicationSourceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB\n cluster is created as a read replica.

\n

Valid for: Aurora DB clusters only

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

Tags to assign to the DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "StorageEncrypted": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster is encrypted.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

When a KMS key isn't specified in KmsKeyId:

\n \n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

\n

If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you\n must set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services\n Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "PreSignedUrl": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another,\n an URL that contains a Signature Version 4 signed request for the\n CreateDBCluster operation to be called in the source Amazon Web Services Region where\n the DB cluster is replicated from. Specify PreSignedUrl only when you are\n performing cross-Region replication from an encrypted DB cluster.

\n

The presigned URL must be a valid request for the CreateDBCluster API\n operation that can run in the source Amazon Web Services Region that contains the encrypted DB\n cluster to copy.

\n

The presigned URL request must contain the following parameter values:

\n \n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n \n

Valid for: Aurora DB clusters only

" - } - }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" - } - }, - "BacktrackWindow": { - "target": "com.amazonaws.rds#LongOptional", - "traits": { - "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n

Default: 0

\n

Constraints:

\n \n

Valid for: Aurora MySQL DB clusters only

" - } - }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "EngineMode": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB engine mode of the DB cluster, either provisioned, serverless, \n parallelquery, global, or multimaster.

\n

The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, \n and version 2.09 and higher 2.x versions.

\n

The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, \n and global engine mode isn't required for any 2.x versions.

\n

The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.

\n

The serverless engine mode only applies for Aurora Serverless v1 DB clusters.

\n

For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery \n and the multimaster engine modes currently aren't supported.

\n

Limitations and requirements apply to some DB engine modes. For more information, see the \n following sections in the Amazon Aurora User Guide:

\n \n

Valid for: Aurora DB clusters only

" - } - }, - "ScalingConfiguration": { - "target": "com.amazonaws.rds#ScalingConfiguration", - "traits": { - "smithy.api#documentation": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

\n

Valid for: Aurora DB clusters only

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The global cluster ID of an Aurora cluster that becomes the primary cluster\n in the new global database cluster.

\n

Valid for: Aurora DB clusters only

" - } - }, - "EnableHttpEndpoint": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint \n is disabled.

\n

When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.

\n

For more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "Domain": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Active Directory directory ID to create the DB cluster in.

\n

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.

\n

For more information, see Kerberos authentication\n in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" - } - }, - "DomainIAMRoleName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

Valid for: Aurora DB clusters only

" - } - }, - "EnableGlobalWriteForwarding": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an\n Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.

\n

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the\n primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.

\n

Valid for: Aurora DB clusters only

" - } - }, - "DBClusterInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid values: io1\n

\n

When specified, a value for the Iops parameter is required.

\n

Default: io1\n

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, see \n Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

Valid for: Multi-AZ DB clusters only

" - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "MonitoringInterval": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off \n collecting Enhanced Monitoring metrics, specify 0. The default is 0.

\n

If MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "MonitoringRoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. \n An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting \n up and enabling Enhanced Monitoring in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "EnablePerformanceInsights": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to turn on Performance Insights for the DB cluster.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "PerformanceInsightsKMSKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "PerformanceInsightsRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "ServerlessV2ScalingConfiguration": { - "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" - } - }, - "DBSystemId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Reserved for future use.

" - } - }, - "ManageMasterUserPassword": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "MasterUserSecretKmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#CreateDBClusterParameterGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateDBClusterParameterGroupMessage" - }, - "output": { - "target": "com.amazonaws.rds#CreateDBClusterParameterGroupResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBParameterGroupQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new DB cluster parameter group.

\n

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

\n

A DB cluster parameter group is initially created with the default parameters for the\n database engine used by instances in the DB cluster. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to\n associate it with your DB cluster using ModifyDBCluster.

\n

When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB\n instances in the DB cluster without failover for the new DB cluster parameter group and \n associated settings to take effect.

\n

When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB\n cluster without failover for the new DB cluster parameter group and associated settings to take effect.

\n \n

After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as\n the default parameter group. This allows Amazon RDS to fully complete the create\n action before the DB cluster parameter group is used as the default for a new DB\n cluster. This is especially important for parameters that are critical when creating\n the default database for a DB cluster, such as the character set for the default\n database defined by the character_set_database parameter. You can use\n the Parameter Groups option of the Amazon RDS console or the\n DescribeDBClusterParameters operation to verify that your DB\n cluster parameter group has been created or modified.

\n \n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" - } - }, - "com.amazonaws.rds#CreateDBClusterParameterGroupMessage": { - "type": "structure", - "members": { - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group.

\n

Constraints:

\n \n \n

This value is stored as a lowercase string.

\n ", - "smithy.api#required": {} - } - }, - "DBParameterGroupFamily": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster \n parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

\n

\n Aurora MySQL\n

\n

Example: aurora5.6, aurora-mysql5.7, aurora-mysql8.0\n

\n

\n Aurora PostgreSQL\n

\n

Example: aurora-postgresql9.6\n

\n

\n RDS for MySQL\n

\n

Example: mysql8.0\n

\n

\n RDS for PostgreSQL\n

\n

Example: postgres12\n

\n

To list all of the available parameter group families for a DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n

\n

For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine aurora-postgresql\n

\n \n

The output contains duplicates.

\n \n

The following are the valid DB engine values:

\n ", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description for the DB cluster parameter group.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

Tags to assign to the DB cluster parameter group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#CreateDBClusterParameterGroupResult": { - "type": "structure", - "members": { - "DBClusterParameterGroup": { - "target": "com.amazonaws.rds#DBClusterParameterGroup" - } - } - }, - "com.amazonaws.rds#CreateDBClusterResult": { - "type": "structure", - "members": { - "DBCluster": { - "target": "com.amazonaws.rds#DBCluster" - } - } - }, - "com.amazonaws.rds#CreateDBClusterSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateDBClusterSnapshotMessage" - }, - "output": { - "target": "com.amazonaws.rds#CreateDBClusterSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterSnapshotAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a snapshot of a DB cluster.

\n

For more information on Amazon Aurora, see What is Amazon\n Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" - } - }, - "com.amazonaws.rds#CreateDBClusterSnapshotMessage": { - "type": "structure", - "members": { - "DBClusterSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster1-snapshot1\n

", - "smithy.api#required": {} - } - }, - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DB cluster to create a snapshot for. This parameter isn't case-sensitive.

\n

Constraints:

\n \n

Example: my-cluster1\n

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

The tags to be assigned to the DB cluster snapshot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#CreateDBClusterSnapshotResult": { - "type": "structure", - "members": { - "DBClusterSnapshot": { - "target": "com.amazonaws.rds#DBClusterSnapshot" - } - } - }, - "com.amazonaws.rds#CreateDBInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateDBInstanceMessage" - }, - "output": { - "target": "com.amazonaws.rds#CreateDBInstanceResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#AuthorizationNotFoundFault" - }, - { - "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DomainNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InstanceQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidSubnet" - }, - { - "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" - }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - }, - { - "target": "com.amazonaws.rds#NetworkTypeNotSupported" - }, - { - "target": "com.amazonaws.rds#OptionGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" - }, - { - "target": "com.amazonaws.rds#StorageQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new DB instance.

\n

The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. \n For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance \n to the cluster.

\n

For more information about creating an RDS DB instance, see \n Creating an Amazon RDS DB instance in the Amazon RDS User Guide.

\n

For more information about creating a DB instance in an Aurora DB cluster, see \n \n Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.

" - } - }, - "com.amazonaws.rds#CreateDBInstanceMessage": { - "type": "structure", - "members": { - "DBName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The meaning of this parameter differs according to the database engine you use.

\n

\n MySQL\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n \n

\n MariaDB\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n \n

\n PostgreSQL\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres \n is created in the DB instance.

\n

Constraints:

\n \n

\n Oracle\n

\n

The Oracle System ID (SID) of the created DB instance.\n If you specify null, the default value ORCL is used.\n You can't specify the string NULL, or any other reserved word, for DBName.

\n

Default: ORCL\n

\n

Constraints:

\n \n

\n Amazon RDS Custom for Oracle\n

\n

The Oracle System ID (SID) of the created RDS Custom DB instance.\n If you don't specify a value, the default value is ORCL.

\n

Default: ORCL\n

\n

Constraints:

\n \n

\n Amazon RDS Custom for SQL Server\n

\n

Not applicable. Must be null.

\n

\n SQL Server\n

\n

Not applicable. Must be null.

\n

\n Amazon Aurora MySQL\n

\n

The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created \n in the DB cluster.

\n

Constraints:

\n \n

\n Amazon Aurora PostgreSQL\n

\n

The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, \n a database named postgres is created in the DB cluster.

\n

Constraints:

\n " - } - }, - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB instance identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mydbinstance\n

", - "smithy.api#required": {} - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate for the DB instance.

\n

Type: Integer

\n

\n Amazon Aurora\n

\n

Not applicable. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.

\n

\n Amazon RDS Custom\n

\n

Constraints to the amount of storage for each storage type are the following:

\n \n

\n MySQL\n

\n

Constraints to the amount of storage for each storage type are the following:

\n \n

\n MariaDB\n

\n

Constraints to the amount of storage for each storage type are the following:

\n \n

\n PostgreSQL\n

\n

Constraints to the amount of storage for each storage type are the following:

\n \n

\n Oracle\n

\n

Constraints to the amount of storage for each storage type are the following:

\n \n

\n SQL Server\n

\n

Constraints to the amount of storage for each storage type are the following:

\n " - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the DB instance, for example db.m5.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes, and availability for your engine, see\n DB instance \n classes in the Amazon RDS User Guide or \n Aurora \n DB instance classes in the Amazon Aurora User Guide.

", - "smithy.api#required": {} - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the database engine to be used for this instance.

\n

Not every database engine is available for every Amazon Web Services Region.

\n

Valid Values:

\n ", - "smithy.api#required": {} - } - }, - "MasterUsername": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name for the master user.

\n

\n Amazon Aurora\n

\n

Not applicable. The name for the master user is managed by the DB cluster.

\n

\n Amazon RDS\n

\n

Constraints:

\n " - } - }, - "MasterUserPassword": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

\n Amazon Aurora\n

\n

Not applicable. The password for the master user is managed by the DB\n cluster.

\n

Constraints: Can't be specified if ManageMasterUserPassword is turned on.

\n

\n MariaDB\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Microsoft SQL Server\n

\n

Constraints: Must contain from 8 to 128 characters.

\n

\n MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Oracle\n

\n

Constraints: Must contain from 8 to 30 characters.

\n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

" - } - }, - "DBSecurityGroups": { - "target": "com.amazonaws.rds#DBSecurityGroupNameList", - "traits": { - "smithy.api#documentation": "

A list of DB security groups to associate with this DB instance.

\n

This setting applies to the legacy EC2-Classic platform, which is no longer used to create \n new DB instances. Use the VpcSecurityGroupIds setting instead.

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to associate with this DB instance.

\n

\n Amazon Aurora\n

\n

Not applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Availability Zone (AZ) where the database will be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.

\n

\n Amazon Aurora\n

\n

Each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these \n Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

Example: us-east-1d\n

\n

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.

" - } - }, - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A DB subnet group to associate with this DB instance.

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mydbsubnetgroup\n

" - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The time range each week during which system maintenance can occur, \n in Universal Coordinated Time (UTC). \n For more information, see Amazon RDS Maintenance Window.

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week.

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

" - } - }, - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then \n the default DB parameter group for the specified DB engine and version is used.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n " - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days for which automated backups are retained. Setting this parameter to a positive number enables \n backups. Setting this parameter to 0 disables automated backups.

\n

\n Amazon Aurora\n

\n

Not applicable. The retention period for automated backups is managed by the DB cluster.

\n

Default: 1

\n

Constraints:

\n " - } - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.

\n

\n Amazon Aurora\n

\n

Not applicable. The daily time range for creating automated backups is managed by\n the DB cluster.

\n

Constraints:

\n " - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

\n MySQL\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

\n

Type: Integer

\n

\n MariaDB\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

\n

Type: Integer

\n

\n PostgreSQL\n

\n

Default: 5432\n

\n

Valid values: 1150-65535\n

\n

Type: Integer

\n

\n Oracle\n

\n

Default: 1521\n

\n

Valid values: 1150-65535\n

\n

\n SQL Server\n

\n

Default: 1433\n

\n

Valid values: 1150-65535 except 1234, 1434,\n 3260, 3343, 3389, 47001, and\n 49152-49156.

\n

\n Amazon Aurora\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

\n

Type: Integer

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set \n the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. DB instance Availability Zones (AZs) are managed by the DB cluster.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.

\n

For a list of valid engine versions, use the DescribeDBEngineVersions\n operation.

\n

The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.

\n

\n Amazon Aurora\n

\n

Not applicable. The version number of the database engine to be used by the DB\n instance is managed by the DB cluster.

\n

\n Amazon RDS Custom for Oracle\n

\n

A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV \n name has the following format: 19.customized_string. A valid CEV name is \n 19.my_cev1. For more information, see \n Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.

\n

\n Amazon RDS Custom for SQL Server\n

\n

See RDS Custom for SQL Server general requirements \n in the Amazon RDS User Guide.

\n

\n MariaDB\n

\n

For information, see MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.

\n

\n Microsoft SQL Server\n

\n

For information, see Microsoft SQL Server Versions on Amazon RDS in the \n Amazon RDS User Guide.

\n

\n MySQL\n

\n

For information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.

\n

\n Oracle\n

\n

For information, see Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.

\n

\n PostgreSQL\n

\n

For information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.

" - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to \n false.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

License model information for this DB instance.

\n

Valid values: license-included | bring-your-own-license | general-public-license\n

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable.

" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.\n For information about valid IOPS values, see \n Amazon RDS DB instance storage \n in the Amazon RDS User Guide.

\n

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 \n of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 \n of the storage amount for the DB instance.

\n

\n Amazon Aurora\n

\n

Not applicable. Storage is managed by the DB cluster.

" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A value that indicates that the DB instance should be associated with the specified option group.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group. Also, that option group can't be removed from a DB instance after it is \n associated with a DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable.

" - } - }, - "CharacterSetName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

For supported engines, this value indicates that the DB instance should be associated with the \n specified CharacterSet.

\n

This setting doesn't apply to RDS Custom. However, if you need to change the character set, \n you can change it on the database itself.

\n

\n Amazon Aurora\n

\n

Not applicable. The character set is managed by\n the DB cluster. For more information, see CreateDBCluster.

" - } - }, - "NcharCharacterSetName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the NCHAR character set for the Oracle DB instance.

\n

This parameter doesn't apply to RDS Custom.

" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from \n within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n " - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

Tags to assign to the DB instance.

" - } - }, - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DB cluster that the instance will belong to.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

\n

\n Amazon Aurora\n

\n

Not applicable. Storage is managed by the DB cluster.

" - } - }, - "TdeCredentialArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable.

" - } - }, - "TdeCredentialPassword": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "StorageEncrypted": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

\n

For RDS Custom instances, either set this parameter to true or leave it unset. \n If you set this parameter to false, RDS reports an error.

\n

\n Amazon Aurora\n

\n

Not applicable. The encryption for DB instances is managed by the DB cluster.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

\n Amazon Aurora\n

\n

Not applicable. The Amazon Web Services KMS key identifier is managed by\n the DB cluster. For more information, see CreateDBCluster.

\n

If StorageEncrypted is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS uses your default KMS key. There is a \n default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.

\n

\n Amazon RDS Custom\n

\n

A KMS key is required for RDS Custom instances. For most RDS engines, if you leave this parameter empty \n while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom \n doesn't use the default key when this parameter is empty. You must explicitly specify a key.

" - } - }, - "Domain": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. The domain is managed by the DB cluster.

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

\n

\n Amazon Aurora\n

\n

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting.

" - } - }, - "MonitoringInterval": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for \n the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.

\n

If MonitoringRoleArn is specified, then you must set MonitoringInterval\n to a value other than 0.

\n

This setting doesn't apply to RDS Custom.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

" - } - }, - "MonitoringRoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "DomainIAMRoleName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. The domain is managed by the DB cluster.

" - } - }, - "PromotionTier": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

\n

This setting doesn't apply to RDS Custom.

\n

Default: 1

\n

Valid Values: 0 - 15

" - } - }, - "Timezone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The time zone of the DB instance. \n The time zone parameter is currently supported only by\n Microsoft SQL Server.

" - } - }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

For more information, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.

" - } - }, - "EnablePerformanceInsights": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the DB instance. For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "PerformanceInsightsKMSKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "PerformanceInsightsRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine. For more information, see \n \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

\n Amazon Aurora\n

\n

Not applicable. CloudWatch Logs exports are managed by the DB cluster.

\n

\n RDS Custom\n

\n

Not applicable.

\n

\n MariaDB\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Microsoft SQL Server\n

\n

Possible values are agent and error.

\n

\n MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Oracle\n

\n

Possible values are alert, audit, listener, trace, and\n oemagent.

\n

\n PostgreSQL\n

\n

Possible values are postgresql and upgrade.

" - } - }, - "ProcessorFeatures": { - "target": "com.amazonaws.rds#ProcessorFeatureList", - "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable.

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

\n

\n Amazon Aurora\n

\n

Not applicable. You can enable or disable deletion protection for the DB cluster. \n For more information, see CreateDBCluster. DB instances in a DB \n cluster can be deleted even when deletion protection is enabled for the DB cluster.

" - } - }, - "MaxAllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. Storage is managed by the DB cluster.

" - } - }, - "EnableCustomerOwnedIp": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" - } - }, - "CustomIamInstanceProfile": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n \n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" - } - }, - "BackupTarget": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies where automated backups and manual snapshots are stored.

\n

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" - } - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" - } - }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting applies only to the gp3 storage type.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" - } - }, - "ManageMasterUserPassword": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

\n " - } - }, - "MasterUserSecretKmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#CreateDBInstanceReadReplica": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateDBInstanceReadReplicaMessage" - }, - "output": { - "target": "com.amazonaws.rds#CreateDBInstanceReadReplicaResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupNotAllowedFault" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DomainNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InstanceQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBSubnetGroupFault" - }, - { - "target": "com.amazonaws.rds#InvalidSubnet" - }, - { - "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" - }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - }, - { - "target": "com.amazonaws.rds#NetworkTypeNotSupported" - }, - { - "target": "com.amazonaws.rds#OptionGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" - }, - { - "target": "com.amazonaws.rds#StorageQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new DB instance that acts as a read replica for an existing source DB\n instance. You can create a read replica for a DB instance running MySQL, MariaDB,\n Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read\n Replicas in the Amazon RDS User Guide.

\n

Amazon Aurora doesn't support this operation. Call the CreateDBInstance\n operation to create a DB instance for an Aurora DB cluster.

\n

All read replica DB instances are created with backups disabled. All other DB\n instance attributes (including DB security groups and DB parameter groups) are inherited\n from the source DB instance, except as specified.

\n \n

Your source DB instance must have backup retention enabled.

\n " - } - }, - "com.amazonaws.rds#CreateDBInstanceReadReplicaMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB instance identifier of the read replica. This identifier is the unique key\n that identifies a DB instance. This parameter is stored as a lowercase string.

", - "smithy.api#required": {} - } - }, - "SourceDBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DB instance that will act as the source for the read replica.\n Each DB instance can have up to five read replicas.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the read replica, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.

\n

Default: Inherits from the source DB instance.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Availability Zone (AZ) where the read replica will be created.

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

Example: us-east-1d\n

" - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port number that the DB instance uses for connections.

\n

Default: Inherits from the source DB instance

\n

Valid Values: 1150-65535\n

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the read replica is in a Multi-AZ deployment.

\n

You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of\n your replica in another Availability Zone for failover support for the replica. Creating\n your read replica as a Multi-AZ DB instance is independent of whether the source\n database is a Multi-AZ DB instance.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically to the\n read replica during the maintenance window.

\n

This setting doesn't apply to RDS Custom.

\n

Default: Inherits from the source DB instance

" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.

\n \n

For SQL Server, you must use the option group associated with the source\n instance.

\n \n

This setting doesn't apply to RDS Custom.

" - } - }, - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance.

\n

If you do not specify a value for DBParameterGroupName, then Amazon RDS\n uses the DBParameterGroup of source DB instance for a same Region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross-Region read replica.

\n

Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. \n It isn't supported for RDS Custom.

\n

Constraints:

\n " - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - }, - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

\n

Constraints:

\n \n

Example: mydbsubnetgroup\n

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to associate with the read replica.

\n

This setting doesn't apply to RDS Custom.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the read replica.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the read replica to snapshots of\n the read replica. By default, tags are not copied.

" - } - }, - "MonitoringInterval": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are\n collected for the read replica. To disable collecting Enhanced Monitoring metrics,\n specify 0. The default is 0.

\n

If MonitoringRoleArn is specified, then you must also set MonitoringInterval\n to a value other than 0.

\n

This setting doesn't apply to RDS Custom.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

" - } - }, - "MonitoringRoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, then you must \n supply a MonitoringRoleArn value.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted read replica.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you create an encrypted read replica in the same Amazon Web Services Region as the source DB\n instance, then do not specify a value for this parameter. A read replica in the same Amazon Web Services Region\n is always encrypted with the same KMS key as the source DB instance.

\n

If you create an encrypted read replica in a different Amazon Web Services Region, then you must\n specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to\n the Amazon Web Services Region that they are created in, and you can't use KMS keys from one\n Amazon Web Services Region in another Amazon Web Services Region.

\n

You can't create an encrypted read replica from an unencrypted DB instance.

\n

This setting doesn't apply to RDS Custom, which uses the same KMS key as the primary \n replica.

" - } - }, - "PreSignedUrl": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or\n from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4\n signed request for the CreateDBInstanceReadReplica API operation in the\n source Amazon Web Services Region that contains the source DB instance.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions and \n China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.

\n

You must specify this parameter when you create an encrypted read replica from\n another Amazon Web Services Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same Amazon Web Services Region.

\n

The presigned URL must be a valid request for the\n CreateDBInstanceReadReplica API operation that can run in the\n source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL\n request must contain the following parameter values:

\n \n

To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n

\n SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server \n doesn't support cross-Region read replicas.

\n \n

This setting doesn't apply to RDS Custom.

" - } - }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "EnablePerformanceInsights": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the read replica.

\n

For more information, see Using\n Amazon Performance Insights in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "PerformanceInsightsKMSKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "PerformanceInsightsRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

The list of logs that the new DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing\n Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "ProcessorFeatures": { - "target": "com.amazonaws.rds#ProcessorFeatureList", - "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "UseDefaultProcessorFeatures": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" - } - }, - "Domain": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "DomainIAMRoleName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "ReplicaMode": { - "target": "com.amazonaws.rds#ReplicaMode", - "traits": { - "smithy.api#documentation": "

The open mode of the replica database: mounted or read-only.

\n \n

This parameter is only supported for Oracle DB instances.

\n \n

Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for\n mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active\n Data Guard to transmit information to the mounted replica. Because it doesn't accept\n user connections, a mounted replica can't serve a read-only workload.

\n

You can create a combination of mounted and read-only DB replicas for the same primary DB instance.\n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.

\n

For RDS Custom, you must specify this parameter and set it to mounted. The value won't be set by default. \n After replica creation, you can manage the open mode manually.

" - } - }, - "MaxAllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

" - } - }, - "CustomIamInstanceProfile": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n \n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" - } - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for read replica. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" - } - }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the storage throughput value for the read replica.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" - } - }, - "EnableCustomerOwnedIp": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts read replica.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the read replica from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" - } - } - } - }, - "com.amazonaws.rds#CreateDBInstanceReadReplicaResult": { - "type": "structure", - "members": { - "DBInstance": { - "target": "com.amazonaws.rds#DBInstance" - } - } - }, - "com.amazonaws.rds#CreateDBInstanceResult": { - "type": "structure", - "members": { - "DBInstance": { - "target": "com.amazonaws.rds#DBInstance" - } - } - }, - "com.amazonaws.rds#CreateDBParameterGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateDBParameterGroupMessage" - }, - "output": { - "target": "com.amazonaws.rds#CreateDBParameterGroupResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBParameterGroupQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new DB parameter group.

\n

A DB parameter group is initially created with the default parameters for the\n database engine used by the DB instance. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBParameterGroup. Once you've created a DB parameter group, you need to\n associate it with your DB instance using ModifyDBInstance. When you associate\n a new DB parameter group with a running DB instance, you need to reboot the DB\n instance without failover for the new DB parameter group and associated settings to take effect.

\n

This command doesn't apply to RDS Custom.

\n \n

After you create a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.

\n " - } - }, - "com.amazonaws.rds#CreateDBParameterGroupMessage": { - "type": "structure", - "members": { - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n \n \n

This value is stored as a lowercase string.

\n ", - "smithy.api#required": {} - } - }, - "DBParameterGroupFamily": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

\n

To list all of the available parameter group families for a DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n

\n

For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine mysql\n

\n \n

The output contains duplicates.

\n \n

The following are the valid DB engine values:

\n ", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description for the DB parameter group.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

Tags to assign to the DB parameter group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#CreateDBParameterGroupResult": { - "type": "structure", - "members": { - "DBParameterGroup": { - "target": "com.amazonaws.rds#DBParameterGroup" - } - } - }, - "com.amazonaws.rds#CreateDBProxy": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateDBProxyRequest" - }, - "output": { - "target": "com.amazonaws.rds#CreateDBProxyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBProxyAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBProxyQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#InvalidSubnet" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new DB proxy.

" - } - }, - "com.amazonaws.rds#CreateDBProxyEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateDBProxyEndpointRequest" - }, - "output": { - "target": "com.amazonaws.rds#CreateDBProxyEndpointResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBProxyEndpointAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBProxyEndpointQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#DBProxyNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBProxyStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidSubnet" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters.\n You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use\n DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC.

" - } - }, - "com.amazonaws.rds#CreateDBProxyEndpointRequest": { - "type": "structure", - "members": { - "DBProxyName": { - "target": "com.amazonaws.rds#DBProxyName", - "traits": { - "smithy.api#documentation": "

The name of the DB proxy associated with the DB proxy endpoint that you create.

", - "smithy.api#required": {} - } - }, - "DBProxyEndpointName": { - "target": "com.amazonaws.rds#DBProxyEndpointName", - "traits": { - "smithy.api#documentation": "

The name of the DB proxy endpoint to create.

", - "smithy.api#required": {} - } - }, - "VpcSubnetIds": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a\n different set of subnet IDs than for the original DB proxy.

", - "smithy.api#required": {} - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The VPC security group IDs for the DB proxy endpoint that you create. You can\n specify a different set of security group IDs than for the original DB proxy.\n The default is the default security group for the VPC.

" - } - }, - "TargetRole": { - "target": "com.amazonaws.rds#DBProxyEndpointTargetRole", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB proxy endpoint can be used for read/write\n or read-only operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server \n support is READ_WRITE.

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - } - } - }, - "com.amazonaws.rds#CreateDBProxyEndpointResponse": { - "type": "structure", - "members": { - "DBProxyEndpoint": { - "target": "com.amazonaws.rds#DBProxyEndpoint", - "traits": { - "smithy.api#documentation": "

The DBProxyEndpoint object that is created by the API operation.\n The DB proxy endpoint that you create might provide capabilities such as read/write\n or read-only operations, or using a different VPC than the proxy's default VPC.

" - } - } - } - }, - "com.amazonaws.rds#CreateDBProxyRequest": { - "type": "structure", - "members": { - "DBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

", - "smithy.api#required": {} - } - }, - "EngineFamily": { - "target": "com.amazonaws.rds#EngineFamily", - "traits": { - "smithy.api#documentation": "

The kinds of databases that the proxy can connect to. \n This value determines which database network protocol the proxy recognizes when it interprets\n network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL. \n For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL. For RDS for Microsoft SQL Server, specify \n SQLSERVER.

", - "smithy.api#required": {} - } - }, - "Auth": { - "target": "com.amazonaws.rds#UserAuthConfigList", - "traits": { - "smithy.api#documentation": "

The authorization mechanism that the proxy uses.

", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

", - "smithy.api#required": {} - } - }, - "VpcSubnetIds": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

One or more VPC subnet IDs to associate with the new proxy.

", - "smithy.api#required": {} - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

One or more VPC security group IDs to associate with the new proxy.

" - } - }, - "RequireTLS": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.\n By enabling this setting, you can enforce encrypted TLS connections to the proxy.

" - } - }, - "IdleClientTimeout": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this\n value higher or lower than the connection timeout limit for the associated database.

" - } - }, - "DebugLogging": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

" - } - } - } - }, - "com.amazonaws.rds#CreateDBProxyResponse": { - "type": "structure", - "members": { - "DBProxy": { - "target": "com.amazonaws.rds#DBProxy", - "traits": { - "smithy.api#documentation": "

The DBProxy structure corresponding to the new proxy.

" - } - } - } - }, - "com.amazonaws.rds#CreateDBSecurityGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateDBSecurityGroupMessage" - }, - "output": { - "target": "com.amazonaws.rds#CreateDBSecurityGroupResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBSecurityGroupAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBSecurityGroupNotSupportedFault" - }, - { - "target": "com.amazonaws.rds#DBSecurityGroupQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new DB security group. DB security groups control access to a DB instance.

\n

A DB security group controls access to EC2-Classic DB instances that are not in a VPC.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring ā€“ \n Hereā€™s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n " - } - }, - "com.amazonaws.rds#CreateDBSecurityGroupMessage": { - "type": "structure", - "members": { - "DBSecurityGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name for the DB security group. This value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mysecuritygroup\n

", - "smithy.api#required": {} - } - }, - "DBSecurityGroupDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description for the DB security group.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

Tags to assign to the DB security group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#CreateDBSecurityGroupResult": { - "type": "structure", - "members": { - "DBSecurityGroup": { - "target": "com.amazonaws.rds#DBSecurityGroup" - } - } - }, - "com.amazonaws.rds#CreateDBSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateDBSnapshotMessage" - }, - "output": { - "target": "com.amazonaws.rds#CreateDBSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSnapshotAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a snapshot of a DB instance. The source DB instance must be in the available or\n storage-optimization state.

" - } - }, - "com.amazonaws.rds#CreateDBSnapshotMessage": { - "type": "structure", - "members": { - "DBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the DB snapshot.

\n

Constraints:

\n \n

Example: my-snapshot-id\n

", - "smithy.api#required": {} - } - }, - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DB instance that you want to create the snapshot of.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#CreateDBSnapshotResult": { - "type": "structure", - "members": { - "DBSnapshot": { - "target": "com.amazonaws.rds#DBSnapshot" - } - } - }, - "com.amazonaws.rds#CreateDBSubnetGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateDBSubnetGroupMessage" - }, - "output": { - "target": "com.amazonaws.rds#CreateDBSubnetGroupResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBSubnetGroupAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#DBSubnetQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#InvalidSubnet" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

" - } - }, - "com.amazonaws.rds#CreateDBSubnetGroupMessage": { - "type": "structure", - "members": { - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name for the DB subnet group. This value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mydbsubnetgroup\n

", - "smithy.api#required": {} - } - }, - "DBSubnetGroupDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description for the DB subnet group.

", - "smithy.api#required": {} - } - }, - "SubnetIds": { - "target": "com.amazonaws.rds#SubnetIdentifierList", - "traits": { - "smithy.api#documentation": "

The EC2 Subnet IDs for the DB subnet group.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

Tags to assign to the DB subnet group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#CreateDBSubnetGroupResult": { - "type": "structure", - "members": { - "DBSubnetGroup": { - "target": "com.amazonaws.rds#DBSubnetGroup" - } - } - }, - "com.amazonaws.rds#CreateEventSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateEventSubscriptionMessage" - }, - "output": { - "target": "com.amazonaws.rds#CreateEventSubscriptionResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#EventSubscriptionQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#SNSInvalidTopicFault" - }, - { - "target": "com.amazonaws.rds#SNSNoAuthorizationFault" - }, - { - "target": "com.amazonaws.rds#SNSTopicArnNotFoundFault" - }, - { - "target": "com.amazonaws.rds#SourceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#SubscriptionAlreadyExistFault" - }, - { - "target": "com.amazonaws.rds#SubscriptionCategoryNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an RDS event notification subscription. This operation requires a topic Amazon\n Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API.\n To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the\n topic. The ARN is displayed in the SNS console.

\n

You can specify the type of source (SourceType) that you want to be\n notified of and provide a list of RDS sources (SourceIds) that triggers the\n events. You can also provide a list of event categories (EventCategories)\n for events that you want to be notified of. For example, you can specify\n SourceType = db-instance, SourceIds =\n mydbinstance1, mydbinstance2 and\n EventCategories = Availability,\n Backup.

\n

If you specify both the SourceType and SourceIds, such as SourceType = db-instance\n and SourceIds = myDBInstance1, you are notified of all the db-instance events for\n the specified source. If you specify a SourceType but do not specify SourceIds,\n you receive notice of the events for that source type for all your RDS sources. If you\n don't specify either the SourceType or the SourceIds, you are notified of events\n generated from all RDS sources belonging to your customer account.

\n

For more information about subscribing to an event for RDS DB engines, see \n \n Subscribing to Amazon RDS event notification in the Amazon RDS User Guide.

\n

For more information about subscribing to an event for Aurora DB engines, see \n \n Subscribing to Amazon RDS event notification in the Amazon Aurora User Guide.

" - } - }, - "com.amazonaws.rds#CreateEventSubscriptionMessage": { - "type": "structure", - "members": { - "SubscriptionName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the subscription.

\n

Constraints: The name must be less than 255 characters.

", - "smithy.api#required": {} - } - }, - "SnsTopicArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

", - "smithy.api#required": {} - } - }, - "SourceType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The type of source that is generating the events. For example, if you want to be\n notified of events generated by a DB instance, you set this parameter to\n db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are\n returned.

\n

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n

" - } - }, - "EventCategories": { - "target": "com.amazonaws.rds#EventCategoriesList", - "traits": { - "smithy.api#documentation": "

A list of event categories for a particular source type (SourceType)\n that you want to subscribe to. You can see a list of the categories for a given source type in the \"Amazon RDS event categories and event messages\" section of the \n Amazon RDS User Guide\n or the\n \n Amazon Aurora User Guide\n .\n You can also see this list by using the DescribeEventCategories operation.

" - } - }, - "SourceIds": { - "target": "com.amazonaws.rds#SourceIdsList", - "traits": { - "smithy.api#documentation": "

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. \n An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.

\n

Constraints:

\n " - } - }, - "Enabled": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#CreateEventSubscriptionResult": { - "type": "structure", - "members": { - "EventSubscription": { - "target": "com.amazonaws.rds#EventSubscription" - } - } - }, - "com.amazonaws.rds#CreateGlobalCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateGlobalClusterMessage" - }, - "output": { - "target": "com.amazonaws.rds#CreateGlobalClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#GlobalClusterAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#GlobalClusterQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an Aurora global database\n spread across multiple Amazon Web Services Regions. The global database\n contains a single primary cluster with read-write capability,\n and a read-only secondary cluster that receives\n data from the primary cluster through high-speed replication\n performed by the Aurora storage subsystem.

\n

You can create a global database that is initially empty, and then\n add a primary cluster and a secondary cluster to it.\n Or you can specify an existing Aurora cluster during the create operation,\n and this cluster becomes the primary cluster of the global database.

\n \n

This action applies only to Aurora DB clusters.

\n " - } - }, - "com.amazonaws.rds#CreateGlobalClusterMessage": { - "type": "structure", - "members": { - "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The cluster identifier of the new global database cluster.

" - } - }, - "SourceDBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) to use as the primary cluster of the global database.\n This parameter is optional.

" - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the database engine to be used for this DB cluster.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The engine version of the Aurora global database.

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

The deletion protection setting for the new global database.\n The global database can't be deleted when deletion protection is enabled.

" - } - }, - "DatabaseName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name for your database of up to 64 alphanumeric characters. If you do not provide\n a name, Amazon Aurora will not create a database in the global database cluster you are\n creating.

" - } - }, - "StorageEncrypted": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

The storage encryption setting for the new global database cluster.

" - } - } - } - }, - "com.amazonaws.rds#CreateGlobalClusterResult": { - "type": "structure", - "members": { - "GlobalCluster": { - "target": "com.amazonaws.rds#GlobalCluster" - } - } - }, - "com.amazonaws.rds#CreateOptionGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateOptionGroupMessage" - }, - "output": { - "target": "com.amazonaws.rds#CreateOptionGroupResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#OptionGroupAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#OptionGroupQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new option group. You can create up to 20 option groups.

\n

This command doesn't apply to RDS Custom.

" - } - }, - "com.amazonaws.rds#CreateOptionGroupMessage": { - "type": "structure", - "members": { - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the option group to be created.

\n

Constraints:

\n \n

Example: myoptiongroup\n

", - "smithy.api#required": {} - } - }, - "EngineName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the engine that this option group should be associated with.

\n

Valid Values:

\n ", - "smithy.api#required": {} - } - }, - "MajorEngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the major version of the engine that this option group should be associated with.

", - "smithy.api#required": {} - } - }, - "OptionGroupDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description of the option group.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

Tags to assign to the option group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#CreateOptionGroupResult": { - "type": "structure", - "members": { - "OptionGroup": { - "target": "com.amazonaws.rds#OptionGroup" - } - } - }, - "com.amazonaws.rds#CustomAvailabilityZoneNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "CustomAvailabilityZoneNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n CustomAvailabilityZoneId doesn't refer to an existing custom\n Availability Zone identifier.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#CustomDBEngineVersionAMI": { - "type": "structure", - "members": { - "ImageId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A value that indicates the ID of the AMI.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A value that indicates the status of a custom engine version (CEV).

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A value that indicates the AMI information.

" - } - }, - "com.amazonaws.rds#CustomDBEngineVersionAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "CustomDBEngineVersionAlreadyExistsFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

A CEV with the specified name already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#CustomDBEngineVersionManifest": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 51000 - }, - "smithy.api#pattern": "^[\\s\\S]*$" - } - }, - "com.amazonaws.rds#CustomDBEngineVersionNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "CustomDBEngineVersionNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The specified CEV was not found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#CustomDBEngineVersionQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "CustomDBEngineVersionQuotaExceededFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

You have exceeded your CEV quota.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#CustomEngineName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 35 - }, - "smithy.api#pattern": "^[A-Za-z0-9-]{1,35}$" - } - }, - "com.amazonaws.rds#CustomEngineVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 60 - }, - "smithy.api#pattern": "^[a-z0-9_.-]{1,60}$" - } - }, - "com.amazonaws.rds#CustomEngineVersionStatus": { - "type": "enum", - "members": { - "available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "inactive": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "inactive" - } - }, - "inactive_except_restore": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "inactive-except-restore" - } - } - } - }, - "com.amazonaws.rds#DBCluster": { - "type": "structure", - "members": { - "AllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). \n For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically\n adjusts as needed.

" - } - }, - "AvailabilityZones": { - "target": "com.amazonaws.rds#AvailabilityZones", - "traits": { - "smithy.api#documentation": "

Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the number of days for which automatic DB snapshots are retained.

" - } - }, - "CharacterSetName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

If present, specifies the name of the character set that this cluster is associated with.

" - } - }, - "DatabaseName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

" - } - }, - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

" - } - }, - "DBClusterParameterGroup": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the DB cluster parameter group for the DB cluster.

" - } - }, - "DBSubnetGroup": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the current state of this DB cluster.

" - } - }, - "AutomaticRestartTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The time when a stopped DB cluster is restarted automatically.

" - } - }, - "PercentProgress": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the progress of the operation as a percentage.

" - } - }, - "EarliestRestorableTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The earliest time to which a database can be restored with point-in-time\n restore.

" - } - }, - "Endpoint": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the connection endpoint for the primary instance of the DB cluster.

" - } - }, - "ReaderEndpoint": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances \n connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections \n to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. \n This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

\n

If a failover occurs, and the Aurora Replica that you are connected to is promoted \n to be the primary instance, your connection is dropped. To \n continue sending your read workload to other Aurora Replicas in the cluster,\n you can then reconnect to the reader endpoint.

" - } - }, - "CustomEndpoints": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

Identifies all custom endpoints associated with the cluster.

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether the DB cluster has instances in multiple Availability Zones.

" - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the database engine to be used for this DB cluster.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Indicates the database engine version.

" - } - }, - "LatestRestorableTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

Specifies the latest time to which a database can be restored with point-in-time restore.

" - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the port that the database engine is listening on.

" - } - }, - "MasterUsername": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Contains the master username for the DB cluster.

" - } - }, - "DBClusterOptionGroupMemberships": { - "target": "com.amazonaws.rds#DBClusterOptionGroupMemberships", - "traits": { - "smithy.api#documentation": "

Provides the list of option group memberships for this DB cluster.

" - } - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.

" - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

" - } - }, - "ReplicationSourceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Contains the identifier of the source DB cluster if this DB cluster is a read\n replica.

" - } - }, - "ReadReplicaIdentifiers": { - "target": "com.amazonaws.rds#ReadReplicaIdentifierList", - "traits": { - "smithy.api#documentation": "

Contains one or more identifiers of the read replicas associated with this DB\n cluster.

" - } - }, - "DBClusterMembers": { - "target": "com.amazonaws.rds#DBClusterMemberList", - "traits": { - "smithy.api#documentation": "

Provides the list of instances that make up the DB cluster.

" - } - }, - "VpcSecurityGroups": { - "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", - "traits": { - "smithy.api#documentation": "

Provides a list of VPC security groups that the DB cluster belongs to.

" - } - }, - "HostedZoneId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

" - } - }, - "StorageEncrypted": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the DB cluster is encrypted.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" - } - }, - "DbClusterResourceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever \n the KMS key for the DB cluster is accessed.

" - } - }, - "DBClusterArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB cluster.

" - } - }, - "AssociatedRoles": { - "target": "com.amazonaws.rds#DBClusterRoles", - "traits": { - "smithy.api#documentation": "

Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. \n IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services\n on your behalf.

" - } - }, - "IAMDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" - } - }, - "CloneGroupId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Identifies the clone group to which the DB cluster is associated.

" - } - }, - "ClusterCreateTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

" - } - }, - "EarliestBacktrackTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The earliest time to which a DB cluster can be backtracked.

" - } - }, - "BacktrackWindow": { - "target": "com.amazonaws.rds#LongOptional", - "traits": { - "smithy.api#documentation": "

The target backtrack window, in seconds. If this value is set to 0, backtracking is\n disabled for the DB cluster. Otherwise, backtracking is enabled.

" - } - }, - "BacktrackConsumedChangeRecords": { - "target": "com.amazonaws.rds#LongOptional", - "traits": { - "smithy.api#documentation": "

The number of change records stored for Backtrack.

" - } - }, - "EnabledCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

A list of log types that this DB cluster is configured to export to CloudWatch Logs.

\n

Log types vary by DB engine. For information about the log types for each DB engine, see\n Amazon RDS Database Log Files in the Amazon Aurora User Guide.\n

" - } - }, - "Capacity": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) \n when the cluster is paused.

\n

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.

" - } - }, - "EngineMode": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB engine mode of the DB cluster, either provisioned, serverless,\n parallelquery, global, or multimaster.

\n

For more information, see \n CreateDBCluster.

" - } - }, - "ScalingConfigurationInfo": { - "target": "com.amazonaws.rds#ScalingConfigurationInfo" - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Indicates if the DB cluster has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.

" - } - }, - "HttpEndpointEnabled": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.

\n

When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.

\n

For more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.

" - } - }, - "ActivityStreamMode": { - "target": "com.amazonaws.rds#ActivityStreamMode", - "traits": { - "smithy.api#documentation": "

The mode of the database activity stream.\n Database events such as a change or access generate an activity stream event.\n The database session can handle these events either synchronously or asynchronously.

" - } - }, - "ActivityStreamStatus": { - "target": "com.amazonaws.rds#ActivityStreamStatus", - "traits": { - "smithy.api#documentation": "

The status of the database activity stream.

" - } - }, - "ActivityStreamKmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" - } - }, - "ActivityStreamKinesisStreamName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Kinesis data stream used for the database activity stream.

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

" - } - }, - "CrossAccountClone": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

" - } - }, - "DomainMemberships": { - "target": "com.amazonaws.rds#DomainMembershipList", - "traits": { - "smithy.api#documentation": "

The Active Directory Domain membership records associated with the DB cluster.

" - } - }, - "TagList": { - "target": "com.amazonaws.rds#TagList" - }, - "GlobalWriteForwardingStatus": { - "target": "com.amazonaws.rds#WriteForwardingStatus", - "traits": { - "smithy.api#documentation": "

Specifies whether a secondary cluster in an Aurora global database has\n write forwarding enabled, not enabled, or is in the process of enabling it.

" - } - }, - "GlobalWriteForwardingRequested": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether you have requested to enable write forwarding for a secondary cluster\n in an Aurora global database. Because write forwarding takes time to enable, check the\n value of GlobalWriteForwardingStatus to confirm that the request has completed\n before using the write forwarding feature for this cluster.

" - } - }, - "PendingModifiedValues": { - "target": "com.amazonaws.rds#ClusterPendingModifiedValues", - "traits": { - "smithy.api#documentation": "

A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. \n Specific changes are identified by subelements.

" - } - }, - "DBClusterInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the compute and memory capacity class of the DB instance.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The storage type associated with the DB cluster.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The Provisioned IOPS (I/O operations per second) value.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies the accessibility options for the DB instance.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private \n IP address from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates that minor version patches are applied automatically.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" - } - }, - "MonitoringInterval": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" - } - }, - "MonitoringRoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" - } - }, - "PerformanceInsightsEnabled": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

True if Performance Insights is enabled for the DB cluster, and otherwise false.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" - } - }, - "PerformanceInsightsKMSKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" - } - }, - "PerformanceInsightsRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

This setting is only for non-Aurora Multi-AZ DB clusters.

" - } - }, - "ServerlessV2ScalingConfiguration": { - "target": "com.amazonaws.rds#ServerlessV2ScalingConfigurationInfo" - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

This setting is only for Aurora DB clusters.

" - } - }, - "DBSystemId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Reserved for future use.

" - } - }, - "MasterUserSecret": { - "target": "com.amazonaws.rds#MasterUserSecret", - "traits": { - "smithy.api#documentation": "

Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.

\n

For an Amazon Aurora DB cluster, this data type is used as a response element in the operations \n CreateDBCluster, DeleteDBCluster, DescribeDBClusters, \n FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, \n RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, \n RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.

\n

For a Multi-AZ DB cluster, this data type is used as a response element in the operations \n CreateDBCluster, DeleteDBCluster, DescribeDBClusters, \n FailoverDBCluster, ModifyDBCluster, RebootDBCluster, \n RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" - } - }, - "com.amazonaws.rds#DBClusterAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterAlreadyExistsFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The user already has a DB cluster with the given identifier.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBClusterBacktrack": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

" - } - }, - "BacktrackIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Contains the backtrack identifier.

" - } - }, - "BacktrackTo": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The timestamp of the time to which the DB cluster was backtracked.

" - } - }, - "BacktrackedFrom": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The timestamp of the time from which the DB cluster was backtracked.

" - } - }, - "BacktrackRequestCreationTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The timestamp of the time at which the backtrack was requested.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The status of the backtrack. This property returns one of the following\n values:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the DescribeDBClusterBacktracks action.

" - } - }, - "com.amazonaws.rds#DBClusterBacktrackList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBClusterBacktrack", - "traits": { - "smithy.api#xmlName": "DBClusterBacktrack" - } - } - }, - "com.amazonaws.rds#DBClusterBacktrackMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a later DescribeDBClusterBacktracks request.

" - } - }, - "DBClusterBacktracks": { - "target": "com.amazonaws.rds#DBClusterBacktrackList", - "traits": { - "smithy.api#documentation": "

Contains a list of backtracks for the user.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBClusterBacktracks action.

" - } - }, - "com.amazonaws.rds#DBClusterBacktrackNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterBacktrackNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n BacktrackIdentifier doesn't refer to an existing backtrack.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBClusterCapacityInfo": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A user-supplied DB cluster identifier. This identifier is the unique key that\n identifies a DB cluster.

" - } - }, - "PendingCapacity": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

A value that specifies the capacity that the DB cluster scales to next.

" - } - }, - "CurrentCapacity": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The current capacity of the DB cluster.

" - } - }, - "SecondsBeforeTimeout": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.

" - } - }, - "TimeoutAction": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The timeout action of a call to ModifyCurrentDBClusterCapacity, either \n ForceApplyCapacityChange or RollbackCapacityChange.

" - } - } - } - }, - "com.amazonaws.rds#DBClusterEndpoint": { - "type": "structure", - "members": { - "DBClusterEndpointIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier associated with the endpoint. This parameter is stored as a lowercase string.

" - } - }, - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is\n stored as a lowercase string.

" - } - }, - "DBClusterEndpointResourceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

" - } - }, - "Endpoint": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DNS address of the endpoint.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster,\n such as a writer endpoint for a read-only secondary cluster in a global database.

" - } - }, - "EndpointType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The type of the endpoint. One of: READER, WRITER, CUSTOM.

" - } - }, - "CustomEndpointType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The type associated with a custom endpoint. One of: READER,\n WRITER, ANY.

" - } - }, - "StaticMembers": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

List of DB instance identifiers that are part of the custom endpoint group.

" - } - }, - "ExcludedMembers": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

List of DB instance identifiers that aren't part of the custom endpoint group.\n All other eligible instances are reachable through the custom endpoint.\n Only relevant if the list of static members is empty.

" - } - }, - "DBClusterEndpointArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the endpoint.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type represents the information you need to connect to an Amazon Aurora DB cluster.\n This data type is used as a response element in the following actions:

\n \n

For the data structure that represents Amazon RDS DB instance endpoints,\n see Endpoint.

" - } - }, - "com.amazonaws.rds#DBClusterEndpointAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterEndpointAlreadyExistsFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The specified custom endpoint can't be created because it already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBClusterEndpointList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBClusterEndpoint", - "traits": { - "smithy.api#xmlName": "DBClusterEndpointList" - } - } - }, - "com.amazonaws.rds#DBClusterEndpointMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterEndpoints request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "DBClusterEndpoints": { - "target": "com.amazonaws.rds#DBClusterEndpointList", - "traits": { - "smithy.api#documentation": "

Contains the details of the endpoints associated with the cluster\n and matching any filter conditions.

" - } - } - } - }, - "com.amazonaws.rds#DBClusterEndpointNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterEndpointNotFoundFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The specified custom endpoint doesn't exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBClusterEndpointQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterEndpointQuotaExceededFault", - "httpResponseCode": 403 - }, - "smithy.api#documentation": "

The cluster already has the maximum number of custom endpoints.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.rds#DBClusterIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[A-Za-z][0-9A-Za-z-:._]*$" - } - }, - "com.amazonaws.rds#DBClusterList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBCluster", - "traits": { - "smithy.api#xmlName": "DBCluster" - } - } - }, - "com.amazonaws.rds#DBClusterMember": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the instance identifier for this member of the DB cluster.

" - } - }, - "IsClusterWriter": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

" - } - }, - "DBClusterParameterGroupStatus": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the status of the DB cluster parameter group for this member of the DB cluster.

" - } - }, - "PromotionTier": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about an instance that is part of a DB cluster.

" - } - }, - "com.amazonaws.rds#DBClusterMemberList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBClusterMember", - "traits": { - "smithy.api#xmlName": "DBClusterMember" - } - } - }, - "com.amazonaws.rds#DBClusterMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a later DescribeDBClusters request.

" - } - }, - "DBClusters": { - "target": "com.amazonaws.rds#DBClusterList", - "traits": { - "smithy.api#documentation": "

Contains a list of DB clusters for the user.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBClusters action.

" - } - }, - "com.amazonaws.rds#DBClusterNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n DBClusterIdentifier doesn't refer to an existing DB cluster.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBClusterOptionGroupMemberships": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBClusterOptionGroupStatus", - "traits": { - "smithy.api#xmlName": "DBClusterOptionGroup" - } - } - }, - "com.amazonaws.rds#DBClusterOptionGroupStatus": { - "type": "structure", - "members": { - "DBClusterOptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the DB cluster option group.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the status of the DB cluster option group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains status information for a DB cluster option group.

" - } - }, - "com.amazonaws.rds#DBClusterParameterGroup": { - "type": "structure", - "members": { - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group.

" - } - }, - "DBParameterGroupFamily": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group family that this DB cluster parameter group is compatible with.

" - } - }, - "Description": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the customer-specified description for this DB cluster parameter group.

" - } - }, - "DBClusterParameterGroupArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB cluster parameter group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details of an Amazon RDS DB cluster parameter group.

\n

This data type is used as a response element in the DescribeDBClusterParameterGroups action.

" - } - }, - "com.amazonaws.rds#DBClusterParameterGroupDetails": { - "type": "structure", - "members": { - "Parameters": { - "target": "com.amazonaws.rds#ParametersList", - "traits": { - "smithy.api#documentation": "

Provides a list of parameters for the DB cluster parameter group.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.

" - } - }, - "com.amazonaws.rds#DBClusterParameterGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBClusterParameterGroup", - "traits": { - "smithy.api#xmlName": "DBClusterParameterGroup" - } - } - }, - "com.amazonaws.rds#DBClusterParameterGroupNameMessage": { - "type": "structure", - "members": { - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group.

\n

Constraints:

\n \n \n

This value is stored as a lowercase string.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterParameterGroupNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n DBClusterParameterGroupName doesn't refer to an existing DB\n cluster parameter group.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBClusterParameterGroupsMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "DBClusterParameterGroups": { - "target": "com.amazonaws.rds#DBClusterParameterGroupList", - "traits": { - "smithy.api#documentation": "

A list of DB cluster parameter groups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DBClusterQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterQuotaExceededFault", - "httpResponseCode": 403 - }, - "smithy.api#documentation": "

The user attempted to create a new DB cluster and the user has already reached the\n maximum allowed DB cluster quota.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.rds#DBClusterRole": { - "type": "structure", - "members": { - "RoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following\n values:

\n " - } - }, - "FeatureName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role.\n For information about supported feature names, see DBEngineVersion.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.

" - } - }, - "com.amazonaws.rds#DBClusterRoleAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterRoleAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBClusterRoleNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterRoleNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The specified IAM role Amazon Resource Name (ARN) isn't associated with the specified DB cluster.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBClusterRoleQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterRoleQuotaExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBClusterRoles": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBClusterRole", - "traits": { - "smithy.api#xmlName": "DBClusterRole" - } - } - }, - "com.amazonaws.rds#DBClusterSnapshot": { - "type": "structure", - "members": { - "AvailabilityZones": { - "target": "com.amazonaws.rds#AvailabilityZones", - "traits": { - "smithy.api#documentation": "

Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

" - } - }, - "DBClusterSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the identifier for the DB cluster snapshot.

" - } - }, - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

" - } - }, - "SnapshotCreateTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

" - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the database engine for this DB cluster snapshot.

" - } - }, - "EngineMode": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the engine mode of the database engine for this DB cluster snapshot.

" - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the allocated storage size in gibibytes (GiB).

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the status of this DB cluster snapshot. Valid statuses are the following:

\n " - } - }, - "Port": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the port that the DB cluster was listening on at the time of the snapshot.

" - } - }, - "VpcId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the VPC ID associated with the DB cluster snapshot.

" - } - }, - "ClusterCreateTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

" - } - }, - "MasterUsername": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the master username for this DB cluster snapshot.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the version of the database engine for this DB cluster snapshot.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the license model information for this DB cluster snapshot.

" - } - }, - "SnapshotType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the type of the DB cluster snapshot.

" - } - }, - "PercentProgress": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the percentage of the estimated data that has been transferred.

" - } - }, - "StorageEncrypted": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the DB cluster snapshot is encrypted.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" - } - }, - "DBClusterSnapshotArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB cluster snapshot.

" - } - }, - "SourceDBClusterSnapshotArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon\n Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

" - } - }, - "IAMDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

" - } - }, - "TagList": { - "target": "com.amazonaws.rds#TagList" - }, - "DBSystemId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Reserved for future use.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details for an Amazon RDS DB cluster snapshot

\n

This data type is used as a response element \n in the DescribeDBClusterSnapshots action.

" - } - }, - "com.amazonaws.rds#DBClusterSnapshotAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterSnapshotAlreadyExistsFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The user already has a DB cluster snapshot with the given identifier.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBClusterSnapshotAttribute": { - "type": "structure", - "members": { - "AttributeName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the manual DB cluster snapshot attribute.

\n

The attribute named restore refers to the list of Amazon Web Services accounts that\n have permission to copy or restore the manual DB cluster snapshot. For more information, \n see the ModifyDBClusterSnapshotAttribute\n API action.

" - } - }, - "AttributeValues": { - "target": "com.amazonaws.rds#AttributeValueList", - "traits": { - "smithy.api#documentation": "

The value(s) for the manual DB cluster snapshot attribute.

\n

If the AttributeName field is set to restore, then this element\n returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual\n DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot\n is public and available for any Amazon Web Services account to copy or restore.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the name and values of a manual DB cluster snapshot attribute.

\n

Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts\n to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute\n API action.

" - } - }, - "com.amazonaws.rds#DBClusterSnapshotAttributeList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBClusterSnapshotAttribute", - "traits": { - "smithy.api#xmlName": "DBClusterSnapshotAttribute" - } - } - }, - "com.amazonaws.rds#DBClusterSnapshotAttributesResult": { - "type": "structure", - "members": { - "DBClusterSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the manual DB cluster snapshot that the attributes apply to.

" - } - }, - "DBClusterSnapshotAttributes": { - "target": "com.amazonaws.rds#DBClusterSnapshotAttributeList", - "traits": { - "smithy.api#documentation": "

The list of attributes and values for the manual DB cluster snapshot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes\n API action.

\n

Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts\n to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute\n API action.

" - } - }, - "com.amazonaws.rds#DBClusterSnapshotList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBClusterSnapshot", - "traits": { - "smithy.api#xmlName": "DBClusterSnapshot" - } - } - }, - "com.amazonaws.rds#DBClusterSnapshotMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "DBClusterSnapshots": { - "target": "com.amazonaws.rds#DBClusterSnapshotList", - "traits": { - "smithy.api#documentation": "

Provides a list of DB cluster snapshots for the user.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.

" - } - }, - "com.amazonaws.rds#DBClusterSnapshotNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBClusterSnapshotNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBEngineVersion": { - "type": "structure", - "members": { - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the database engine.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version number of the database engine.

" - } - }, - "DBParameterGroupFamily": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group family for the database engine.

" - } - }, - "DBEngineDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description of the database engine.

" - } - }, - "DBEngineVersionDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description of the database engine version.

" - } - }, - "DefaultCharacterSet": { - "target": "com.amazonaws.rds#CharacterSet", - "traits": { - "smithy.api#documentation": "

The default character set for new instances of this engine version,\n if the CharacterSetName parameter of the CreateDBInstance API\n isn't specified.

" - } - }, - "Image": { - "target": "com.amazonaws.rds#CustomDBEngineVersionAMI", - "traits": { - "smithy.api#documentation": "

The EC2 image

" - } - }, - "DBEngineMediaType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.

" - } - }, - "SupportedCharacterSets": { - "target": "com.amazonaws.rds#SupportedCharacterSetsList", - "traits": { - "smithy.api#documentation": "

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.

" - } - }, - "SupportedNcharCharacterSets": { - "target": "com.amazonaws.rds#SupportedCharacterSetsList", - "traits": { - "smithy.api#documentation": "

A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.

" - } - }, - "ValidUpgradeTarget": { - "target": "com.amazonaws.rds#ValidUpgradeTargetList", - "traits": { - "smithy.api#documentation": "

A list of engine versions that this database engine version can be upgraded to.

" - } - }, - "SupportedTimezones": { - "target": "com.amazonaws.rds#SupportedTimezonesList", - "traits": { - "smithy.api#documentation": "

A list of the time zones supported by this engine for the\n Timezone parameter of the CreateDBInstance action.

" - } - }, - "ExportableLogTypes": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

The types of logs that the database engine has available for export to CloudWatch Logs.

" - } - }, - "SupportsLogExportsToCloudwatchLogs": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

" - } - }, - "SupportsReadReplica": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the database engine version supports read replicas.

" - } - }, - "SupportedEngineModes": { - "target": "com.amazonaws.rds#EngineModeList", - "traits": { - "smithy.api#documentation": "

A list of the supported DB engine modes.

" - } - }, - "SupportedFeatureNames": { - "target": "com.amazonaws.rds#FeatureNameList", - "traits": { - "smithy.api#documentation": "

A list of features supported by the DB engine.

\n

The supported features vary by DB engine and DB engine version.

\n

To determine the supported features for a specific DB engine and DB engine version using the CLI, \n use the following command:

\n

\n aws rds describe-db-engine-versions --engine --engine-version \n

\n

For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, \n use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --engine-version 13.3\n

\n

The supported features are listed under SupportedFeatureNames in the output.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The status of the DB engine version, either available or deprecated.

" - } - }, - "SupportsParallelQuery": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether you can use Aurora parallel query with a specific DB engine version.

" - } - }, - "SupportsGlobalDatabases": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether you can use Aurora global databases with a specific DB engine version.

" - } - }, - "MajorEngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The major engine version of the CEV.

" - } - }, - "DatabaseInstallationFilesS3BucketName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon S3 bucket that contains your database installation files.

" - } - }, - "DatabaseInstallationFilesS3Prefix": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon S3 directory that contains the database installation files. \n If not specified, then no prefix is assumed.

" - } - }, - "DBEngineVersionArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN of the custom engine version.

" - } - }, - "KMSKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for \n RDS Custom, but optional for Amazon RDS.

" - } - }, - "CreateTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The creation time of the DB engine version.

" - } - }, - "TagList": { - "target": "com.amazonaws.rds#TagList" - }, - "SupportsBabelfish": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

" - } - }, - "CustomDBEngineVersionManifest": { - "target": "com.amazonaws.rds#CustomDBEngineVersionManifest", - "traits": { - "smithy.api#documentation": "

JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). \n RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, \n and UNIX/Linux user and group using the installation parameters. For more information, \n see JSON fields in the CEV manifest in the Amazon RDS User Guide.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the action DescribeDBEngineVersions.

" - } - }, - "com.amazonaws.rds#DBEngineVersionList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBEngineVersion", - "traits": { - "smithy.api#xmlName": "DBEngineVersion" - } - } - }, - "com.amazonaws.rds#DBEngineVersionMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "DBEngineVersions": { - "target": "com.amazonaws.rds#DBEngineVersionList", - "traits": { - "smithy.api#documentation": "

A list of DBEngineVersion elements.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBEngineVersions action.

" - } - }, - "com.amazonaws.rds#DBInstance": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

" - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Contains the name of the compute and memory capacity class of the DB instance.

" - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the database engine to be used for this DB instance.

" - } - }, - "DBInstanceStatus": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the current state of this database.

\n

For information about DB instance statuses, see\n Viewing DB instance status \n in the Amazon RDS User Guide.\n

" - } - }, - "AutomaticRestartTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The time when a stopped DB instance is restarted automatically.

" - } - }, - "MasterUsername": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Contains the master username for the DB instance.

" - } - }, - "DBName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The meaning of this parameter differs according to the database engine you use.

\n

\n MySQL, MariaDB, SQL Server, PostgreSQL\n

\n

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

\n

Type: String

\n

\n Oracle\n

\n

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

" - } - }, - "Endpoint": { - "target": "com.amazonaws.rds#Endpoint", - "traits": { - "smithy.api#documentation": "

Specifies the connection endpoint.

\n \n

The endpoint might not be shown for instances whose status is creating.

\n " - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the allocated storage size specified in gibibytes (GiB).

" - } - }, - "InstanceCreateTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

Provides the date and time the DB instance was created.

" - } - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.

" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the number of days for which automatic DB snapshots are retained.

" - } - }, - "DBSecurityGroups": { - "target": "com.amazonaws.rds#DBSecurityGroupMembershipList", - "traits": { - "smithy.api#documentation": "

A list of DB security group elements containing \n DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

" - } - }, - "VpcSecurityGroups": { - "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", - "traits": { - "smithy.api#documentation": "

Provides a list of VPC security group elements that the DB instance belongs to.

" - } - }, - "DBParameterGroups": { - "target": "com.amazonaws.rds#DBParameterGroupStatusList", - "traits": { - "smithy.api#documentation": "

Provides the list of DB parameter groups applied to this DB instance.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the Availability Zone the DB instance is located in.

" - } - }, - "DBSubnetGroup": { - "target": "com.amazonaws.rds#DBSubnetGroup", - "traits": { - "smithy.api#documentation": "

Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

" - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

" - } - }, - "PendingModifiedValues": { - "target": "com.amazonaws.rds#PendingModifiedValues", - "traits": { - "smithy.api#documentation": "

A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

" - } - }, - "LatestRestorableTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

Specifies the latest time to which a database can be restored with point-in-time restore.

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Indicates the database engine version.

" - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates that minor version patches are applied automatically.

" - } - }, - "ReadReplicaSourceDBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Contains the identifier of the source DB instance if this DB instance is a read\n replica.

" - } - }, - "ReadReplicaDBInstanceIdentifiers": { - "target": "com.amazonaws.rds#ReadReplicaDBInstanceIdentifierList", - "traits": { - "smithy.api#documentation": "

Contains one or more identifiers of the read replicas associated with this DB\n instance.

" - } - }, - "ReadReplicaDBClusterIdentifiers": { - "target": "com.amazonaws.rds#ReadReplicaDBClusterIdentifierList", - "traits": { - "smithy.api#documentation": "

Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance\n is replicated as a read replica. For example, when you create an Aurora read replica of\n an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is\n shown. This output doesn't contain information about cross-Region Aurora read\n replicas.

\n \n

Currently, each RDS DB instance can have only one Aurora read replica.

\n " - } - }, - "ReplicaMode": { - "target": "com.amazonaws.rds#ReplicaMode", - "traits": { - "smithy.api#documentation": "

The open mode of an Oracle read replica. The default is open-read-only. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.

\n \n

This attribute is only supported in RDS for Oracle.

\n " - } - }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

License model information for this DB instance. This setting doesn't apply to RDS Custom.

" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the Provisioned IOPS (I/O operations per second) value.

" - } - }, - "OptionGroupMemberships": { - "target": "com.amazonaws.rds#OptionGroupMembershipList", - "traits": { - "smithy.api#documentation": "

Provides the list of option group memberships for this DB instance.

" - } - }, - "CharacterSetName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

If present, specifies the name of the character set that this instance is associated with.

" - } - }, - "NcharCharacterSetName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the NCHAR character set for the Oracle DB instance. This character set specifies the\n Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

" - } - }, - "SecondaryAvailabilityZone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies the accessibility options for the DB instance.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" - } - }, - "StatusInfos": { - "target": "com.amazonaws.rds#DBInstanceStatusInfoList", - "traits": { - "smithy.api#documentation": "

The status of a read replica. If the instance isn't a read replica, this is\n blank.

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the storage type associated with the DB instance.

" - } - }, - "TdeCredentialArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN from the key store with which the instance is associated for TDE encryption.

" - } - }, - "DbInstancePort": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

" - } - }, - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

" - } - }, - "StorageEncrypted": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the DB instance is encrypted.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

If StorageEncrypted is true, the Amazon Web Services KMS key identifier \n for the encrypted DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" - } - }, - "DbiResourceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log \n entries whenever the Amazon Web Services KMS key for the DB instance is accessed.

" - } - }, - "CACertificateIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the CA certificate for this DB instance.

" - } - }, - "DomainMemberships": { - "target": "com.amazonaws.rds#DomainMembershipList", - "traits": { - "smithy.api#documentation": "

The Active Directory Domain membership records associated with the DB instance.

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

\n

\n Amazon Aurora\n

\n

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see DBCluster.

" - } - }, - "MonitoringInterval": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

" - } - }, - "EnhancedMonitoringResourceArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

" - } - }, - "MonitoringRoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

" - } - }, - "PromotionTier": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

" - } - }, - "DBInstanceArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB instance.

" - } - }, - "Timezone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The time zone of the DB instance.\n In most cases, the Timezone element is empty.\n Timezone content appears only for\n Microsoft SQL Server DB instances \n that were created with a time zone specified.

" - } - }, - "IAMDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

\n

IAM database authentication can be enabled for the following database engines

\n " - } - }, - "PerformanceInsightsEnabled": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

True if Performance Insights is enabled for the DB instance, and otherwise false.

" - } - }, - "PerformanceInsightsKMSKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" - } - }, - "PerformanceInsightsRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n " - } - }, - "EnabledCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

A list of log types that this DB instance is configured to export to CloudWatch Logs.

\n

Log types vary by DB engine. For information about the log types for each DB engine, see\n Amazon RDS Database Log Files in the Amazon RDS User Guide.\n

" - } - }, - "ProcessorFeatures": { - "target": "com.amazonaws.rds#ProcessorFeatureList", - "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates if the DB instance has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.\n For more information, see \n \n Deleting a DB Instance.

" - } - }, - "AssociatedRoles": { - "target": "com.amazonaws.rds#DBInstanceRoles", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

" - } - }, - "ListenerEndpoint": { - "target": "com.amazonaws.rds#Endpoint", - "traits": { - "smithy.api#documentation": "

Specifies the listener connection endpoint for SQL Server Always On.

" - } - }, - "MaxAllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

" - } - }, - "TagList": { - "target": "com.amazonaws.rds#TagList" - }, - "DBInstanceAutomatedBackupsReplications": { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackupsReplicationList", - "traits": { - "smithy.api#documentation": "

The list of replicated automated backups associated with the DB instance.

" - } - }, - "CustomerOwnedIpEnabled": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" - } - }, - "AwsBackupRecoveryPointArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

" - } - }, - "ActivityStreamStatus": { - "target": "com.amazonaws.rds#ActivityStreamStatus", - "traits": { - "smithy.api#documentation": "

The status of the database activity stream.

" - } - }, - "ActivityStreamKmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" - } - }, - "ActivityStreamKinesisStreamName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Kinesis data stream used for the database activity stream.

" - } - }, - "ActivityStreamMode": { - "target": "com.amazonaws.rds#ActivityStreamMode", - "traits": { - "smithy.api#documentation": "

The mode of the database activity stream. Database events such as a change or access generate \n an activity stream event. RDS for Oracle always handles these events asynchronously.

" - } - }, - "ActivityStreamEngineNativeAuditFieldsIncluded": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Indicates whether engine-native audit fields are included in the database activity stream.

" - } - }, - "AutomationMode": { - "target": "com.amazonaws.rds#AutomationMode", - "traits": { - "smithy.api#documentation": "

The automation mode of the RDS Custom DB instance: full or all paused. \n If full, the DB instance automates monitoring and instance recovery. If \n all paused, the instance pauses automation for the duration set by \n --resume-full-automation-mode-minutes.

" - } - }, - "ResumeFullAutomationModeTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. \n The minimum value is 60 (default). The maximum value is 1,440.

" - } - }, - "CustomIamInstanceProfile": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n \n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

" - } - }, - "BackupTarget": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

" - } - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide and \n \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

" - } - }, - "ActivityStreamPolicyStatus": { - "target": "com.amazonaws.rds#ActivityStreamPolicyStatus", - "traits": { - "smithy.api#documentation": "

The status of the policy state of the activity stream.

" - } - }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the storage throughput for the DB instance.

\n

This setting applies only to the gp3 storage type.

" - } - }, - "DBSystemId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also\n the name of the CDB. This setting is valid for RDS Custom only.

" - } - }, - "MasterUserSecret": { - "target": "com.amazonaws.rds#MasterUserSecret", - "traits": { - "smithy.api#documentation": "

Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details of an Amazon RDS DB instance.

\n

This data type is used as a response element in the operations CreateDBInstance, \n CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, \n ModifyDBInstance, PromoteReadReplica, RebootDBInstance, \n RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, \n StartDBInstance, and StopDBInstance.

" - } - }, - "com.amazonaws.rds#DBInstanceAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBInstanceAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The user already has a DB instance with the given identifier.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBInstanceAutomatedBackup": { - "type": "structure", - "members": { - "DBInstanceArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the automated backups.

" - } - }, - "DbiResourceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

" - } - }, - "Region": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region associated with the automated backup.

" - } - }, - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The customer id of the instance that is/was associated with the automated backup.

" - } - }, - "RestoreWindow": { - "target": "com.amazonaws.rds#RestoreWindow", - "traits": { - "smithy.api#documentation": "

Earliest and latest time an instance can be restored to.

" - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the allocated storage size in gibibytes (GiB).

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides a list of status information for an automated backup:

\n " - } - }, - "Port": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The port number that the automated backup used for connections.

\n

Default: Inherits from the source DB instance

\n

Valid Values: 1150-65535\n

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Availability Zone that the automated backup was created in. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.

" - } - }, - "VpcId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the VPC ID associated with the DB instance.

" - } - }, - "InstanceCreateTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

Provides the date and time that the DB instance was created.

" - } - }, - "MasterUsername": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The license model of an automated backup.

" - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the database engine for this automated backup.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version of the database engine for the automated backup.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

License model information for the automated backup.

" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The IOPS (I/O operations per second) value for the automated backup.

" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.

" - } - }, - "TdeCredentialArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN from the key store with which the automated backup is associated for TDE encryption.

" - } - }, - "Encrypted": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the automated backup is encrypted.

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the storage type associated with the automated backup.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key ID for an automated backup.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" - } - }, - "Timezone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The time zone of the automated backup. In most cases, the Timezone element is empty.\n Timezone content appears only for Microsoft SQL Server DB instances \n that were created with a time zone specified.

" - } - }, - "IAMDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, \n and otherwise false.

" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The retention period for the automated backups.

" - } - }, - "DBInstanceAutomatedBackupsArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the replicated automated backups.

" - } - }, - "DBInstanceAutomatedBackupsReplications": { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackupsReplicationList", - "traits": { - "smithy.api#documentation": "

The list of replications to different Amazon Web Services Regions associated with the automated backup.

" - } - }, - "BackupTarget": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

" - } - }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the storage throughput for the automated backup.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that\n existed at the time you deleted the source instance.

" - } - }, - "com.amazonaws.rds#DBInstanceAutomatedBackupList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackup", - "traits": { - "smithy.api#xmlName": "DBInstanceAutomatedBackup" - } - } - }, - "com.amazonaws.rds#DBInstanceAutomatedBackupMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "DBInstanceAutomatedBackups": { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackupList", - "traits": { - "smithy.api#documentation": "

A list of DBInstanceAutomatedBackup instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.

" - } - }, - "com.amazonaws.rds#DBInstanceAutomatedBackupNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBInstanceAutomatedBackupNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

No automated backup for this DB instance was found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBInstanceAutomatedBackupQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBInstanceAutomatedBackupQuotaExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The quota for retained automated backups was exceeded. This prevents you\n from retaining any additional automated backups. The retained automated backups \n quota is the same as your DB Instance quota.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBInstanceAutomatedBackupsReplication": { - "type": "structure", - "members": { - "DBInstanceAutomatedBackupsArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicated automated backups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.

" - } - }, - "com.amazonaws.rds#DBInstanceAutomatedBackupsReplicationList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackupsReplication", - "traits": { - "smithy.api#xmlName": "DBInstanceAutomatedBackupsReplication" - } - } - }, - "com.amazonaws.rds#DBInstanceList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBInstance", - "traits": { - "smithy.api#xmlName": "DBInstance" - } - } - }, - "com.amazonaws.rds#DBInstanceMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .

" - } - }, - "DBInstances": { - "target": "com.amazonaws.rds#DBInstanceList", - "traits": { - "smithy.api#documentation": "

A list of DBInstance instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBInstances action.

" - } - }, - "com.amazonaws.rds#DBInstanceNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBInstanceNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n DBInstanceIdentifier doesn't refer to an existing DB instance.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBInstanceRole": { - "type": "structure", - "members": { - "RoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB\n instance.

" - } - }, - "FeatureName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role.\n For information about supported feature names, see DBEngineVersion.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following\n values:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.

" - } - }, - "com.amazonaws.rds#DBInstanceRoleAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBInstanceRoleAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The specified RoleArn or FeatureName value is already associated with the DB instance.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBInstanceRoleNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBInstanceRoleNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The specified RoleArn value doesn't match the specified feature for\n the DB instance.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBInstanceRoleQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBInstanceRoleQuotaExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

You can't associate any more Amazon Web Services Identity and Access Management (IAM) roles with the DB instance because the quota has been reached.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBInstanceRoles": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBInstanceRole", - "traits": { - "smithy.api#xmlName": "DBInstanceRole" - } - } - }, - "com.amazonaws.rds#DBInstanceStatusInfo": { - "type": "structure", - "members": { - "StatusType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

This value is currently \"read replication.\"

" - } - }, - "Normal": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Status of the DB instance. For a StatusType of read replica, the values can be\n replicating, replication stop point set, replication stop point reached, error, stopped,\n or terminated.

" - } - }, - "Message": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides a list of status information for a DB instance.

" - } - }, - "com.amazonaws.rds#DBInstanceStatusInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBInstanceStatusInfo", - "traits": { - "smithy.api#xmlName": "DBInstanceStatusInfo" - } - } - }, - "com.amazonaws.rds#DBLogFileNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBLogFileNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n LogFileName doesn't refer to an existing DB log file.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBParameterGroup": { - "type": "structure", - "members": { - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group.

" - } - }, - "DBParameterGroupFamily": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group family that this DB parameter group is compatible with.

" - } - }, - "Description": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the customer-specified description for this DB parameter group.

" - } - }, - "DBParameterGroupArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB parameter group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details of an Amazon RDS DB parameter group.

\n

This data type is used as a response element in the DescribeDBParameterGroups action.

" - } - }, - "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBParameterGroupAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

A DB parameter group with the same name exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBParameterGroupDetails": { - "type": "structure", - "members": { - "Parameters": { - "target": "com.amazonaws.rds#ParametersList", - "traits": { - "smithy.api#documentation": "

A list of Parameter values.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBParameters action.

" - } - }, - "com.amazonaws.rds#DBParameterGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBParameterGroup", - "traits": { - "smithy.api#xmlName": "DBParameterGroup" - } - } - }, - "com.amazonaws.rds#DBParameterGroupNameMessage": { - "type": "structure", - "members": { - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the \n ModifyDBParameterGroup or ResetDBParameterGroup action.

" - } - }, - "com.amazonaws.rds#DBParameterGroupNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBParameterGroupNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n DBParameterGroupName doesn't refer to an\n existing DB parameter group.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBParameterGroupQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBParameterGroupQuotaExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB parameter\n groups.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBParameterGroupStatus": { - "type": "structure", - "members": { - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group.

" - } - }, - "ParameterApplyStatus": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The status of parameter updates.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The status of the DB parameter group.

\n

This data type is used as a response element in the following actions:

\n " - } - }, - "com.amazonaws.rds#DBParameterGroupStatusList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBParameterGroupStatus", - "traits": { - "smithy.api#xmlName": "DBParameterGroup" - } - } - }, - "com.amazonaws.rds#DBParameterGroupsMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "DBParameterGroups": { - "target": "com.amazonaws.rds#DBParameterGroupList", - "traits": { - "smithy.api#documentation": "

A list of DBParameterGroup instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBParameterGroups action.

" - } - }, - "com.amazonaws.rds#DBProxy": { - "type": "structure", - "members": { - "DBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

" - } - }, - "DBProxyArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the proxy.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#DBProxyStatus", - "traits": { - "smithy.api#documentation": "

The current status of this proxy. A status of available means the\n proxy is ready to handle requests. Other values indicate that you must wait for\n the proxy to be ready, or take some action to resolve an issue.

" - } - }, - "EngineFamily": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The kinds of databases that the proxy can connect to. This value determines which database network protocol \n the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, \n RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. \n SQLSERVER supports RDS for Microsoft SQL Server databases.

" - } - }, - "VpcId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the VPC ID of the DB proxy.

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

Provides a list of VPC security groups that the proxy belongs to.

" - } - }, - "VpcSubnetIds": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The EC2 subnet IDs for the proxy.

" - } - }, - "Auth": { - "target": "com.amazonaws.rds#UserAuthConfigInfoList", - "traits": { - "smithy.api#documentation": "

One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance\n or Aurora DB cluster.

" - } - }, - "RoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

" - } - }, - "Endpoint": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the\n connection string for a database client application.

" - } - }, - "RequireTLS": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

" - } - }, - "IdleClientTimeout": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.\n The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by\n later connection requests.

\n

Default: 1800 (30 minutes)

\n

Constraints: 1 to 28,800

" - } - }, - "DebugLogging": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

" - } - }, - "CreatedDate": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The date and time when the proxy was first created.

" - } - }, - "UpdatedDate": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The date and time when the proxy was last updated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The data structure representing a proxy managed by the RDS Proxy.

\n

This data type is used as a response element in the DescribeDBProxies action.

" - } - }, - "com.amazonaws.rds#DBProxyAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBProxyAlreadyExistsFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBProxyEndpoint": { - "type": "structure", - "members": { - "DBProxyEndpointName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name for the DB proxy endpoint. An identifier must begin with a letter and\n must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen\n or contain two consecutive hyphens.

" - } - }, - "DBProxyEndpointArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB proxy endpoint.

" - } - }, - "DBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the DB proxy that is associated with this DB proxy endpoint.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#DBProxyEndpointStatus", - "traits": { - "smithy.api#documentation": "

The current status of this DB proxy endpoint. A status of available means the\n endpoint is ready to handle requests. Other values indicate that you must wait for\n the endpoint to be ready, or take some action to resolve an issue.

" - } - }, - "VpcId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the VPC ID of the DB proxy endpoint.

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

Provides a list of VPC security groups that the DB proxy endpoint belongs to.

" - } - }, - "VpcSubnetIds": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The EC2 subnet IDs for the DB proxy endpoint.

" - } - }, - "Endpoint": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the\n connection string for a database client application.

" - } - }, - "CreatedDate": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The date and time when the DB proxy endpoint was first created.

" - } - }, - "TargetRole": { - "target": "com.amazonaws.rds#DBProxyEndpointTargetRole", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

" - } - }, - "IsDefault": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether this endpoint is the default endpoint for the associated DB proxy.\n Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the\n DB proxy can be either read/write or read-only.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one\n endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same\n DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the\n associated DB proxy.

\n

This data type is used as a response element in the DescribeDBProxyEndpoints operation.

" - } - }, - "com.amazonaws.rds#DBProxyEndpointAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBProxyEndpointAlreadyExistsFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBProxyEndpointList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBProxyEndpoint" - } - }, - "com.amazonaws.rds#DBProxyEndpointName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" - } - }, - "com.amazonaws.rds#DBProxyEndpointNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBProxyEndpointNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The DB proxy endpoint doesn't exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBProxyEndpointQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBProxyEndpointQuotaExceededFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The DB proxy already has the maximum number of endpoints.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBProxyEndpointStatus": { - "type": "enum", - "members": { - "AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "MODIFYING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "modifying" - } - }, - "INCOMPATIBLE_NETWORK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "incompatible-network" - } - }, - "INSUFFICIENT_RESOURCE_LIMITS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "insufficient-resource-limits" - } - }, - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "creating" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleting" - } - } - } - }, - "com.amazonaws.rds#DBProxyEndpointTargetRole": { - "type": "enum", - "members": { - "READ_WRITE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READ_WRITE" - } - }, - "READ_ONLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READ_ONLY" - } - } - } - }, - "com.amazonaws.rds#DBProxyList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBProxy" - } - }, - "com.amazonaws.rds#DBProxyName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" - } - }, - "com.amazonaws.rds#DBProxyNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBProxyNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBProxyQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBProxyQuotaExceededFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

Your Amazon Web Services account already has the maximum number of proxies in the specified Amazon Web Services Region.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBProxyStatus": { - "type": "enum", - "members": { - "AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "available" - } - }, - "MODIFYING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "modifying" - } - }, - "INCOMPATIBLE_NETWORK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "incompatible-network" - } - }, - "INSUFFICIENT_RESOURCE_LIMITS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "insufficient-resource-limits" - } - }, - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "creating" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deleting" - } - }, - "SUSPENDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "suspended" - } - }, - "SUSPENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "suspending" - } - }, - "REACTIVATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "reactivating" - } - } - } - }, - "com.amazonaws.rds#DBProxyTarget": { - "type": "structure", - "members": { - "TargetArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.

" - } - }, - "Endpoint": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The writer endpoint for the RDS DB instance or Aurora DB cluster.

" - } - }, - "TrackedClusterId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.

" - } - }, - "RdsResourceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier representing the target. It can be the instance identifier for an RDS DB instance,\n or the cluster identifier for an Aurora DB cluster.

" - } - }, - "Port": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.

" - } - }, - "Type": { - "target": "com.amazonaws.rds#TargetType", - "traits": { - "smithy.api#documentation": "

Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.

" - } - }, - "Role": { - "target": "com.amazonaws.rds#TargetRole", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the target of the proxy can be used for read/write or read-only operations.

" - } - }, - "TargetHealth": { - "target": "com.amazonaws.rds#TargetHealth", - "traits": { - "smithy.api#documentation": "

Information about the connection health of the RDS Proxy target.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster\n that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.

\n

This data type is used as a response element in the DescribeDBProxyTargets action.

" - } - }, - "com.amazonaws.rds#DBProxyTargetAlreadyRegisteredFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBProxyTargetAlreadyRegisteredFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The proxy is already associated with the specified RDS DB instance or Aurora DB cluster.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBProxyTargetGroup": { - "type": "structure", - "members": { - "DBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the RDS proxy associated with this target group.

" - } - }, - "TargetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the target group. This name must be unique for all target groups owned by your Amazon Web Services account in the specified Amazon Web Services Region.

" - } - }, - "TargetGroupArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) representing the target group.

" - } - }, - "IsDefault": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether this target group is the first one used for connection requests by the associated proxy.\n Because each proxy is currently associated with a single target group, currently this setting\n is always true.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The current status of this target group. A status of available means the\n target group is correctly associated with a database. Other values indicate that you must wait for\n the target group to be ready, or take some action to resolve an issue.

" - } - }, - "ConnectionPoolConfig": { - "target": "com.amazonaws.rds#ConnectionPoolConfigurationInfo", - "traits": { - "smithy.api#documentation": "

The settings that determine the size and behavior of the connection pool for the target group.

" - } - }, - "CreatedDate": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The date and time when the target group was first created.

" - } - }, - "UpdatedDate": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The date and time when the target group was last updated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group\n is associated with exactly one RDS DB instance or Aurora DB cluster.

\n

This data type is used as a response element in the DescribeDBProxyTargetGroups action.

" - } - }, - "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBProxyTargetGroupNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBProxyTargetNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBProxyTargetNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBSecurityGroup": { - "type": "structure", - "members": { - "OwnerId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the Amazon Web Services ID of the owner of a specific DB security group.

" - } - }, - "DBSecurityGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the DB security group.

" - } - }, - "DBSecurityGroupDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the description of the DB security group.

" - } - }, - "VpcId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the VpcId of the DB security group.

" - } - }, - "EC2SecurityGroups": { - "target": "com.amazonaws.rds#EC2SecurityGroupList", - "traits": { - "smithy.api#documentation": "

Contains a list of EC2SecurityGroup elements.

" - } - }, - "IPRanges": { - "target": "com.amazonaws.rds#IPRangeList", - "traits": { - "smithy.api#documentation": "

Contains a list of IPRange elements.

" - } - }, - "DBSecurityGroupArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB security group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details for an Amazon RDS DB security group.

\n

This data type is used as a response element \n in the DescribeDBSecurityGroups action.

" - } - }, - "com.amazonaws.rds#DBSecurityGroupAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBSecurityGroupAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

A DB security group with the name specified in\n DBSecurityGroupName already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBSecurityGroupMembership": { - "type": "structure", - "members": { - "DBSecurityGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB security group.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The status of the DB security group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the following actions:

\n " - } - }, - "com.amazonaws.rds#DBSecurityGroupMembershipList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBSecurityGroupMembership", - "traits": { - "smithy.api#xmlName": "DBSecurityGroup" - } - } - }, - "com.amazonaws.rds#DBSecurityGroupMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "DBSecurityGroups": { - "target": "com.amazonaws.rds#DBSecurityGroups", - "traits": { - "smithy.api#documentation": "

A list of DBSecurityGroup instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

" - } - }, - "com.amazonaws.rds#DBSecurityGroupNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#xmlName": "DBSecurityGroupName" - } - } - }, - "com.amazonaws.rds#DBSecurityGroupNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBSecurityGroupNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n DBSecurityGroupName doesn't refer to an existing DB security group.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBSecurityGroupNotSupportedFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBSecurityGroupNotSupported", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

A DB security group isn't allowed for this action.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBSecurityGroupQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "QuotaExceeded.DBSecurityGroup", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB security\n groups.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBSecurityGroups": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBSecurityGroup", - "traits": { - "smithy.api#xmlName": "DBSecurityGroup" - } - } - }, - "com.amazonaws.rds#DBSnapshot": { - "type": "structure", - "members": { - "DBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the identifier for the DB snapshot.

" - } - }, - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

" - } - }, - "SnapshotCreateTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.

" - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the database engine.

" - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the allocated storage size in gibibytes (GiB).

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the status of this DB snapshot.

" - } - }, - "Port": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the port that the database engine was listening on at the time of the snapshot.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

" - } - }, - "VpcId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the VPC ID associated with the DB snapshot.

" - } - }, - "InstanceCreateTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from\n which the snapshot was taken, was created.

" - } - }, - "MasterUsername": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the master username for the DB snapshot.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the version of the database engine.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

License model information for the restored DB instance.

" - } - }, - "SnapshotType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the type of the DB snapshot.

" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the option group name for the DB snapshot.

" - } - }, - "PercentProgress": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The percentage of the estimated data that has been transferred.

" - } - }, - "SourceRegion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region that the DB snapshot was created in or copied from.

" - } - }, - "SourceDBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the storage type associated with DB snapshot.

" - } - }, - "TdeCredentialArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

" - } - }, - "Encrypted": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the DB snapshot is encrypted.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

If Encrypted is true, the Amazon Web Services KMS key identifier \n for the encrypted DB snapshot.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" - } - }, - "DBSnapshotArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB snapshot.

" - } - }, - "Timezone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The time zone of the DB snapshot.\n In most cases, the Timezone element is empty.\n Timezone content appears only for\n snapshots taken from \n Microsoft SQL Server DB instances \n that were created with a time zone specified.

" - } - }, - "IAMDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

" - } - }, - "ProcessorFeatures": { - "target": "com.amazonaws.rds#ProcessorFeatureList", - "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class\n of the DB instance when the DB snapshot was created.

" - } - }, - "DbiResourceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

" - } - }, - "TagList": { - "target": "com.amazonaws.rds#TagList" - }, - "OriginalSnapshotCreateTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.

" - } - }, - "SnapshotDatabaseTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The timestamp of the most recent transaction applied to the database that you're backing up. \n Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. \n In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

\n

If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime \n with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than \n SnapshotDatabaseTime, then the replica lag is two hours.

" - } - }, - "SnapshotTarget": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

" - } - }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the storage throughput for the DB snapshot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details of an Amazon RDS DB snapshot.

\n

This data type is used as a response element \n in the DescribeDBSnapshots action.

" - } - }, - "com.amazonaws.rds#DBSnapshotAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBSnapshotAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

\n DBSnapshotIdentifier is already used by an existing snapshot.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBSnapshotAttribute": { - "type": "structure", - "members": { - "AttributeName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the manual DB snapshot attribute.

\n

The attribute named restore refers to the list of Amazon Web Services accounts that\n have permission to copy or restore the manual DB cluster snapshot. For more information, \n see the ModifyDBSnapshotAttribute\n API action.

" - } - }, - "AttributeValues": { - "target": "com.amazonaws.rds#AttributeValueList", - "traits": { - "smithy.api#documentation": "

The value or values for the manual DB snapshot attribute.

\n

If the AttributeName field is set to restore, then this element\n returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual\n DB snapshot. If a value of all is in the list, then the manual DB snapshot\n is public and available for any Amazon Web Services account to copy or restore.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the name and values of a manual DB snapshot attribute

\n

Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts\n to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute\n API.

" - } - }, - "com.amazonaws.rds#DBSnapshotAttributeList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBSnapshotAttribute", - "traits": { - "smithy.api#xmlName": "DBSnapshotAttribute" - } - } - }, - "com.amazonaws.rds#DBSnapshotAttributesResult": { - "type": "structure", - "members": { - "DBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the manual DB snapshot that the attributes apply to.

" - } - }, - "DBSnapshotAttributes": { - "target": "com.amazonaws.rds#DBSnapshotAttributeList", - "traits": { - "smithy.api#documentation": "

The list of attributes and values for the manual DB snapshot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the results of a successful call to the DescribeDBSnapshotAttributes\n API action.

\n

Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts\n to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute\n API action.

" - } - }, - "com.amazonaws.rds#DBSnapshotList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBSnapshot", - "traits": { - "smithy.api#xmlName": "DBSnapshot" - } - } - }, - "com.amazonaws.rds#DBSnapshotMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "DBSnapshots": { - "target": "com.amazonaws.rds#DBSnapshotList", - "traits": { - "smithy.api#documentation": "

A list of DBSnapshot instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBSnapshots action.

" - } - }, - "com.amazonaws.rds#DBSnapshotNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBSnapshotNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBSubnetGroup": { - "type": "structure", - "members": { - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB subnet group.

" - } - }, - "DBSubnetGroupDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the description of the DB subnet group.

" - } - }, - "VpcId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the VpcId of the DB subnet group.

" - } - }, - "SubnetGroupStatus": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the status of the DB subnet group.

" - } - }, - "Subnets": { - "target": "com.amazonaws.rds#SubnetList", - "traits": { - "smithy.api#documentation": "

Contains a list of Subnet elements.

" - } - }, - "DBSubnetGroupArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB subnet group.

" - } - }, - "SupportedNetworkTypes": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The network type of the DB subnet group.

\n

Valid values:

\n \n

A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details of an Amazon RDS DB subnet group.

\n

This data type is used as a response element \n in the DescribeDBSubnetGroups action.

" - } - }, - "com.amazonaws.rds#DBSubnetGroupAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBSubnetGroupAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

\n DBSubnetGroupName is already used by an existing DB subnet group.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBSubnetGroupDoesNotCoverEnoughAZs", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBSubnetGroupMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "DBSubnetGroups": { - "target": "com.amazonaws.rds#DBSubnetGroups", - "traits": { - "smithy.api#documentation": "

A list of DBSubnetGroup instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

" - } - }, - "com.amazonaws.rds#DBSubnetGroupNotAllowedFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBSubnetGroupNotAllowedFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The DBSubnetGroup shouldn't be specified while creating read replicas that lie\n in the same region as the source instance.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBSubnetGroupNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBSubnetGroupNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n DBSubnetGroupName doesn't refer to an existing DB subnet group.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#DBSubnetGroupQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBSubnetGroupQuotaExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB subnet\n groups.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBSubnetGroups": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBSubnetGroup", - "traits": { - "smithy.api#xmlName": "DBSubnetGroup" - } - } - }, - "com.amazonaws.rds#DBSubnetQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBSubnetQuotaExceededFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of subnets in a\n DB subnet groups.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DBUpgradeDependencyFailureFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DBUpgradeDependencyFailure", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The DB upgrade failed because a resource the DB depends on can't be\n modified.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#DatabaseArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^arn:[A-Za-z][0-9A-Za-z-:._]*$" - } - }, - "com.amazonaws.rds#DeleteBlueGreenDeployment": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteBlueGreenDeploymentRequest" - }, - "output": { - "target": "com.amazonaws.rds#DeleteBlueGreenDeploymentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidBlueGreenDeploymentStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a blue/green deployment.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

" - } - }, - "com.amazonaws.rds#DeleteBlueGreenDeploymentRequest": { - "type": "structure", - "members": { - "BlueGreenDeploymentIdentifier": { - "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", - "traits": { - "smithy.api#documentation": "

The blue/green deployment identifier of the deployment to be deleted. This parameter isn't case-sensitive.

\n

Constraints:\n

\n ", - "smithy.api#required": {} - } - }, - "DeleteTarget": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to delete the resources in the green environment.

" - } - } - } - }, - "com.amazonaws.rds#DeleteBlueGreenDeploymentResponse": { - "type": "structure", - "members": { - "BlueGreenDeployment": { - "target": "com.amazonaws.rds#BlueGreenDeployment" - } - } - }, - "com.amazonaws.rds#DeleteCustomDBEngineVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteCustomDBEngineVersionMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBEngineVersion" - }, - "errors": [ - { - "target": "com.amazonaws.rds#CustomDBEngineVersionNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidCustomDBEngineVersionStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:

\n \n

Typically, deletion takes a few minutes.

\n \n

The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the DeleteCustomDbEngineVersion event.

\n \n

For more information, see \n Deleting a CEV in the Amazon RDS User Guide.

" - } - }, - "com.amazonaws.rds#DeleteCustomDBEngineVersionMessage": { - "type": "structure", - "members": { - "Engine": { - "target": "com.amazonaws.rds#CustomEngineName", - "traits": { - "smithy.api#documentation": "

The database engine. The only supported engine is custom-oracle-ee.

", - "smithy.api#required": {} - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#CustomEngineVersion", - "traits": { - "smithy.api#documentation": "

The custom engine version (CEV) for your DB instance. This option is required for \n RDS Custom, but optional for Amazon RDS. The combination of Engine and \n EngineVersion is unique per customer per Amazon Web Services Region.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.rds#DeleteDBCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteDBClusterMessage" - }, - "output": { - "target": "com.amazonaws.rds#DeleteDBClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterSnapshotAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

The DeleteDBCluster action deletes a previously provisioned DB cluster. \n When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. \n Manual DB cluster snapshots of the specified DB cluster are not deleted.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" - } - }, - "com.amazonaws.rds#DeleteDBClusterEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteDBClusterEndpointMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBClusterEndpoint" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterEndpointNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterEndpointStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.

\n \n

This action only applies to Aurora DB clusters.

\n " - } - }, - "com.amazonaws.rds#DeleteDBClusterEndpointMessage": { - "type": "structure", - "members": { - "DBClusterEndpointIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.rds#DeleteDBClusterMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "SkipFinalSnapshot": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted.\n If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot \n is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. \n By default, this parameter is disabled.

\n \n

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.

\n " - } - }, - "FinalDBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot\n is disabled.

\n \n

Specifying this parameter and also skipping the creation of a final DB cluster snapshot \n with the SkipFinalShapshot parameter results in an error.

\n \n

Constraints:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DeleteDBClusterParameterGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteDBClusterParameterGroupMessage" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" - } - }, - "com.amazonaws.rds#DeleteDBClusterParameterGroupMessage": { - "type": "structure", - "members": { - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DeleteDBClusterResult": { - "type": "structure", - "members": { - "DBCluster": { - "target": "com.amazonaws.rds#DBCluster" - } - } - }, - "com.amazonaws.rds#DeleteDBClusterSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteDBClusterSnapshotMessage" - }, - "output": { - "target": "com.amazonaws.rds#DeleteDBClusterSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

\n \n

The DB cluster snapshot must be in the available state to be\n deleted.

\n \n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" - } - }, - "com.amazonaws.rds#DeleteDBClusterSnapshotMessage": { - "type": "structure", - "members": { - "DBClusterSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DB cluster snapshot to delete.

\n

Constraints: Must be the name of an existing DB cluster snapshot in the available state.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DeleteDBClusterSnapshotResult": { - "type": "structure", - "members": { - "DBClusterSnapshot": { - "target": "com.amazonaws.rds#DBClusterSnapshot" - } - } - }, - "com.amazonaws.rds#DeleteDBInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteDBInstanceMessage" - }, - "output": { - "target": "com.amazonaws.rds#DeleteDBInstanceResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackupQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSnapshotAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

The DeleteDBInstance action deletes a previously provisioned DB instance. \n When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. \n Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

\n

If you request a final DB snapshot \n the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance\n is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.

\n

When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.

\n

If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following\n conditions are true:

\n \n

To delete a DB instance in this case, first call the\n PromoteReadReplicaDBCluster API action to promote the DB cluster so\n it's no longer a read replica. After the promotion completes, then call the\n DeleteDBInstance API action to delete the final instance in the DB\n cluster.

" - } - }, - "com.amazonaws.rds#DeleteDBInstanceAutomatedBackup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteDBInstanceAutomatedBackupMessage" - }, - "output": { - "target": "com.amazonaws.rds#DeleteDBInstanceAutomatedBackupResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceAutomatedBackupStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.

" - } - }, - "com.amazonaws.rds#DeleteDBInstanceAutomatedBackupMessage": { - "type": "structure", - "members": { - "DbiResourceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

" - } - }, - "DBInstanceAutomatedBackupsArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the automated backups to delete, for example,\n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

\n

This setting doesn't apply to RDS Custom.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Parameter input for the DeleteDBInstanceAutomatedBackup operation.

" - } - }, - "com.amazonaws.rds#DeleteDBInstanceAutomatedBackupResult": { - "type": "structure", - "members": { - "DBInstanceAutomatedBackup": { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackup" - } - } - }, - "com.amazonaws.rds#DeleteDBInstanceMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "SkipFinalSnapshot": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance.\n If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, \n RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, \n and the DB snapshot is created.

\n \n

If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.

\n \n

When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, RDS can delete the instance only if you enable this parameter.

\n

If you delete a read replica or an RDS Custom instance, you must enable this setting.

\n

This setting is required for RDS Custom.

" - } - }, - "FinalDBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot\n parameter is disabled.

\n \n

If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.

\n \n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n " - } - }, - "DeleteAutomatedBackups": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to remove automated backups immediately after the DB\n instance is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB instance is deleted.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DeleteDBInstanceResult": { - "type": "structure", - "members": { - "DBInstance": { - "target": "com.amazonaws.rds#DBInstance" - } - } - }, - "com.amazonaws.rds#DeleteDBParameterGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteDBParameterGroupMessage" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.

" - } - }, - "com.amazonaws.rds#DeleteDBParameterGroupMessage": { - "type": "structure", - "members": { - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DeleteDBProxy": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteDBProxyRequest" - }, - "output": { - "target": "com.amazonaws.rds#DeleteDBProxyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBProxyNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBProxyStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an existing DB proxy.

" - } - }, - "com.amazonaws.rds#DeleteDBProxyEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteDBProxyEndpointRequest" - }, - "output": { - "target": "com.amazonaws.rds#DeleteDBProxyEndpointResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBProxyEndpointNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBProxyEndpointStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a DBProxyEndpoint. Doing so removes the ability to access the DB proxy using the\n endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write\n or read-only operations, or using a different VPC than the DB proxy's default VPC.

" - } - }, - "com.amazonaws.rds#DeleteDBProxyEndpointRequest": { - "type": "structure", - "members": { - "DBProxyEndpointName": { - "target": "com.amazonaws.rds#DBProxyEndpointName", - "traits": { - "smithy.api#documentation": "

The name of the DB proxy endpoint to delete.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.rds#DeleteDBProxyEndpointResponse": { - "type": "structure", - "members": { - "DBProxyEndpoint": { - "target": "com.amazonaws.rds#DBProxyEndpoint", - "traits": { - "smithy.api#documentation": "

The data structure representing the details of the DB proxy endpoint that you delete.

" - } - } - } - }, - "com.amazonaws.rds#DeleteDBProxyRequest": { - "type": "structure", - "members": { - "DBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB proxy to delete.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.rds#DeleteDBProxyResponse": { - "type": "structure", - "members": { - "DBProxy": { - "target": "com.amazonaws.rds#DBProxy", - "traits": { - "smithy.api#documentation": "

The data structure representing the details of the DB proxy that you delete.

" - } - } - } - }, - "com.amazonaws.rds#DeleteDBSecurityGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteDBSecurityGroupMessage" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a DB security group.

\n

The specified DB security group must not be associated with any DB instances.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring ā€“ \n Hereā€™s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n " - } - }, - "com.amazonaws.rds#DeleteDBSecurityGroupMessage": { - "type": "structure", - "members": { - "DBSecurityGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB security group to delete.

\n \n

You can't delete the default DB security group.

\n \n

Constraints:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DeleteDBSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteDBSnapshotMessage" - }, - "output": { - "target": "com.amazonaws.rds#DeleteDBSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a DB snapshot. If the snapshot is being copied, the copy operation is\n terminated.

\n \n

The DB snapshot must be in the available state to be deleted.

\n " - } - }, - "com.amazonaws.rds#DeleteDBSnapshotMessage": { - "type": "structure", - "members": { - "DBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB snapshot identifier.

\n

Constraints: Must be the name of an existing DB snapshot in the available state.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DeleteDBSnapshotResult": { - "type": "structure", - "members": { - "DBSnapshot": { - "target": "com.amazonaws.rds#DBSnapshot" - } - } - }, - "com.amazonaws.rds#DeleteDBSubnetGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteDBSubnetGroupMessage" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBSubnetGroupStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBSubnetStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a DB subnet group.

\n \n

The specified database subnet group must not be associated with any DB instances.

\n " - } - }, - "com.amazonaws.rds#DeleteDBSubnetGroupMessage": { - "type": "structure", - "members": { - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the database subnet group to delete.

\n \n

You can't delete the default subnet group.

\n \n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mydbsubnetgroup\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DeleteEventSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteEventSubscriptionMessage" - }, - "output": { - "target": "com.amazonaws.rds#DeleteEventSubscriptionResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#InvalidEventSubscriptionStateFault" - }, - { - "target": "com.amazonaws.rds#SubscriptionNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an RDS event notification subscription.

" - } - }, - "com.amazonaws.rds#DeleteEventSubscriptionMessage": { - "type": "structure", - "members": { - "SubscriptionName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the RDS event notification subscription you want to delete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DeleteEventSubscriptionResult": { - "type": "structure", - "members": { - "EventSubscription": { - "target": "com.amazonaws.rds#EventSubscription" - } - } - }, - "com.amazonaws.rds#DeleteGlobalCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteGlobalClusterMessage" - }, - "output": { - "target": "com.amazonaws.rds#DeleteGlobalClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a global database cluster. The primary and secondary clusters must already be detached or\n destroyed first.

\n \n

This action only applies to Aurora DB clusters.

\n " - } - }, - "com.amazonaws.rds#DeleteGlobalClusterMessage": { - "type": "structure", - "members": { - "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The cluster identifier of the global database cluster being deleted.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.rds#DeleteGlobalClusterResult": { - "type": "structure", - "members": { - "GlobalCluster": { - "target": "com.amazonaws.rds#GlobalCluster" - } - } - }, - "com.amazonaws.rds#DeleteOptionGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteOptionGroupMessage" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.rds#InvalidOptionGroupStateFault" - }, - { - "target": "com.amazonaws.rds#OptionGroupNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an existing option group.

" - } - }, - "com.amazonaws.rds#DeleteOptionGroupMessage": { - "type": "structure", - "members": { - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the option group to be deleted.

\n \n

You can't delete default option groups.

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DeregisterDBProxyTargets": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeregisterDBProxyTargetsRequest" - }, - "output": { - "target": "com.amazonaws.rds#DeregisterDBProxyTargetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBProxyNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyTargetNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBProxyStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.

" - } - }, - "com.amazonaws.rds#DeregisterDBProxyTargetsRequest": { - "type": "structure", - "members": { - "DBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DBProxy that is associated with the DBProxyTargetGroup.

", - "smithy.api#required": {} - } - }, - "TargetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DBProxyTargetGroup.

" - } - }, - "DBInstanceIdentifiers": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

One or more DB instance identifiers.

" - } - }, - "DBClusterIdentifiers": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

One or more DB cluster identifiers.

" - } - } - } - }, - "com.amazonaws.rds#DeregisterDBProxyTargetsResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.rds#DescribeAccountAttributes": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeAccountAttributesMessage" - }, - "output": { - "target": "com.amazonaws.rds#AccountAttributesMessage" - }, - "traits": { - "smithy.api#documentation": "

Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

\n

This command doesn't take any parameters.

" - } - }, - "com.amazonaws.rds#DescribeAccountAttributesMessage": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeBlueGreenDeployments": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeBlueGreenDeploymentsRequest" - }, - "output": { - "target": "com.amazonaws.rds#DescribeBlueGreenDeploymentsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about blue/green deployments.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "BlueGreenDeployments", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeBlueGreenDeploymentsRequest": { - "type": "structure", - "members": { - "BlueGreenDeploymentIdentifier": { - "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", - "traits": { - "smithy.api#documentation": "

The blue/green deployment identifier. If this parameter is specified, information from only the \n specific blue/green deployment is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n " - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

A filter that specifies one or more blue/green deployments to describe.

\n

Supported filters:

\n " - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeBlueGreenDeployments request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - } - } - }, - "com.amazonaws.rds#DescribeBlueGreenDeploymentsResponse": { - "type": "structure", - "members": { - "BlueGreenDeployments": { - "target": "com.amazonaws.rds#BlueGreenDeploymentList", - "traits": { - "smithy.api#documentation": "

Contains a list of blue/green deployments for the user.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a later DescribeBlueGreenDeployments request.

" - } - } - } - }, - "com.amazonaws.rds#DescribeCertificates": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeCertificatesMessage" - }, - "output": { - "target": "com.amazonaws.rds#CertificateMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#CertificateNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "Certificates", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeCertificatesMessage": { - "type": "structure", - "members": { - "CertificateIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n " - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeCertificates request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeDBClusterBacktracks": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBClusterBacktracksMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBClusterBacktrackMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterBacktrackNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about backtracks for a DB cluster.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora MySQL DB clusters.

\n ", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBClusterBacktracks", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBClusterBacktracksMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier of the DB cluster to be described. This parameter is\n stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster1\n

", - "smithy.api#required": {} - } - }, - "BacktrackIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

If specified, this value is the backtrack identifier of the backtrack to be\n described.

\n

Constraints:

\n \n

Example: 123e4567-e89b-12d3-a456-426655440000\n

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

A filter that specifies one or more DB clusters to describe. Supported filters\n include the following:

\n " - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterBacktracks request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeDBClusterEndpoints": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBClusterEndpointsMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBClusterEndpointMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about endpoints for an Amazon Aurora DB cluster.

\n \n

This action only applies to Aurora DB clusters.

\n ", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBClusterEndpoints", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBClusterEndpointsMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is\n stored as a lowercase string.

" - } - }, - "DBClusterEndpointIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the endpoint to describe. This parameter is stored as a lowercase string.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

A set of name-value pairs that define which endpoints to include in the output.\n The filters are specified as name-value pairs, in the format\n Name=endpoint_type,Values=endpoint_type1,endpoint_type2,....\n Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status.\n Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom.\n Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any.\n Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterEndpoints request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - } - }, - "com.amazonaws.rds#DescribeDBClusterParameterGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBClusterParameterGroupsMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBClusterParameterGroupsMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of DBClusterParameterGroup descriptions. If a \n DBClusterParameterGroupName parameter is specified,\n the list will contain only the description of the specified DB cluster parameter group.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBClusterParameterGroups", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBClusterParameterGroupsMessage": { - "type": "structure", - "members": { - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of a specific DB cluster parameter group to return details for.

\n

Constraints:

\n " - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeDBClusterParameters": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBClusterParametersMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBClusterParameterGroupDetails" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the detailed parameter list for a particular DB cluster parameter group.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "Parameters", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBClusterParametersMessage": { - "type": "structure", - "members": { - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of a specific DB cluster parameter group to return parameter details for.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "Source": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A value that indicates to return only parameters for a specific source. \n Parameter sources can be engine, service,\n or customer.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeDBClusterSnapshotAttributes": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBClusterSnapshotAttributesMessage" - }, - "output": { - "target": "com.amazonaws.rds#DescribeDBClusterSnapshotAttributesResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

\n

When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes\n returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are \n authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB cluster snapshot is public and\n can be copied or restored by all Amazon Web Services accounts.

\n

To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the\n manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

" - } - }, - "com.amazonaws.rds#DescribeDBClusterSnapshotAttributesMessage": { - "type": "structure", - "members": { - "DBClusterSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the DB cluster snapshot to describe the attributes for.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeDBClusterSnapshotAttributesResult": { - "type": "structure", - "members": { - "DBClusterSnapshotAttributesResult": { - "target": "com.amazonaws.rds#DBClusterSnapshotAttributesResult" - } - } - }, - "com.amazonaws.rds#DescribeDBClusterSnapshots": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBClusterSnapshotsMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBClusterSnapshotMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about DB cluster snapshots. This API action supports pagination.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBClusterSnapshots", - "pageSize": "MaxRecords" - }, - "smithy.waiters#waitable": { - "DBClusterSnapshotAvailable": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "DBClusterSnapshots[].Status", - "expected": "available", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusterSnapshots[].Status", - "expected": "deleted", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusterSnapshots[].Status", - "expected": "deleting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusterSnapshots[].Status", - "expected": "failed", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusterSnapshots[].Status", - "expected": "incompatible-restore", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusterSnapshots[].Status", - "expected": "incompatible-parameters", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 30 - }, - "DBClusterSnapshotDeleted": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "length(DBClusterSnapshots) == `0`", - "expected": "true", - "comparator": "booleanEquals" - } - } - }, - { - "state": "success", - "matcher": { - "errorType": "DBClusterSnapshotNotFoundFault" - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusterSnapshots[].Status", - "expected": "creating", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusterSnapshots[].Status", - "expected": "modifying", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusterSnapshots[].Status", - "expected": "rebooting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusterSnapshots[].Status", - "expected": "resetting-master-credentials", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 30 - } - } - } - }, - "com.amazonaws.rds#DescribeDBClusterSnapshotsMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. \n This parameter can't be used in conjunction with the\n DBClusterSnapshotIdentifier parameter.\n This parameter isn't case-sensitive.

\n

Constraints:

\n " - } - }, - "DBClusterSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A specific DB cluster snapshot identifier to describe. \n This parameter can't be used in conjunction with the\n DBClusterIdentifier parameter. \n This value is stored as a lowercase string.

\n

Constraints:

\n " - } - }, - "SnapshotType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The type of DB cluster snapshots to be returned. You can specify one of the following values:

\n \n

If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are\n returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared\n parameter. You can include public DB cluster snapshots with these results by enabling the \n IncludePublic parameter.

\n

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

A filter that specifies one or more DB cluster snapshots to describe.

\n

Supported filters:

\n " - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "IncludeShared": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.

\n

You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from\n another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.

" - } - }, - "IncludePublic": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.

\n

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeDBClusters": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBClustersMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBClusterMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

\n

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBClusters", - "pageSize": "MaxRecords" - }, - "smithy.waiters#waitable": { - "DBClusterAvailable": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "DBClusters[].Status", - "expected": "available", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusters[].Status", - "expected": "deleted", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusters[].Status", - "expected": "deleting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusters[].Status", - "expected": "failed", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusters[].Status", - "expected": "incompatible-restore", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusters[].Status", - "expected": "incompatible-parameters", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 30 - }, - "DBClusterDeleted": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "length(DBClusters) == `0`", - "expected": "true", - "comparator": "booleanEquals" - } - } - }, - { - "state": "success", - "matcher": { - "errorType": "DBClusterNotFoundFault" - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusters[].Status", - "expected": "creating", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusters[].Status", - "expected": "modifying", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusters[].Status", - "expected": "rebooting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBClusters[].Status", - "expected": "resetting-master-credentials", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 30 - } - } - } - }, - "com.amazonaws.rds#DescribeDBClustersMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, \n information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n " - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

A filter that specifies one or more DB clusters to describe.

\n

Supported filters:

\n " - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "IncludeShared": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Optional Boolean parameter that specifies whether the output includes information about clusters\n shared from other Amazon Web Services accounts.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeDBEngineVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBEngineVersionsMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBEngineVersionMessage" - }, - "traits": { - "smithy.api#documentation": "

Returns a list of the available DB engines.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBEngineVersions", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBEngineVersionsMessage": { - "type": "structure", - "members": { - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database engine to return.

\n

Valid Values:

\n " - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database engine version to return.

\n

Example: 5.1.49\n

" - } - }, - "DBParameterGroupFamily": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of a specific DB parameter group family to return details for.

\n

Constraints:

\n " - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

A filter that specifies one or more DB engine versions to describe.

\n

Supported filters:

\n " - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "DefaultOnly": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.

" - } - }, - "ListSupportedCharacterSets": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to list the supported character sets for each engine version.

\n

If this parameter is enabled and the requested engine supports the CharacterSetName parameter for\n CreateDBInstance, the response includes a list of supported character sets for each engine\n version.

\n

For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets\n to true, RDS Custom returns no results.

" - } - }, - "ListSupportedTimezones": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to list the supported time zones for each engine version.

\n

If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, \n the response includes a list of supported time zones for each engine version.

\n

For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones\n to true, RDS Custom returns no results.

" - } - }, - "IncludeAll": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.

" - } - } - } - }, - "com.amazonaws.rds#DescribeDBInstanceAutomatedBackups": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBInstanceAutomatedBackupsMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackupMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackupNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Displays backups for both current and deleted\n instances. For example, use this operation to\n find details about automated backups for previously deleted instances. Current instances\n with retention periods greater than zero (0) are returned for both the \n DescribeDBInstanceAutomatedBackups and\n DescribeDBInstances operations.

\n

All parameters are optional.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBInstanceAutomatedBackups", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBInstanceAutomatedBackupsMessage": { - "type": "structure", - "members": { - "DbiResourceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The resource ID of the DB instance that is the source of \n the automated backup. This parameter isn't case-sensitive.

" - } - }, - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

(Optional) The user-supplied instance identifier. If this parameter is specified, it must\n match the identifier of an existing DB instance. It returns information from the\n specific DB instance' automated backup. This parameter isn't case-sensitive.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

A filter that specifies which resources to return based on status.

\n

Supported filters are the following:

\n \n

Returns all resources by default. The status for each resource is specified in the response.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified \n MaxRecords value, a pagination token called a marker is included in the response so that \n you can retrieve the remaining results.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The pagination token provided in the previous request. If this parameter is specified the response \n includes only records beyond the marker, up to MaxRecords.

" - } - }, - "DBInstanceAutomatedBackupsArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicated automated backups, for example,\n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

\n

This setting doesn't apply to RDS Custom.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Parameter input for DescribeDBInstanceAutomatedBackups.

" - } - }, - "com.amazonaws.rds#DescribeDBInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBInstancesMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBInstanceMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about provisioned RDS instances. This API supports pagination.

\n \n

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

\n ", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBInstances", - "pageSize": "MaxRecords" - }, - "smithy.api#suppress": ["WaitableTraitInvalidErrorType"], - "smithy.waiters#waitable": { - "DBInstanceAvailable": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "DBInstances[].DBInstanceStatus", - "expected": "available", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBInstances[].DBInstanceStatus", - "expected": "deleted", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBInstances[].DBInstanceStatus", - "expected": "deleting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBInstances[].DBInstanceStatus", - "expected": "failed", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBInstances[].DBInstanceStatus", - "expected": "incompatible-restore", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBInstances[].DBInstanceStatus", - "expected": "incompatible-parameters", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 30 - }, - "DBInstanceDeleted": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "length(DBInstances) == `0`", - "expected": "true", - "comparator": "booleanEquals" - } - } - }, - { - "state": "success", - "matcher": { - "errorType": "DBInstanceNotFound" - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBInstances[].DBInstanceStatus", - "expected": "creating", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBInstances[].DBInstanceStatus", - "expected": "modifying", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBInstances[].DBInstanceStatus", - "expected": "rebooting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBInstances[].DBInstanceStatus", - "expected": "resetting-master-credentials", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 30 - } - } - } - }, - "com.amazonaws.rds#DescribeDBInstancesMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, \n information from only the specific DB instance is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n " - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

A filter that specifies one or more DB instances to describe.

\n

Supported filters:

\n " - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBInstances request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeDBLogFiles": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBLogFilesMessage" - }, - "output": { - "target": "com.amazonaws.rds#DescribeDBLogFilesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of DB log files for the DB instance.

\n

This command doesn't apply to RDS Custom.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DescribeDBLogFiles", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBLogFilesDetails": { - "type": "structure", - "members": { - "LogFileName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the log file for the specified DB instance.

" - } - }, - "LastWritten": { - "target": "com.amazonaws.rds#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

A POSIX timestamp when the last log entry was written.

" - } - }, - "Size": { - "target": "com.amazonaws.rds#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The size, in bytes, of the log file for the specified DB instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element to DescribeDBLogFiles.

" - } - }, - "com.amazonaws.rds#DescribeDBLogFilesList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DescribeDBLogFilesDetails", - "traits": { - "smithy.api#xmlName": "DescribeDBLogFilesDetails" - } - } - }, - "com.amazonaws.rds#DescribeDBLogFilesMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The customer-assigned name of the DB instance that contains the log files you want to list.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "FilenameContains": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Filters the available log files for log file names that contain the specified string.

" - } - }, - "FileLastWritten": { - "target": "com.amazonaws.rds#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

" - } - }, - "FileSize": { - "target": "com.amazonaws.rds#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Filters the available log files for files larger than the specified size.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeDBLogFilesResponse": { - "type": "structure", - "members": { - "DescribeDBLogFiles": { - "target": "com.amazonaws.rds#DescribeDBLogFilesList", - "traits": { - "smithy.api#documentation": "

The DB log files returned.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a later DescribeDBLogFiles request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The response from a call to DescribeDBLogFiles.

" - } - }, - "com.amazonaws.rds#DescribeDBParameterGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBParameterGroupsMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBParameterGroupsMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified,\n the list will contain only the description of the specified DB parameter group.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBParameterGroups", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBParameterGroupsMessage": { - "type": "structure", - "members": { - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of a specific DB parameter group to return details for.

\n

Constraints:

\n " - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeDBParameters": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBParametersMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBParameterGroupDetails" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the detailed parameter list for a particular DB parameter group.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "Parameters", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBParametersMessage": { - "type": "structure", - "members": { - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of a specific DB parameter group to return details for.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "Source": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The parameter types to return.

\n

Default: All parameter types returned

\n

Valid Values: user | system | engine-default\n

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - } - }, - "com.amazonaws.rds#DescribeDBProxies": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBProxiesRequest" - }, - "output": { - "target": "com.amazonaws.rds#DescribeDBProxiesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBProxyNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about DB proxies.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBProxies", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBProxiesRequest": { - "type": "structure", - "members": { - "DBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB proxy. If you omit this parameter,\n the output includes information about all DB proxies owned by\n your Amazon Web Services account ID.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter is not currently supported.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - } - } - }, - "com.amazonaws.rds#DescribeDBProxiesResponse": { - "type": "structure", - "members": { - "DBProxies": { - "target": "com.amazonaws.rds#DBProxyList", - "traits": { - "smithy.api#documentation": "

A return value representing an arbitrary number of DBProxy data structures.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - } - }, - "com.amazonaws.rds#DescribeDBProxyEndpoints": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBProxyEndpointsRequest" - }, - "output": { - "target": "com.amazonaws.rds#DescribeDBProxyEndpointsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBProxyEndpointNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about DB proxy endpoints.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBProxyEndpoints", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBProxyEndpointsRequest": { - "type": "structure", - "members": { - "DBProxyName": { - "target": "com.amazonaws.rds#DBProxyName", - "traits": { - "smithy.api#documentation": "

The name of the DB proxy whose endpoints you want to describe. If you omit\n this parameter, the output includes information about all DB proxy endpoints\n associated with all your DB proxies.

" - } - }, - "DBProxyEndpointName": { - "target": "com.amazonaws.rds#DBProxyEndpointName", - "traits": { - "smithy.api#documentation": "

The name of a DB proxy endpoint to describe. If you omit this parameter,\n the output includes information about all DB proxy endpoints associated with\n the specified proxy.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter is not currently supported.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - } - } - }, - "com.amazonaws.rds#DescribeDBProxyEndpointsResponse": { - "type": "structure", - "members": { - "DBProxyEndpoints": { - "target": "com.amazonaws.rds#DBProxyEndpointList", - "traits": { - "smithy.api#documentation": "

The list of ProxyEndpoint objects returned by the API operation.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - } - }, - "com.amazonaws.rds#DescribeDBProxyTargetGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBProxyTargetGroupsRequest" - }, - "output": { - "target": "com.amazonaws.rds#DescribeDBProxyTargetGroupsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBProxyNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBProxyStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "TargetGroups", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBProxyTargetGroupsRequest": { - "type": "structure", - "members": { - "DBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DBProxy associated with the target group.

", - "smithy.api#required": {} - } - }, - "TargetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DBProxyTargetGroup to describe.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter is not currently supported.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - } - } - }, - "com.amazonaws.rds#DescribeDBProxyTargetGroupsResponse": { - "type": "structure", - "members": { - "TargetGroups": { - "target": "com.amazonaws.rds#TargetGroupList", - "traits": { - "smithy.api#documentation": "

An arbitrary number of DBProxyTargetGroup objects, containing details of the corresponding target groups.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - } - }, - "com.amazonaws.rds#DescribeDBProxyTargets": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBProxyTargetsRequest" - }, - "output": { - "target": "com.amazonaws.rds#DescribeDBProxyTargetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBProxyNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyTargetNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBProxyStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about DBProxyTarget objects. This API supports pagination.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "Targets", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBProxyTargetsRequest": { - "type": "structure", - "members": { - "DBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DBProxyTarget to describe.

", - "smithy.api#required": {} - } - }, - "TargetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DBProxyTargetGroup to describe.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter is not currently supported.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - } - } - }, - "com.amazonaws.rds#DescribeDBProxyTargetsResponse": { - "type": "structure", - "members": { - "Targets": { - "target": "com.amazonaws.rds#TargetList", - "traits": { - "smithy.api#documentation": "

An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - } - }, - "com.amazonaws.rds#DescribeDBSecurityGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBSecurityGroupsMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBSecurityGroupMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified,\n the list will contain only the descriptions of the specified DB security group.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring ā€“ \n Hereā€™s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n ", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBSecurityGroups", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBSecurityGroupsMessage": { - "type": "structure", - "members": { - "DBSecurityGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB security group to return details for.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBSecurityGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeDBSnapshotAttributes": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBSnapshotAttributesMessage" - }, - "output": { - "target": "com.amazonaws.rds#DescribeDBSnapshotAttributesResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

\n

When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes\n returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are \n authorized to copy or restore the manual DB snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB snapshot is public and\n can be copied or restored by all Amazon Web Services accounts.

\n

To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the\n manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

" - } - }, - "com.amazonaws.rds#DescribeDBSnapshotAttributesMessage": { - "type": "structure", - "members": { - "DBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the DB snapshot to describe the attributes for.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeDBSnapshotAttributesResult": { - "type": "structure", - "members": { - "DBSnapshotAttributesResult": { - "target": "com.amazonaws.rds#DBSnapshotAttributesResult" - } - } - }, - "com.amazonaws.rds#DescribeDBSnapshots": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBSnapshotsMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBSnapshotMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about DB snapshots. This API action supports pagination.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBSnapshots", - "pageSize": "MaxRecords" - }, - "smithy.api#suppress": ["WaitableTraitInvalidErrorType"], - "smithy.waiters#waitable": { - "DBSnapshotAvailable": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "DBSnapshots[].Status", - "expected": "available", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBSnapshots[].Status", - "expected": "deleted", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBSnapshots[].Status", - "expected": "deleting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBSnapshots[].Status", - "expected": "failed", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBSnapshots[].Status", - "expected": "incompatible-restore", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBSnapshots[].Status", - "expected": "incompatible-parameters", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 30 - }, - "DBSnapshotDeleted": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "length(DBSnapshots) == `0`", - "expected": "true", - "comparator": "booleanEquals" - } - } - }, - { - "state": "success", - "matcher": { - "errorType": "DBSnapshotNotFound" - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBSnapshots[].Status", - "expected": "creating", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBSnapshots[].Status", - "expected": "modifying", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBSnapshots[].Status", - "expected": "rebooting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "DBSnapshots[].Status", - "expected": "resetting-master-credentials", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 30 - } - } - } - }, - "com.amazonaws.rds#DescribeDBSnapshotsMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ID of the DB instance to retrieve the list of DB snapshots for. \n This parameter isn't case-sensitive.

\n

Constraints:

\n " - } - }, - "DBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A specific DB snapshot identifier to describe.\n This value is stored as a lowercase string.

\n

Constraints:

\n " - } - }, - "SnapshotType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The type of snapshots to be returned. You can specify one of the following values:

\n \n

If you don't specify a SnapshotType value, then both automated and manual snapshots are\n returned. Shared and public DB snapshots are not included in the returned results by default.\n You can include shared snapshots with these results by enabling the IncludeShared\n parameter. You can include public snapshots with these results by enabling the \n IncludePublic parameter.

\n

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

A filter that specifies one or more DB snapshots to describe.

\n

Supported filters:

\n " - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "IncludeShared": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.

\n

You can give an Amazon Web Services account permission to restore a manual DB snapshot from\n another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "IncludePublic": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.

\n

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "DbiResourceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A specific DB resource ID to describe.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeDBSubnetGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeDBSubnetGroupsMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBSubnetGroupMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

\n

For an overview of CIDR ranges, go to the \n Wikipedia Tutorial.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "DBSubnetGroups", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeDBSubnetGroupsMessage": { - "type": "structure", - "members": { - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB subnet group to return details for.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeDBSubnetGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeEngineDefaultClusterParameters": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeEngineDefaultClusterParametersMessage" - }, - "output": { - "target": "com.amazonaws.rds#DescribeEngineDefaultClusterParametersResult" - }, - "traits": { - "smithy.api#documentation": "

Returns the default engine and system parameter information for the cluster database engine.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

" - } - }, - "com.amazonaws.rds#DescribeEngineDefaultClusterParametersMessage": { - "type": "structure", - "members": { - "DBParameterGroupFamily": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group family to return engine parameter information for.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeEngineDefaultClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeEngineDefaultClusterParametersResult": { - "type": "structure", - "members": { - "EngineDefaults": { - "target": "com.amazonaws.rds#EngineDefaults" - } - } - }, - "com.amazonaws.rds#DescribeEngineDefaultParameters": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeEngineDefaultParametersMessage" - }, - "output": { - "target": "com.amazonaws.rds#DescribeEngineDefaultParametersResult" - }, - "traits": { - "smithy.api#documentation": "

Returns the default engine and system parameter information for the specified database engine.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "EngineDefaults.Marker", - "items": "EngineDefaults.Parameters", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeEngineDefaultParametersMessage": { - "type": "structure", - "members": { - "DBParameterGroupFamily": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group family.

\n

Valid Values:

\n ", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeEngineDefaultParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeEngineDefaultParametersResult": { - "type": "structure", - "members": { - "EngineDefaults": { - "target": "com.amazonaws.rds#EngineDefaults" - } - } - }, - "com.amazonaws.rds#DescribeEventCategories": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeEventCategoriesMessage" - }, - "output": { - "target": "com.amazonaws.rds#EventCategoriesMessage" - }, - "traits": { - "smithy.api#documentation": "

Displays a list of categories for all event source types, or, if specified, for a specified source type.\n You can also see this list in the \"Amazon RDS event categories and event messages\" section of the \n Amazon RDS User Guide\n or the\n \n Amazon Aurora User Guide\n .

" - } - }, - "com.amazonaws.rds#DescribeEventCategoriesMessage": { - "type": "structure", - "members": { - "SourceType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The type of source that is generating the events. For RDS Proxy events, specify db-proxy.

\n

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeEventSubscriptions": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeEventSubscriptionsMessage" - }, - "output": { - "target": "com.amazonaws.rds#EventSubscriptionsMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#SubscriptionNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all the subscription descriptions for a customer account. The description for a subscription includes \n SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

\n

If you specify a SubscriptionName, lists the description for that subscription.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "EventSubscriptionsList", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeEventSubscriptionsMessage": { - "type": "structure", - "members": { - "SubscriptionName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the RDS event notification subscription you want to describe.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeEvents": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeEventsMessage" - }, - "output": { - "target": "com.amazonaws.rds#EventsMessage" - }, - "traits": { - "smithy.api#documentation": "

Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. \n Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be \n obtained by providing the name as a parameter.

\n

For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora\n events in the Amazon Aurora User Guide.

\n \n

By default, RDS returns events that were generated in the past hour.

\n ", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "Events", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeEventsMessage": { - "type": "structure", - "members": { - "SourceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

\n

Constraints:

\n " - } - }, - "SourceType": { - "target": "com.amazonaws.rds#SourceType", - "traits": { - "smithy.api#documentation": "

The event source to retrieve events for. If no value is specified, all events are returned.

" - } - }, - "StartTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The beginning of the time interval to retrieve events for,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

\n

Example: 2009-07-08T18:00Z

" - } - }, - "EndTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The end of the time interval for which to retrieve events,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

\n

Example: 2009-07-08T18:00Z

" - } - }, - "Duration": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of minutes to retrieve events for.

\n

Default: 60

" - } - }, - "EventCategories": { - "target": "com.amazonaws.rds#EventCategoriesList", - "traits": { - "smithy.api#documentation": "

A list of event categories that trigger notifications for a event notification subscription.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeEvents request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeExportTasks": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeExportTasksMessage" - }, - "output": { - "target": "com.amazonaws.rds#ExportTasksMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#ExportTaskNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a snapshot export to Amazon S3. This API operation supports\n pagination.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "ExportTasks", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeExportTasksMessage": { - "type": "structure", - "members": { - "ExportTaskIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the snapshot export task to be described.

" - } - }, - "SourceArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to\n include in the output. Filter names and values are case-sensitive.

\n

Supported filters include the following:

\n " - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeExportTasks request.\n If you specify this parameter, the response includes only records beyond the marker,\n up to the value specified by the MaxRecords parameter.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the \n specified value, a pagination token called a marker is included in the response. \n You can use the marker in a later DescribeExportTasks request \n to retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "SourceType": { - "target": "com.amazonaws.rds#ExportSourceType", - "traits": { - "smithy.api#documentation": "

The type of source for the export.

" - } - } - } - }, - "com.amazonaws.rds#DescribeGlobalClusters": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeGlobalClustersMessage" - }, - "output": { - "target": "com.amazonaws.rds#GlobalClustersMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about Aurora global database clusters. This API supports pagination.

\n

For more information on Amazon Aurora, see What is Amazon Aurora? in the\n Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters.

\n ", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "GlobalClusters", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeGlobalClustersMessage": { - "type": "structure", - "members": { - "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n " - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified\n MaxRecords value, a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeGlobalClusters request. If\n this parameter is specified, the response includes only records beyond the marker, up to the value\n specified by MaxRecords.

" - } - } - } - }, - "com.amazonaws.rds#DescribeOptionGroupOptions": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeOptionGroupOptionsMessage" - }, - "output": { - "target": "com.amazonaws.rds#OptionGroupOptionsMessage" - }, - "traits": { - "smithy.api#documentation": "

Describes all available options.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "OptionGroupOptions", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeOptionGroupOptionsMessage": { - "type": "structure", - "members": { - "EngineName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A required parameter. Options available for the given engine name are described.

\n

Valid Values:

\n ", - "smithy.api#required": {} - } - }, - "MajorEngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

If specified, filters the results to include only options for the specified major engine version.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeOptionGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeOptionGroupsMessage" - }, - "output": { - "target": "com.amazonaws.rds#OptionGroups" - }, - "errors": [ - { - "target": "com.amazonaws.rds#OptionGroupNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the available option groups.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "OptionGroupsList", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeOptionGroupsMessage": { - "type": "structure", - "members": { - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeOptionGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "EngineName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Filters the list of option groups to only include groups associated with a specific database engine.

\n

Valid Values:

\n " - } - }, - "MajorEngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeOrderableDBInstanceOptions": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeOrderableDBInstanceOptionsMessage" - }, - "output": { - "target": "com.amazonaws.rds#OrderableDBInstanceOptionsMessage" - }, - "traits": { - "smithy.api#documentation": "

Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "OrderableDBInstanceOptions", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeOrderableDBInstanceOptionsMessage": { - "type": "structure", - "members": { - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the engine to retrieve DB instance options for.

\n

Valid Values:

\n ", - "smithy.api#required": {} - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

" - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The license model filter value. Specify this parameter to show only the available offerings \n matching the specified license model.

\n

RDS Custom supports only the BYOL licensing model.

" - } - }, - "AvailabilityZoneGroup": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.

\n

Omit this parameter to show the available offerings in the specified Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "Vpc": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports \n only VPC offerings.

\n

RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output \n shows VPC offerings.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 10000.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribePendingMaintenanceActions": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribePendingMaintenanceActionsMessage" - }, - "output": { - "target": "com.amazonaws.rds#PendingMaintenanceActionsMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#ResourceNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "PendingMaintenanceActions", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribePendingMaintenanceActionsMessage": { - "type": "structure", - "members": { - "ResourceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN of a resource to return pending maintenance actions for.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

A filter that specifies one or more resources to return pending maintenance actions for.

\n

Supported filters:

\n " - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribePendingMaintenanceActions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to a number of records specified by MaxRecords.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeReservedDBInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeReservedDBInstancesMessage" - }, - "output": { - "target": "com.amazonaws.rds#ReservedDBInstanceMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#ReservedDBInstanceNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "ReservedDBInstances", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeReservedDBInstancesMessage": { - "type": "structure", - "members": { - "ReservedDBInstanceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

" - } - }, - "ReservedDBInstancesOfferingId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

" - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

" - } - }, - "Duration": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

\n

Valid Values: 1 | 3 | 31536000 | 94608000\n

" - } - }, - "ProductDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

" - } - }, - "OfferingType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

\n

Valid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\" \n

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to show only those reservations that support Multi-AZ.

" - } - }, - "LeaseId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.

\n \n

Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

\n " - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeReservedDBInstancesOfferings": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeReservedDBInstancesOfferingsMessage" - }, - "output": { - "target": "com.amazonaws.rds#ReservedDBInstancesOfferingMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#ReservedDBInstancesOfferingNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Lists available reserved DB instance offerings.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "ReservedDBInstancesOfferings", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeReservedDBInstancesOfferingsMessage": { - "type": "structure", - "members": { - "ReservedDBInstancesOfferingId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

\n

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706\n

" - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

" - } - }, - "Duration": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

\n

Valid Values: 1 | 3 | 31536000 | 94608000\n

" - } - }, - "ProductDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.

\n \n

The results show offerings that partially match the filter value.

\n " - } - }, - "OfferingType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

\n

Valid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\" \n

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to show only those reservations that support Multi-AZ.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeSourceRegions": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeSourceRegionsMessage" - }, - "output": { - "target": "com.amazonaws.rds#SourceRegionMessage" - }, - "traits": { - "smithy.api#documentation": "

Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, \n copy a DB snapshot from, or replicate automated backups from.

\n

Use this operation to determine whether cross-Region features are supported between other Regions \n and your current Region. This operation supports pagination.

\n

To return information about the Regions that are enabled for your account, or all Regions, \n use the EC2 operation DescribeRegions. For more information, see \n \n DescribeRegions in the Amazon EC2 API Reference.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "SourceRegions", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeSourceRegionsMessage": { - "type": "structure", - "members": { - "RegionName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The source Amazon Web Services Region name. For example, us-east-1.

\n

Constraints:

\n " - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeSourceRegions request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeValidDBInstanceModifications": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeValidDBInstanceModificationsMessage" - }, - "output": { - "target": "com.amazonaws.rds#DescribeValidDBInstanceModificationsResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to \n your DB instance. You can use this information when you call ModifyDBInstance.

\n

This command doesn't apply to RDS Custom.

" - } - }, - "com.amazonaws.rds#DescribeValidDBInstanceModificationsMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The customer identifier or the ARN of your DB instance.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#DescribeValidDBInstanceModificationsResult": { - "type": "structure", - "members": { - "ValidDBInstanceModificationsMessage": { - "target": "com.amazonaws.rds#ValidDBInstanceModificationsMessage" - } - } - }, - "com.amazonaws.rds#Description": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.rds#DomainMembership": { - "type": "structure", - "members": { - "Domain": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the Active Directory Domain.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.

" - } - }, - "FQDN": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The fully qualified domain name of the Active Directory Domain.

" - } - }, - "IAMRoleName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the IAM role to be used when making API calls to the Directory Service.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An Active Directory Domain membership record associated with the DB instance or cluster.

" - } - }, - "com.amazonaws.rds#DomainMembershipList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DomainMembership", - "traits": { - "smithy.api#xmlName": "DomainMembership" - } - } - }, - "com.amazonaws.rds#DomainNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "DomainNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n Domain doesn't refer to an existing Active Directory domain.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#Double": { - "type": "double", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.rds#DoubleOptional": { - "type": "double" - }, - "com.amazonaws.rds#DoubleRange": { - "type": "structure", - "members": { - "From": { - "target": "com.amazonaws.rds#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum value in the range.

" - } - }, - "To": { - "target": "com.amazonaws.rds#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum value in the range.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A range of double values.

" - } - }, - "com.amazonaws.rds#DoubleRangeList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DoubleRange", - "traits": { - "smithy.api#xmlName": "DoubleRange" - } - } - }, - "com.amazonaws.rds#DownloadDBLogFilePortion": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DownloadDBLogFilePortionMessage" - }, - "output": { - "target": "com.amazonaws.rds#DownloadDBLogFilePortionDetails" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBLogFileNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Downloads all or a portion of the specified log file, up to 1 MB in size.

\n

This command doesn't apply to RDS Custom.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "pageSize": "NumberOfLines" - } - } - }, - "com.amazonaws.rds#DownloadDBLogFilePortionDetails": { - "type": "structure", - "members": { - "LogFileData": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Entries from the specified log file.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a later DownloadDBLogFilePortion request.

" - } - }, - "AdditionalDataPending": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Boolean value that if true, indicates there is more data to be downloaded.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element to DownloadDBLogFilePortion.

" - } - }, - "com.amazonaws.rds#DownloadDBLogFilePortionMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The customer-assigned name of the DB instance that contains the log files you want to list.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "LogFileName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the log file to be downloaded.

", - "smithy.api#required": {} - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The pagination token provided in the previous request or \"0\". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.

" - } - }, - "NumberOfLines": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.

\n

If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning \n or the end of the log file, depending on the value of the Marker parameter.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#EC2SecurityGroup": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the status of the EC2 security group. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

" - } - }, - "EC2SecurityGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the EC2 security group.

" - } - }, - "EC2SecurityGroupId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the id of the EC2 security group.

" - } - }, - "EC2SecurityGroupOwnerId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the Amazon Web Services ID of the owner of the EC2 security group\n specified in the EC2SecurityGroupName field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the following actions:

\n " - } - }, - "com.amazonaws.rds#EC2SecurityGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#EC2SecurityGroup", - "traits": { - "smithy.api#xmlName": "EC2SecurityGroup" - } - } - }, - "com.amazonaws.rds#Ec2ImagePropertiesNotSupportedFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "Ec2ImagePropertiesNotSupportedFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The AMI configuration prerequisite has not been met.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#Endpoint": { - "type": "structure", - "members": { - "Address": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the DNS address of the DB instance.

" - } - }, - "Port": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Specifies the port that the database engine is listening on.

" - } - }, - "HostedZoneId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type represents the information you need to connect to an Amazon RDS DB instance.\n This data type is used as a response element in the following actions:

\n \n

For the data structure that represents Amazon Aurora DB cluster endpoints,\n see DBClusterEndpoint.

" - } - }, - "com.amazonaws.rds#EngineDefaults": { - "type": "structure", - "members": { - "DBParameterGroupFamily": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the DB parameter group family that the engine default parameters apply to.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n EngineDefaults request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .

" - } - }, - "Parameters": { - "target": "com.amazonaws.rds#ParametersList", - "traits": { - "smithy.api#documentation": "

Contains a list of engine default parameters.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

" - } - }, - "com.amazonaws.rds#EngineFamily": { - "type": "enum", - "members": { - "MYSQL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MYSQL" - } - }, - "POSTGRESQL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POSTGRESQL" - } - }, - "SQLSERVER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SQLSERVER" - } - } - } - }, - "com.amazonaws.rds#EngineModeList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String" - } - }, - "com.amazonaws.rds#Event": { - "type": "structure", - "members": { - "SourceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the identifier for the source of the event.

" - } - }, - "SourceType": { - "target": "com.amazonaws.rds#SourceType", - "traits": { - "smithy.api#documentation": "

Specifies the source type for this event.

" - } - }, - "Message": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides the text of this event.

" - } - }, - "EventCategories": { - "target": "com.amazonaws.rds#EventCategoriesList", - "traits": { - "smithy.api#documentation": "

Specifies the category for the event.

" - } - }, - "Date": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

Specifies the date and time of the event.

" - } - }, - "SourceArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the event.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the DescribeEvents action.

" - } - }, - "com.amazonaws.rds#EventCategoriesList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#xmlName": "EventCategory" - } - } - }, - "com.amazonaws.rds#EventCategoriesMap": { - "type": "structure", - "members": { - "SourceType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The source type that the returned categories belong to

" - } - }, - "EventCategories": { - "target": "com.amazonaws.rds#EventCategoriesList", - "traits": { - "smithy.api#documentation": "

The event categories for the specified source type

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the results of a successful invocation of the DescribeEventCategories\n operation.

" - } - }, - "com.amazonaws.rds#EventCategoriesMapList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#EventCategoriesMap", - "traits": { - "smithy.api#xmlName": "EventCategoriesMap" - } - } - }, - "com.amazonaws.rds#EventCategoriesMessage": { - "type": "structure", - "members": { - "EventCategoriesMapList": { - "target": "com.amazonaws.rds#EventCategoriesMapList", - "traits": { - "smithy.api#documentation": "

A list of EventCategoriesMap data types.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Data returned from the DescribeEventCategories operation.

" - } - }, - "com.amazonaws.rds#EventList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#Event", - "traits": { - "smithy.api#xmlName": "Event" - } - } - }, - "com.amazonaws.rds#EventSubscription": { - "type": "structure", - "members": { - "CustomerAwsId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services customer account associated with the RDS event notification subscription.

" - } - }, - "CustSubscriptionId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The RDS event notification subscription Id.

" - } - }, - "SnsTopicArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The topic ARN of the RDS event notification subscription.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The status of the RDS event notification subscription.

\n

Constraints:

\n

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

\n

The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

" - } - }, - "SubscriptionCreationTime": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The time the RDS event notification subscription was created.

" - } - }, - "SourceType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The source type for the RDS event notification subscription.

" - } - }, - "SourceIdsList": { - "target": "com.amazonaws.rds#SourceIdsList", - "traits": { - "smithy.api#documentation": "

A list of source IDs for the RDS event notification subscription.

" - } - }, - "EventCategoriesList": { - "target": "com.amazonaws.rds#EventCategoriesList", - "traits": { - "smithy.api#documentation": "

A list of event categories for the RDS event notification subscription.

" - } - }, - "Enabled": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

" - } - }, - "EventSubscriptionArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the event subscription.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

" - } - }, - "com.amazonaws.rds#EventSubscriptionQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "EventSubscriptionQuotaExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

You have reached the maximum number of event subscriptions.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#EventSubscriptionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#EventSubscription", - "traits": { - "smithy.api#xmlName": "EventSubscription" - } - } - }, - "com.amazonaws.rds#EventSubscriptionsMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "EventSubscriptionsList": { - "target": "com.amazonaws.rds#EventSubscriptionsList", - "traits": { - "smithy.api#documentation": "

A list of EventSubscriptions data types.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Data returned by the DescribeEventSubscriptions action.

" - } - }, - "com.amazonaws.rds#EventsMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous \n Events request.\n If this parameter is specified, the response includes\n only records beyond the marker, \n up to the value specified by MaxRecords.

" - } - }, - "Events": { - "target": "com.amazonaws.rds#EventList", - "traits": { - "smithy.api#documentation": "

A list of Event instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeEvents action.

" - } - }, - "com.amazonaws.rds#ExceptionMessage": { - "type": "string" - }, - "com.amazonaws.rds#ExportSourceType": { - "type": "enum", - "members": { - "SNAPSHOT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SNAPSHOT" - } - }, - "CLUSTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLUSTER" - } - } - } - }, - "com.amazonaws.rds#ExportTask": { - "type": "structure", - "members": { - "ExportTaskIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A unique identifier for the snapshot export task. This ID isn't an identifier for\n the Amazon S3 bucket where the snapshot is exported to.

" - } - }, - "SourceArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

" - } - }, - "ExportOnly": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The data exported from the snapshot. Valid values are the following:

\n " - } - }, - "SnapshotTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The time that the snapshot was created.

" - } - }, - "TaskStartTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The time that the snapshot export task started.

" - } - }, - "TaskEndTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The time that the snapshot export task completed.

" - } - }, - "S3Bucket": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket that the snapshot is exported to.

" - } - }, - "S3Prefix": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.

" - } - }, - "IamRoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot when it's exported to\n Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export\n must have encryption and decryption permissions to use this KMS key.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The progress status of the export task.

" - } - }, - "PercentProgress": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The progress of the snapshot export task as a percentage.

" - } - }, - "TotalExtractedDataInGB": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The total amount of data exported, in gigabytes.

" - } - }, - "FailureCause": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The reason the export failed, if it failed.

" - } - }, - "WarningMessage": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A warning about the snapshot export task.

" - } - }, - "SourceType": { - "target": "com.amazonaws.rds#ExportSourceType", - "traits": { - "smithy.api#documentation": "

The type of source for the export.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details of a snapshot export to Amazon S3.

\n

This data type is used as a response element in the DescribeExportTasks action.

" - } - }, - "com.amazonaws.rds#ExportTaskAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ExportTaskAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

You can't start an export task that's already running.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#ExportTaskNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ExportTaskNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The export task doesn't exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#ExportTasksList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#ExportTask", - "traits": { - "smithy.api#xmlName": "ExportTask" - } - } - }, - "com.amazonaws.rds#ExportTasksMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a later DescribeExportTasks\n request. A marker is used for pagination to identify the location to begin output for\n the next response of DescribeExportTasks.

" - } - }, - "ExportTasks": { - "target": "com.amazonaws.rds#ExportTasksList", - "traits": { - "smithy.api#documentation": "

Information about an export of a snapshot to Amazon S3.

" - } - } - } - }, - "com.amazonaws.rds#FailoverDBCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#FailoverDBClusterMessage" - }, - "output": { - "target": "com.amazonaws.rds#FailoverDBClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Forces a failover for a DB cluster.

\n

For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).

\n

For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).

\n

An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists,\n when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby \n DB instance when the primary DB instance fails.

\n

To simulate a failure of a primary instance for testing, you can force a failover. \n Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing \n connections that use those endpoint addresses when the failover is complete.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" - } - }, - "com.amazonaws.rds#FailoverDBClusterMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A DB cluster identifier to force a failover for. This parameter isn't case-sensitive.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "TargetDBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB instance to promote to the primary DB instance.

\n

Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster,\n for example mydbcluster-replica1.

\n

This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#FailoverDBClusterResult": { - "type": "structure", - "members": { - "DBCluster": { - "target": "com.amazonaws.rds#DBCluster" - } - } - }, - "com.amazonaws.rds#FailoverGlobalCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#FailoverGlobalClusterMessage" - }, - "output": { - "target": "com.amazonaws.rds#FailoverGlobalClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Initiates the failover process for an Aurora global database (GlobalCluster).

\n

A failover for an Aurora global database promotes one of secondary read-only DB clusters to be\n the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words,\n the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected\n secondary DB cluster assumes full read/write capabilities for the Aurora global database.

\n

For more information about failing over an Amazon Aurora global database, see\n Managed planned failover for Amazon Aurora global\n databases in the Amazon Aurora User Guide.

\n \n

This action applies to GlobalCluster (Aurora global databases) only. Use this action only on\n healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to\n reconfigure your Aurora global database topology.

\n " - } - }, - "com.amazonaws.rds#FailoverGlobalClusterMessage": { - "type": "structure", - "members": { - "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#GlobalClusterIdentifier", - "traits": { - "smithy.api#documentation": "

Identifier of the Aurora global database (GlobalCluster)\n that should be failed over. The identifier is the unique key assigned by\n the user when the Aurora global database was created. In other words,\n it's the name of the Aurora global database that you want to fail over.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "TargetDbClusterIdentifier": { - "target": "com.amazonaws.rds#DBClusterIdentifier", - "traits": { - "smithy.api#documentation": "

Identifier of the secondary Aurora DB cluster that you want to promote to primary for the Aurora\n global database (GlobalCluster.) Use the Amazon Resource Name (ARN) for the identifier so that\n Aurora can locate the cluster in its Amazon Web Services Region.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.rds#FailoverGlobalClusterResult": { - "type": "structure", - "members": { - "GlobalCluster": { - "target": "com.amazonaws.rds#GlobalCluster" - } - } - }, - "com.amazonaws.rds#FailoverState": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.rds#FailoverStatus", - "traits": { - "smithy.api#documentation": "

The current status of the Aurora global database (GlobalCluster). Possible values are as follows:

\n " - } - }, - "FromDbClusterArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this\n state.

" - } - }, - "ToDbClusterArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated\n with this state.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the state of scheduled or in-process failover operations on an\n Aurora global database (GlobalCluster). This Data type is empty unless a failover\n operation is scheduled or is currently underway on the Aurora global database.

" - } - }, - "com.amazonaws.rds#FailoverStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "pending" - } - }, - "FAILING_OVER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "failing-over" - } - }, - "CANCELLING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cancelling" - } - } - } - }, - "com.amazonaws.rds#FeatureNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String" - } - }, - "com.amazonaws.rds#Filter": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the filter. Filter names are case-sensitive.

", - "smithy.api#required": {} - } - }, - "Values": { - "target": "com.amazonaws.rds#FilterValueList", - "traits": { - "smithy.api#documentation": "

One or more filter values. Filter values are case-sensitive.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A filter name and value pair that is used to return a more specific list of results \n from a describe operation. Filters can be used to match a set of resources by specific \n criteria, such as IDs. The filters supported by a describe operation are documented \n with the describe operation.

\n \n

Currently, wildcards are not supported in filters.

\n \n

The following actions can be filtered:

\n " - } - }, - "com.amazonaws.rds#FilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#Filter", - "traits": { - "smithy.api#xmlName": "Filter" - } - } - }, - "com.amazonaws.rds#FilterValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#xmlName": "Value" - } - } - }, - "com.amazonaws.rds#GlobalCluster": { - "type": "structure", - "members": { - "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Contains a user-supplied global database cluster identifier. This identifier is the unique key that\n identifies a global database cluster.

" - } - }, - "GlobalClusterResourceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in\n Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.

" - } - }, - "GlobalClusterArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the global database cluster.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the current state of this global database cluster.

" - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Aurora database engine used by the global database cluster.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Indicates the database engine version.

" - } - }, - "DatabaseName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The default database name within the new global database cluster.

" - } - }, - "StorageEncrypted": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

The storage encryption setting for the global database cluster.

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

The deletion protection setting for the new global database cluster.

" - } - }, - "GlobalClusterMembers": { - "target": "com.amazonaws.rds#GlobalClusterMemberList", - "traits": { - "smithy.api#documentation": "

The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to\n 1 item.

" - } - }, - "FailoverState": { - "target": "com.amazonaws.rds#FailoverState", - "traits": { - "smithy.api#documentation": "

A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database.\n This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database (GlobalCluster).

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A data type representing an Aurora global database.

" - } - }, - "com.amazonaws.rds#GlobalClusterAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "GlobalClusterAlreadyExistsFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The GlobalClusterIdentifier already exists. Choose a new global database identifier (unique name) to create a new global database cluster.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#GlobalClusterIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[A-Za-z][0-9A-Za-z-:._]*$" - } - }, - "com.amazonaws.rds#GlobalClusterList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#GlobalCluster", - "traits": { - "smithy.api#xmlName": "GlobalClusterMember" - } - } - }, - "com.amazonaws.rds#GlobalClusterMember": { - "type": "structure", - "members": { - "DBClusterArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for each Aurora cluster.

" - } - }, - "Readers": { - "target": "com.amazonaws.rds#ReadersArnList", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for each read-only secondary cluster\n associated with the Aurora global database.

" - } - }, - "IsWriter": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the Aurora cluster is the primary cluster\n (that is, has read-write capability) for the Aurora global\n database with which it is associated.

" - } - }, - "GlobalWriteForwardingStatus": { - "target": "com.amazonaws.rds#WriteForwardingStatus", - "traits": { - "smithy.api#documentation": "

Specifies whether a secondary cluster in an Aurora global database has\n write forwarding enabled, not enabled, or is in the process of enabling it.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A data structure with information about any primary and\n secondary clusters associated with an Aurora global database.

" - } - }, - "com.amazonaws.rds#GlobalClusterMemberList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#GlobalClusterMember", - "traits": { - "smithy.api#xmlName": "GlobalClusterMember" - } - } - }, - "com.amazonaws.rds#GlobalClusterNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "GlobalClusterNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The GlobalClusterIdentifier doesn't refer to an existing global database cluster.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#GlobalClusterQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "GlobalClusterQuotaExceededFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The number of global database clusters for this account is already at the maximum allowed.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#GlobalClustersMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeGlobalClusters request.\n If this parameter is specified, the response includes\n only records beyond the marker, up to the value specified by MaxRecords.

" - } - }, - "GlobalClusters": { - "target": "com.amazonaws.rds#GlobalClusterList", - "traits": { - "smithy.api#documentation": "

The list of global clusters returned by this request.

" - } - } - } - }, - "com.amazonaws.rds#IAMAuthMode": { - "type": "enum", - "members": { - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - }, - "REQUIRED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REQUIRED" - } - }, - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - } - } - }, - "com.amazonaws.rds#IPRange": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

" - } - }, - "CIDRIP": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the IP range.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the DescribeDBSecurityGroups action.

" - } - }, - "com.amazonaws.rds#IPRangeList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#IPRange", - "traits": { - "smithy.api#xmlName": "IPRange" - } - } - }, - "com.amazonaws.rds#IamRoleMissingPermissionsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "IamRoleMissingPermissions", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The IAM role requires additional permissions to export to an Amazon S3 bucket.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#IamRoleNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "IamRoleNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The IAM role is missing for exporting to an Amazon S3 bucket.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#InstanceQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InstanceQuotaExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB\n instances.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InsufficientAvailableIPsInSubnetFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InsufficientAvailableIPsInSubnetFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The requested operation can't be performed because there aren't enough available IP addresses \n in the proxy's subnets. Add more CIDR blocks to the VPC or remove IP address that aren't required \n from the subnets.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InsufficientDBClusterCapacityFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InsufficientDBClusterCapacityFault", - "httpResponseCode": 403 - }, - "smithy.api#documentation": "

The DB cluster doesn't have enough capacity for the current operation.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.rds#InsufficientDBInstanceCapacityFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InsufficientDBInstanceCapacity", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The specified DB instance class isn't available in the specified Availability\n Zone.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InsufficientStorageClusterCapacityFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InsufficientStorageClusterCapacity", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

There is insufficient storage available for the current action. You might be able to\n resolve this error by updating your subnet group to use different Availability Zones\n that have more storage available.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#Integer": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.rds#IntegerOptional": { - "type": "integer" - }, - "com.amazonaws.rds#InvalidBlueGreenDeploymentStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidBlueGreenDeploymentStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The blue/green deployment can't be switched over or deleted because there is an invalid configuration in \n the green environment.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidCustomDBEngineVersionStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidCustomDBEngineVersionStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

You can't delete the CEV.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBClusterCapacityFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBClusterCapacityFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

\n Capacity isn't a valid Aurora Serverless DB cluster\n capacity. Valid capacity values are 2, 4, 8, 16, \n 32, 64, 128, and 256.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBClusterEndpointStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBClusterEndpointStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The requested operation can't be performed on the endpoint while the endpoint is in this state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBClusterSnapshotStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The supplied value isn't a valid DB cluster snapshot state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBClusterStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBClusterStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The requested operation can't be performed while the cluster is in this state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBInstanceAutomatedBackupStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBInstanceAutomatedBackupState", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The automated backup is in an invalid state. \n For example, this automated backup is associated with an active instance.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBInstanceStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBInstanceState", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The DB instance isn't in a valid state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBParameterGroupStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBParameterGroupState", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The DB parameter group is in use or is in an invalid state. If you are attempting\n to delete the parameter group, you can't delete it when the parameter group is in\n this state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBProxyEndpointStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBProxyEndpointStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

You can't perform this operation while the DB proxy endpoint is in a particular state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBProxyStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBProxyStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The requested operation can't be performed while the proxy is in this state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBSecurityGroupStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBSecurityGroupState", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The state of the DB security group doesn't allow deletion.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBSnapshotStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBSnapshotState", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The state of the DB snapshot doesn't allow deletion.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBSubnetGroupFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBSubnetGroupFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The DBSubnetGroup doesn't belong to the same VPC as that of an existing\n cross-region read replica of the same source instance.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBSubnetGroupStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBSubnetGroupStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The DB subnet group cannot be deleted because it's in use.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidDBSubnetStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidDBSubnetStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The DB subnet isn't in the available state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidEventSubscriptionStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidEventSubscriptionState", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

This error can occur if someone else is modifying a subscription. You should retry the action.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidExportOnlyFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidExportOnly", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The export is invalid for exporting to an Amazon S3 bucket.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidExportSourceStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidExportSourceState", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidExportTaskStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidExportTaskStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

You can't cancel an export task that has completed.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidGlobalClusterStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidGlobalClusterStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The global cluster is in an invalid state and can't perform the requested operation.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidOptionGroupStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidOptionGroupStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The option group isn't in the available state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidRestoreFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidRestoreFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

Cannot restore from VPC backup to non-VPC DB instance.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidS3BucketFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidS3BucketFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The specified Amazon S3 bucket name can't be found or Amazon RDS isn't\n authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidSubnet": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidSubnet", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InvalidVPCNetworkStateFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidVPCNetworkStateFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The DB subnet group doesn't cover all Availability Zones after it's\n created because of users' change.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#KMSKeyNotAccessibleFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "KMSKeyNotAccessibleFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

An error occurred accessing an Amazon Web Services KMS key.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#KeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String" - } - }, - "com.amazonaws.rds#KmsKeyIdOrArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_:\\-\\/]+$" - } - }, - "com.amazonaws.rds#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ListTagsForResourceMessage" - }, - "output": { - "target": "com.amazonaws.rds#TagListMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all tags on an Amazon RDS resource.

\n

For an overview on tagging an Amazon RDS resource, \n see Tagging Amazon RDS Resources \n in the Amazon RDS User Guide.

" - } - }, - "com.amazonaws.rds#ListTagsForResourceMessage": { - "type": "structure", - "members": { - "ResourceName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

This parameter isn't currently supported.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#LogTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String" - } - }, - "com.amazonaws.rds#Long": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.rds#LongOptional": { - "type": "long" - }, - "com.amazonaws.rds#MasterUserSecret": { - "type": "structure", - "members": { - "SecretArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secret.

" - } - }, - "SecretStatus": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The status of the secret.

\n

The possible status values include the following:

\n " - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier that is used to encrypt the secret.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

" - } - }, - "com.amazonaws.rds#MaxRecords": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 20, - "max": 100 - } - } - }, - "com.amazonaws.rds#MinimumEngineVersionPerAllowedValue": { - "type": "structure", - "members": { - "AllowedValue": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The allowed value for an option setting.

" - } - }, - "MinimumEngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The minimum DB engine version required for the allowed value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The minimum DB engine version required for each corresponding allowed value for an option setting.

" - } - }, - "com.amazonaws.rds#MinimumEngineVersionPerAllowedValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#MinimumEngineVersionPerAllowedValue", - "traits": { - "smithy.api#xmlName": "MinimumEngineVersionPerAllowedValue" - } - } - }, - "com.amazonaws.rds#ModifyActivityStream": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyActivityStreamRequest" - }, - "output": { - "target": "com.amazonaws.rds#ModifyActivityStreamResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#ResourceNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only,\n whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy,\n and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream in the\n Amazon RDS User Guide.

\n

This operation is supported for RDS for Oracle only.

" - } - }, - "com.amazonaws.rds#ModifyActivityStreamRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the RDS for Oracle DB instance,\n for example, arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db.

" - } - }, - "AuditPolicyState": { - "target": "com.amazonaws.rds#AuditPolicyState", - "traits": { - "smithy.api#documentation": "

The audit policy state. When a policy is unlocked, it is read/write. When it is locked, it is\n read-only. You can edit your audit policy only when the activity stream is unlocked or stopped.

" - } - } - } - }, - "com.amazonaws.rds#ModifyActivityStreamResponse": { - "type": "structure", - "members": { - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.

" - } - }, - "KinesisStreamName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Kinesis data stream to be used for the database activity stream.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#ActivityStreamStatus", - "traits": { - "smithy.api#documentation": "

The status of the modification to the database activity stream.

" - } - }, - "Mode": { - "target": "com.amazonaws.rds#ActivityStreamMode", - "traits": { - "smithy.api#documentation": "

The mode of the database activity stream.

" - } - }, - "EngineNativeAuditFieldsIncluded": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Indicates whether engine-native audit fields are included in the database activity stream.

" - } - }, - "PolicyStatus": { - "target": "com.amazonaws.rds#ActivityStreamPolicyStatus", - "traits": { - "smithy.api#documentation": "

The status of the modification to the policy state of the database activity stream.

" - } - } - } - }, - "com.amazonaws.rds#ModifyCertificates": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyCertificatesMessage" - }, - "output": { - "target": "com.amazonaws.rds#ModifyCertificatesResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#CertificateNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS)\n certificate for Amazon RDS for new DB instances, or remove the override.

\n

By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB\n instances that is different from the default certificate provided by RDS. You can also\n use this operation to remove the override, so that new DB instances use the default\n certificate provided by RDS.

\n

You might need to override the default certificate in the following situations:

\n \n

For more information about rotating your SSL/TLS certificate for RDS DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.

\n

For more information about rotating your SSL/TLS certificate for Aurora DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.

" - } - }, - "com.amazonaws.rds#ModifyCertificatesMessage": { - "type": "structure", - "members": { - "CertificateIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The new default certificate identifier to override the current one with.

\n

To determine the valid values, use the describe-certificates CLI\n command or the DescribeCertificates API operation.

" - } - }, - "RemoveCustomerOverride": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to remove the override for the default certificate. \n If the override is removed, the default certificate is the system\n default.

" - } - } - } - }, - "com.amazonaws.rds#ModifyCertificatesResult": { - "type": "structure", - "members": { - "Certificate": { - "target": "com.amazonaws.rds#Certificate" - } - } - }, - "com.amazonaws.rds#ModifyCurrentDBClusterCapacity": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyCurrentDBClusterCapacityMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBClusterCapacityInfo" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterCapacityFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.

\n

Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale \n fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity \n to set the capacity explicitly.

\n

After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale\n the DB cluster based on the cooldown period for scaling up and the cooldown period\n for scaling down.

\n

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.

\n \n

If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that \n prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, \n see \n Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

\n \n \n

This action only applies to Aurora Serverless v1 DB clusters.

\n " - } - }, - "com.amazonaws.rds#ModifyCurrentDBClusterCapacityMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "Capacity": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The DB cluster capacity.

\n

When you change the capacity of a paused Aurora Serverless v1 DB cluster, it automatically resumes.

\n

Constraints:

\n " - } - }, - "SecondsBeforeTimeout": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point\n to perform seamless scaling before enforcing the timeout action. The default is\n 300.

\n

Specify a value between 10 and 600 seconds.

" - } - }, - "TimeoutAction": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

\n

\n ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

\n

\n RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.

" - } - } - } - }, - "com.amazonaws.rds#ModifyCustomDBEngineVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyCustomDBEngineVersionMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBEngineVersion" - }, - "errors": [ - { - "target": "com.amazonaws.rds#CustomDBEngineVersionNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidCustomDBEngineVersionStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling \n DescribeDBEngineVersions.

\n \n

The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the ModifyCustomDbEngineVersion event.

\n \n

For more information, see Modifying CEV status \n in the Amazon RDS User Guide.

" - } - }, - "com.amazonaws.rds#ModifyCustomDBEngineVersionMessage": { - "type": "structure", - "members": { - "Engine": { - "target": "com.amazonaws.rds#CustomEngineName", - "traits": { - "smithy.api#documentation": "

The DB engine. The only supported value is custom-oracle-ee.

", - "smithy.api#required": {} - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#CustomEngineVersion", - "traits": { - "smithy.api#documentation": "

The custom engine version (CEV) that you want to modify. This option is required for \n RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and \n EngineVersion is unique per customer per Amazon Web Services Region.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.rds#Description", - "traits": { - "smithy.api#documentation": "

An optional description of your CEV.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#CustomEngineVersionStatus", - "traits": { - "smithy.api#documentation": "

The availability status to be assigned to the CEV. Valid values are as follows:

\n
\n
available
\n
\n

You can use this CEV to create a new RDS Custom DB instance.

\n
\n
inactive
\n
\n

You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. \n You can't patch or create new instances with this CEV.

\n
\n
\n

You can change any status to any status. A typical reason to change status is to prevent the accidental \n use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status \n of your CEV from available to inactive, and from inactive back to \n available. To change the availability status of the CEV, it must not currently be in use by an \n RDS Custom instance, snapshot, or automated backup.

" - } - } - } - }, - "com.amazonaws.rds#ModifyDBCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyDBClusterMessage" - }, - "output": { - "target": "com.amazonaws.rds#ModifyDBClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" + "target": "com.amazonaws.rds#AuthorizeDBSecurityGroupIngress" + }, + { + "target": "com.amazonaws.rds#BacktrackDBCluster" + }, + { + "target": "com.amazonaws.rds#CancelExportTask" + }, + { + "target": "com.amazonaws.rds#CopyDBClusterParameterGroup" + }, + { + "target": "com.amazonaws.rds#CopyDBClusterSnapshot" + }, + { + "target": "com.amazonaws.rds#CopyDBParameterGroup" + }, + { + "target": "com.amazonaws.rds#CopyDBSnapshot" + }, + { + "target": "com.amazonaws.rds#CopyOptionGroup" + }, + { + "target": "com.amazonaws.rds#CreateBlueGreenDeployment" + }, + { + "target": "com.amazonaws.rds#CreateCustomDBEngineVersion" + }, + { + "target": "com.amazonaws.rds#CreateDBCluster" + }, + { + "target": "com.amazonaws.rds#CreateDBClusterEndpoint" + }, + { + "target": "com.amazonaws.rds#CreateDBClusterParameterGroup" + }, + { + "target": "com.amazonaws.rds#CreateDBClusterSnapshot" + }, + { + "target": "com.amazonaws.rds#CreateDBInstance" + }, + { + "target": "com.amazonaws.rds#CreateDBInstanceReadReplica" + }, + { + "target": "com.amazonaws.rds#CreateDBParameterGroup" + }, + { + "target": "com.amazonaws.rds#CreateDBProxy" + }, + { + "target": "com.amazonaws.rds#CreateDBProxyEndpoint" + }, + { + "target": "com.amazonaws.rds#CreateDBSecurityGroup" + }, + { + "target": "com.amazonaws.rds#CreateDBSnapshot" + }, + { + "target": "com.amazonaws.rds#CreateDBSubnetGroup" + }, + { + "target": "com.amazonaws.rds#CreateEventSubscription" + }, + { + "target": "com.amazonaws.rds#CreateGlobalCluster" + }, + { + "target": "com.amazonaws.rds#CreateOptionGroup" + }, + { + "target": "com.amazonaws.rds#DeleteBlueGreenDeployment" + }, + { + "target": "com.amazonaws.rds#DeleteCustomDBEngineVersion" + }, + { + "target": "com.amazonaws.rds#DeleteDBCluster" + }, + { + "target": "com.amazonaws.rds#DeleteDBClusterEndpoint" + }, + { + "target": "com.amazonaws.rds#DeleteDBClusterParameterGroup" + }, + { + "target": "com.amazonaws.rds#DeleteDBClusterSnapshot" + }, + { + "target": "com.amazonaws.rds#DeleteDBInstance" + }, + { + "target": "com.amazonaws.rds#DeleteDBInstanceAutomatedBackup" + }, + { + "target": "com.amazonaws.rds#DeleteDBParameterGroup" + }, + { + "target": "com.amazonaws.rds#DeleteDBProxy" + }, + { + "target": "com.amazonaws.rds#DeleteDBProxyEndpoint" + }, + { + "target": "com.amazonaws.rds#DeleteDBSecurityGroup" + }, + { + "target": "com.amazonaws.rds#DeleteDBSnapshot" + }, + { + "target": "com.amazonaws.rds#DeleteDBSubnetGroup" + }, + { + "target": "com.amazonaws.rds#DeleteEventSubscription" + }, + { + "target": "com.amazonaws.rds#DeleteGlobalCluster" + }, + { + "target": "com.amazonaws.rds#DeleteOptionGroup" + }, + { + "target": "com.amazonaws.rds#DeregisterDBProxyTargets" + }, + { + "target": "com.amazonaws.rds#DescribeAccountAttributes" + }, + { + "target": "com.amazonaws.rds#DescribeBlueGreenDeployments" + }, + { + "target": "com.amazonaws.rds#DescribeCertificates" + }, + { + "target": "com.amazonaws.rds#DescribeDBClusterBacktracks" + }, + { + "target": "com.amazonaws.rds#DescribeDBClusterEndpoints" + }, + { + "target": "com.amazonaws.rds#DescribeDBClusterParameterGroups" + }, + { + "target": "com.amazonaws.rds#DescribeDBClusterParameters" + }, + { + "target": "com.amazonaws.rds#DescribeDBClusters" + }, + { + "target": "com.amazonaws.rds#DescribeDBClusterSnapshotAttributes" + }, + { + "target": "com.amazonaws.rds#DescribeDBClusterSnapshots" + }, + { + "target": "com.amazonaws.rds#DescribeDBEngineVersions" + }, + { + "target": "com.amazonaws.rds#DescribeDBInstanceAutomatedBackups" + }, + { + "target": "com.amazonaws.rds#DescribeDBInstances" + }, + { + "target": "com.amazonaws.rds#DescribeDBLogFiles" + }, + { + "target": "com.amazonaws.rds#DescribeDBParameterGroups" + }, + { + "target": "com.amazonaws.rds#DescribeDBParameters" + }, + { + "target": "com.amazonaws.rds#DescribeDBProxies" + }, + { + "target": "com.amazonaws.rds#DescribeDBProxyEndpoints" + }, + { + "target": "com.amazonaws.rds#DescribeDBProxyTargetGroups" + }, + { + "target": "com.amazonaws.rds#DescribeDBProxyTargets" + }, + { + "target": "com.amazonaws.rds#DescribeDBSecurityGroups" + }, + { + "target": "com.amazonaws.rds#DescribeDBSnapshotAttributes" + }, + { + "target": "com.amazonaws.rds#DescribeDBSnapshots" + }, + { + "target": "com.amazonaws.rds#DescribeDBSubnetGroups" + }, + { + "target": "com.amazonaws.rds#DescribeEngineDefaultClusterParameters" + }, + { + "target": "com.amazonaws.rds#DescribeEngineDefaultParameters" + }, + { + "target": "com.amazonaws.rds#DescribeEventCategories" + }, + { + "target": "com.amazonaws.rds#DescribeEvents" + }, + { + "target": "com.amazonaws.rds#DescribeEventSubscriptions" + }, + { + "target": "com.amazonaws.rds#DescribeExportTasks" + }, + { + "target": "com.amazonaws.rds#DescribeGlobalClusters" + }, + { + "target": "com.amazonaws.rds#DescribeOptionGroupOptions" + }, + { + "target": "com.amazonaws.rds#DescribeOptionGroups" + }, + { + "target": "com.amazonaws.rds#DescribeOrderableDBInstanceOptions" + }, + { + "target": "com.amazonaws.rds#DescribePendingMaintenanceActions" + }, + { + "target": "com.amazonaws.rds#DescribeReservedDBInstances" + }, + { + "target": "com.amazonaws.rds#DescribeReservedDBInstancesOfferings" + }, + { + "target": "com.amazonaws.rds#DescribeSourceRegions" + }, + { + "target": "com.amazonaws.rds#DescribeValidDBInstanceModifications" + }, + { + "target": "com.amazonaws.rds#DownloadDBLogFilePortion" + }, + { + "target": "com.amazonaws.rds#FailoverDBCluster" + }, + { + "target": "com.amazonaws.rds#FailoverGlobalCluster" + }, + { + "target": "com.amazonaws.rds#ListTagsForResource" + }, + { + "target": "com.amazonaws.rds#ModifyActivityStream" + }, + { + "target": "com.amazonaws.rds#ModifyCertificates" + }, + { + "target": "com.amazonaws.rds#ModifyCurrentDBClusterCapacity" + }, + { + "target": "com.amazonaws.rds#ModifyCustomDBEngineVersion" + }, + { + "target": "com.amazonaws.rds#ModifyDBCluster" + }, + { + "target": "com.amazonaws.rds#ModifyDBClusterEndpoint" + }, + { + "target": "com.amazonaws.rds#ModifyDBClusterParameterGroup" + }, + { + "target": "com.amazonaws.rds#ModifyDBClusterSnapshotAttribute" + }, + { + "target": "com.amazonaws.rds#ModifyDBInstance" + }, + { + "target": "com.amazonaws.rds#ModifyDBParameterGroup" + }, + { + "target": "com.amazonaws.rds#ModifyDBProxy" + }, + { + "target": "com.amazonaws.rds#ModifyDBProxyEndpoint" + }, + { + "target": "com.amazonaws.rds#ModifyDBProxyTargetGroup" + }, + { + "target": "com.amazonaws.rds#ModifyDBSnapshot" + }, + { + "target": "com.amazonaws.rds#ModifyDBSnapshotAttribute" + }, + { + "target": "com.amazonaws.rds#ModifyDBSubnetGroup" + }, + { + "target": "com.amazonaws.rds#ModifyEventSubscription" + }, + { + "target": "com.amazonaws.rds#ModifyGlobalCluster" + }, + { + "target": "com.amazonaws.rds#ModifyOptionGroup" + }, + { + "target": "com.amazonaws.rds#PromoteReadReplica" + }, + { + "target": "com.amazonaws.rds#PromoteReadReplicaDBCluster" + }, + { + "target": "com.amazonaws.rds#PurchaseReservedDBInstancesOffering" + }, + { + "target": "com.amazonaws.rds#RebootDBCluster" + }, + { + "target": "com.amazonaws.rds#RebootDBInstance" + }, + { + "target": "com.amazonaws.rds#RegisterDBProxyTargets" + }, + { + "target": "com.amazonaws.rds#RemoveFromGlobalCluster" + }, + { + "target": "com.amazonaws.rds#RemoveRoleFromDBCluster" + }, + { + "target": "com.amazonaws.rds#RemoveRoleFromDBInstance" + }, + { + "target": "com.amazonaws.rds#RemoveSourceIdentifierFromSubscription" + }, + { + "target": "com.amazonaws.rds#RemoveTagsFromResource" + }, + { + "target": "com.amazonaws.rds#ResetDBClusterParameterGroup" + }, + { + "target": "com.amazonaws.rds#ResetDBParameterGroup" + }, + { + "target": "com.amazonaws.rds#RestoreDBClusterFromS3" + }, + { + "target": "com.amazonaws.rds#RestoreDBClusterFromSnapshot" + }, + { + "target": "com.amazonaws.rds#RestoreDBClusterToPointInTime" + }, + { + "target": "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshot" + }, + { + "target": "com.amazonaws.rds#RestoreDBInstanceFromS3" + }, + { + "target": "com.amazonaws.rds#RestoreDBInstanceToPointInTime" + }, + { + "target": "com.amazonaws.rds#RevokeDBSecurityGroupIngress" + }, + { + "target": "com.amazonaws.rds#StartActivityStream" + }, + { + "target": "com.amazonaws.rds#StartDBCluster" + }, + { + "target": "com.amazonaws.rds#StartDBInstance" + }, + { + "target": "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplication" + }, + { + "target": "com.amazonaws.rds#StartExportTask" + }, + { + "target": "com.amazonaws.rds#StopActivityStream" + }, + { + "target": "com.amazonaws.rds#StopDBCluster" + }, + { + "target": "com.amazonaws.rds#StopDBInstance" + }, + { + "target": "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplication" + }, + { + "target": "com.amazonaws.rds#SwitchoverBlueGreenDeployment" + }, + { + "target": "com.amazonaws.rds#SwitchoverReadReplica" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "RDS", + "arnNamespace": "rds", + "cloudFormationName": "RDS", + "cloudTrailEventSource": "rds.amazonaws.com", + "endpointPrefix": "rds" + }, + "aws.auth#sigv4": { + "name": "rds" + }, + "aws.protocols#awsQuery": {}, + "smithy.api#documentation": "Amazon Relational Database Service\n

\n

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and \n scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational \n database and manages common database administration tasks, freeing up developers to focus on what makes their applications \n and businesses unique.

\n

Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, \n Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools \n you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS \n automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS \n is flexible: you can scale your DB instance's compute resources and storage capacity to meet your \n application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for \n the resources you use.

\n

This interface reference for Amazon RDS contains documentation for a programming or command line interface \n you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might \n require techniques such as polling or callback functions to determine when a command has been applied. In this \n reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, \n or during the maintenance window. The reference structure is as follows, and we list following some related topics \n from the user guide.

\n

\n Amazon RDS API Reference\n

\n \n

\n Amazon RDS User Guide\n

\n ", + "smithy.api#title": "Amazon Relational Database Service", + "smithy.api#xmlNamespace": { + "uri": "http://rds.amazonaws.com/doc/2014-10-31/" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": true, + "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": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "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" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://rds-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": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "rds.ca-central-1" + ] + } + ], + "endpoint": { + "url": "https://rds-fips.ca-central-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "rds.us-east-1" + ] + } + ], + "endpoint": { + "url": "https://rds-fips.us-east-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "rds.us-east-2" + ] + } + ], + "endpoint": { + "url": "https://rds-fips.us-east-2.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "rds.us-west-1" + ] + } + ], + "endpoint": { + "url": "https://rds-fips.us-west-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "rds.us-west-2" + ] + } + ], + "endpoint": { + "url": "https://rds-fips.us-west-2.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-us-gov", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://rds.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://rds-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://rds.{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://rds.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region ap-south-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.ap-south-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-south-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-south-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.ap-south-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-south-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-south-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-south-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-south-2", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-south-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-south-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-south-2", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.ap-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.eu-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.eu-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-south-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.eu-south-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-south-2", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-south-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.eu-south-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-south-2", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-south-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-south-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-south-2", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-south-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-south-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-south-2", + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-gov-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-gov-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.us-gov-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-gov-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-gov-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region me-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.me-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "me-central-1", + "UseFIPS": true + } + }, + { + "documentation": "For region me-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.me-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "me-central-1", + "UseFIPS": true + } + }, + { + "documentation": "For region me-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.me-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "me-central-1", + "UseFIPS": false + } + }, + { + "documentation": "For region me-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.me-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "me-central-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.ca-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ca-central-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ca-central-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.ca-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ca-central-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ca-central-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.eu-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-central-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-central-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-central-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-central-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "Region": "us-iso-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-iso-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "Region": "us-iso-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-iso-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-central-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.eu-central-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-central-2", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-central-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.eu-central-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-central-2", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-central-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-central-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-central-2", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-central-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-central-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-central-2", + "UseFIPS": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.us-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.af-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "af-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.af-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "af-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.af-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "af-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.af-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "af-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.eu-north-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-north-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-north-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-north-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-north-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-north-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.eu-west-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-3", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-3", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-west-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-3", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-3", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.eu-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.eu-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.ap-northeast-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-3", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-3", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-northeast-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-3", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-3", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.ap-northeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-northeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-2", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-2", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-northeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-1", + "UseFIPS": false + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.me-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "me-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.me-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "me-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.me-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "me-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.me-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "me-south-1", + "UseFIPS": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.sa-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "sa-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "sa-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.sa-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "sa-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "sa-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.ap-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "Region": "cn-north-1", + "UseFIPS": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "Region": "cn-north-1", + "UseFIPS": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "Region": "cn-north-1", + "UseFIPS": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "Region": "cn-north-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-gov-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-gov-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-gov-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.us-gov-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-gov-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-gov-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-southeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-2", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-2", + "UseFIPS": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "Region": "us-iso-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-iso-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "Region": "us-iso-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-iso-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.ap-southeast-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-3", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-3", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-southeast-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-3", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-3", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-4 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.ap-southeast-4.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-4", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-4 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.ap-southeast-4.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-4", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-southeast-4.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-4", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.ap-southeast-4.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-4", + "UseFIPS": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-east-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-east-2", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-2", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.us-east-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-east-2", + "UseFIPS": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-east-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-2", + "UseFIPS": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "Region": "cn-northwest-1", + "UseFIPS": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "Region": "cn-northwest-1", + "UseFIPS": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://rds.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "Region": "cn-northwest-1", + "UseFIPS": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "Region": "cn-northwest-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "Region": "us-isob-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-isob-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "Region": "us-isob-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://rds.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-isob-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": 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": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": true, + "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": { + "UseDualStack": true, + "Region": "us-east-1", + "UseFIPS": false, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.rds#ApplyMethod": { + "type": "enum", + "members": { + "immediate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "immediate" + } + }, + "pending_reboot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-reboot" + } + } + } + }, + "com.amazonaws.rds#ApplyPendingMaintenanceAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ApplyPendingMaintenanceActionMessage" + }, + "output": { + "target": "com.amazonaws.rds#ApplyPendingMaintenanceActionResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Applies a pending maintenance action to a resource (for example, to a DB instance).

" + } + }, + "com.amazonaws.rds#ApplyPendingMaintenanceActionMessage": { + "type": "structure", + "members": { + "ResourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The RDS Amazon Resource Name (ARN) of the resource that the \n pending maintenance action applies to. For information about \n creating an ARN, \n see \n Constructing an RDS Amazon Resource Name (ARN).

", + "smithy.api#required": {} + } + }, + "ApplyAction": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The pending maintenance action to apply to this resource.

\n

Valid values: system-update, db-upgrade, \n hardware-maintenance, ca-certificate-rotation\n

", + "smithy.api#required": {} + } + }, + "OptInType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in \n request of type immediate can't be undone.

\n

Valid values:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#ApplyPendingMaintenanceActionResult": { + "type": "structure", + "members": { + "ResourcePendingMaintenanceActions": { + "target": "com.amazonaws.rds#ResourcePendingMaintenanceActions" + } + } + }, + "com.amazonaws.rds#AttributeValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "AttributeValue" + } + } + }, + "com.amazonaws.rds#AuditPolicyState": { + "type": "enum", + "members": { + "LOCKED_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "locked" + } + }, + "UNLOCKED_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unlocked" + } + } + } + }, + "com.amazonaws.rds#AuthScheme": { + "type": "enum", + "members": { + "SECRETS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECRETS" + } + } + } + }, + "com.amazonaws.rds#AuthorizationAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AuthorizationAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified CIDR IP range or Amazon EC2 security group is already authorized for\n the specified DB security group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#AuthorizationNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AuthorizationNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified CIDR IP range or Amazon EC2 security group might not be authorized\n for the specified DB security group.

\n

Or, RDS might not be authorized to perform necessary actions using IAM on your\n behalf.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#AuthorizationQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AuthorizationQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB security group authorization quota has been reached.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#AuthorizeDBSecurityGroupIngress": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressMessage" + }, + "output": { + "target": "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#AuthorizationAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#AuthorizationQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security \n groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC \n instances. Second, IP ranges are available if the application accessing your database is running on the internet. \n Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId \n and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

\n

You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in \n another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

\n

For an overview of CIDR ranges, go to the \n Wikipedia Tutorial.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring ā€“ \n Hereā€™s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n " + } + }, + "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressMessage": { + "type": "structure", + "members": { + "DBSecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB security group to add authorization to.

", + "smithy.api#required": {} + } + }, + "CIDRIP": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The IP range to authorize.

" + } + }, + "EC2SecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Name of the EC2 security group to authorize.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName \n or EC2SecurityGroupId must be provided.

" + } + }, + "EC2SecurityGroupId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Id of the EC2 security group to authorize.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + } + }, + "EC2SecurityGroupOwnerId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Amazon Web Services account number of the owner of the EC2 security group\n specified in the EC2SecurityGroupName parameter.\n The Amazon Web Services access key ID isn't an acceptable value.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#AuthorizeDBSecurityGroupIngressResult": { + "type": "structure", + "members": { + "DBSecurityGroup": { + "target": "com.amazonaws.rds#DBSecurityGroup" + } + } + }, + "com.amazonaws.rds#AutomationMode": { + "type": "enum", + "members": { + "FULL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "full" + } + }, + "ALL_PAUSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "all-paused" + } + } + } + }, + "com.amazonaws.rds#AvailabilityZone": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Availability Zone.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains Availability Zone information.

\n

This data type is used as an element in the OrderableDBInstanceOption\n data type.

" + } + }, + "com.amazonaws.rds#AvailabilityZoneList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#AvailabilityZone", + "traits": { + "smithy.api#xmlName": "AvailabilityZone" + } + } + }, + "com.amazonaws.rds#AvailabilityZones": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "AvailabilityZone" + } + } + }, + "com.amazonaws.rds#AvailableProcessorFeature": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the processor feature. Valid names are coreCount \n and threadsPerCore.

" + } + }, + "DefaultValue": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The default value for the processor feature of the DB instance class.

" + } + }, + "AllowedValues": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The allowed values for the processor feature of the DB instance class.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the available processor feature information for the DB instance class of a DB instance.

\n

For more information, see Configuring the\n Processor of the DB Instance Class in the Amazon RDS User Guide.\n \n

" + } + }, + "com.amazonaws.rds#AvailableProcessorFeatureList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#AvailableProcessorFeature", + "traits": { + "smithy.api#xmlName": "AvailableProcessorFeature" + } + } + }, + "com.amazonaws.rds#AwsBackupRecoveryPointArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 43, + "max": 350 + }, + "smithy.api#pattern": "^arn:aws[a-z-]*:backup:[-a-z0-9]+:[0-9]{12}:[-a-z]+:([a-z0-9\\-]+:)?[a-z][a-z0-9\\-]{0,255}$" + } + }, + "com.amazonaws.rds#BacktrackDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#BacktrackDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterBacktrack" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Backtracks a DB cluster to a specific time, without creating a new DB cluster.

\n

For more information on backtracking, see \n \n Backtracking an Aurora DB Cluster in the \n Amazon Aurora User Guide.

\n \n

This action applies only to Aurora MySQL DB clusters.

\n " + } + }, + "com.amazonaws.rds#BacktrackDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier of the DB cluster to be backtracked. This parameter is\n stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster1\n

", + "smithy.api#required": {} + } + }, + "BacktrackTo": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the time to backtrack the DB cluster to, specified in ISO\n 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia\n page.\n

\n \n

If the specified time isn't a consistent time for the DB cluster, \n Aurora automatically chooses the nearest possible consistent time for the DB cluster.

\n \n

Constraints:

\n \n

Example: 2017-07-08T18:00Z\n

", + "smithy.api#required": {} + } + }, + "Force": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to force the DB cluster to backtrack when binary logging is\n enabled. Otherwise, an error occurs when binary logging is enabled.

" + } + }, + "UseEarliestTimeOnPointInTimeUnavailable": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to backtrack the DB cluster to the earliest possible\n backtrack time when BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest\n backtrack time, an error occurs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#BackupPolicyNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "BackupPolicyNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#deprecated": { + "message": "Please avoid using this fault" + }, + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#BlueGreenDeployment": { + "type": "structure", + "members": { + "BlueGreenDeploymentIdentifier": { + "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", + "traits": { + "smithy.api#documentation": "

The system-generated identifier of the blue/green deployment.

" + } + }, + "BlueGreenDeploymentName": { + "target": "com.amazonaws.rds#BlueGreenDeploymentName", + "traits": { + "smithy.api#documentation": "

The user-supplied name of the blue/green deployment.

" + } + }, + "Source": { + "target": "com.amazonaws.rds#DatabaseArn", + "traits": { + "smithy.api#documentation": "

The source database for the blue/green deployment.

\n

Before switchover, the source database is the production database in the blue environment.

" + } + }, + "Target": { + "target": "com.amazonaws.rds#DatabaseArn", + "traits": { + "smithy.api#documentation": "

The target database for the blue/green deployment.

\n

Before switchover, the target database is the clone database in the green environment.

" + } + }, + "SwitchoverDetails": { + "target": "com.amazonaws.rds#SwitchoverDetailList", + "traits": { + "smithy.api#documentation": "

The details about each source and target resource in the blue/green deployment.

" + } + }, + "Tasks": { + "target": "com.amazonaws.rds#BlueGreenDeploymentTaskList", + "traits": { + "smithy.api#documentation": "

Either tasks to be performed or tasks that have been completed on the target database before switchover.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#BlueGreenDeploymentStatus", + "traits": { + "smithy.api#documentation": "

The status of the blue/green deployment.

\n

Values:

\n " + } + }, + "StatusDetails": { + "target": "com.amazonaws.rds#BlueGreenDeploymentStatusDetails", + "traits": { + "smithy.api#documentation": "

Additional information about the status of the blue/green deployment.

" + } + }, + "CreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Specifies the time when the blue/green deployment was created, in Universal Coordinated Time (UTC).

" + } + }, + "DeleteTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Specifies the time when the blue/green deployment was deleted, in Universal Coordinated Time (UTC).

" + } + }, + "TagList": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details about a blue/green deployment.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

" + } + }, + "com.amazonaws.rds#BlueGreenDeploymentAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "BlueGreenDeploymentAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A blue/green deployment with the specified name already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#BlueGreenDeploymentIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z][0-9A-Za-z-:._]*$" + } + }, + "com.amazonaws.rds#BlueGreenDeploymentList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#BlueGreenDeployment" + } + }, + "com.amazonaws.rds#BlueGreenDeploymentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" + } + }, + "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "BlueGreenDeploymentNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n BlueGreenDeploymentIdentifier doesn't refer to an existing blue/green deployment.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#BlueGreenDeploymentStatus": { + "type": "string" + }, + "com.amazonaws.rds#BlueGreenDeploymentStatusDetails": { + "type": "string" + }, + "com.amazonaws.rds#BlueGreenDeploymentTask": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rds#BlueGreenDeploymentTaskName", + "traits": { + "smithy.api#documentation": "

The name of the blue/green deployment task.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#BlueGreenDeploymentTaskStatus", + "traits": { + "smithy.api#documentation": "

The status of the blue/green deployment task.

\n

Values:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details about a task for a blue/green deployment.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

" + } + }, + "com.amazonaws.rds#BlueGreenDeploymentTaskList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#BlueGreenDeploymentTask" + } + }, + "com.amazonaws.rds#BlueGreenDeploymentTaskName": { + "type": "string" + }, + "com.amazonaws.rds#BlueGreenDeploymentTaskStatus": { + "type": "string" + }, + "com.amazonaws.rds#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.rds#BooleanOptional": { + "type": "boolean" + }, + "com.amazonaws.rds#BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.rds#CACertificateIdentifiersList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } + }, + "com.amazonaws.rds#CancelExportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CancelExportTaskMessage" + }, + "output": { + "target": "com.amazonaws.rds#ExportTask" + }, + "errors": [ + { + "target": "com.amazonaws.rds#ExportTaskNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidExportTaskStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels an export task in progress that is exporting a snapshot to Amazon S3. \n Any data that has already been written to the S3 bucket isn't removed.

" + } + }, + "com.amazonaws.rds#CancelExportTaskMessage": { + "type": "structure", + "members": { + "ExportTaskIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the snapshot export task to cancel.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.rds#Certificate": { + "type": "structure", + "members": { + "CertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The unique key that identifies a certificate.

" + } + }, + "CertificateType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of the certificate.

" + } + }, + "Thumbprint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The thumbprint of the certificate.

" + } + }, + "ValidFrom": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The starting date from which the certificate is valid.

" + } + }, + "ValidTill": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The final date that the certificate continues to be valid.

" + } + }, + "CertificateArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the certificate.

" + } + }, + "CustomerOverride": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Whether there is an override for the default certificate identifier.

" + } + }, + "CustomerOverrideValidTill": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

If there is an override for the default certificate identifier, when the override\n expires.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A CA certificate for an Amazon Web Services account.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + } + }, + "com.amazonaws.rds#CertificateDetails": { + "type": "structure", + "members": { + "CAIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The CA identifier of the CA certificate used for the DB instance's server certificate.

" + } + }, + "ValidTill": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The expiration date of the DB instanceā€™s server certificate.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns the details of the DB instanceā€™s server certificate.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + } + }, + "com.amazonaws.rds#CertificateList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Certificate", + "traits": { + "smithy.api#xmlName": "Certificate" + } + } + }, + "com.amazonaws.rds#CertificateMessage": { + "type": "structure", + "members": { + "Certificates": { + "target": "com.amazonaws.rds#CertificateList", + "traits": { + "smithy.api#documentation": "

The list of Certificate objects for the Amazon Web Services account.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeCertificates request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Data returned by the DescribeCertificates action.

" + } + }, + "com.amazonaws.rds#CertificateNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CertificateNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n CertificateIdentifier doesn't refer to an\n existing certificate.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#CharacterSet": { + "type": "structure", + "members": { + "CharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the character set.

" + } + }, + "CharacterSetDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description of the character set.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the action DescribeDBEngineVersions.

" + } + }, + "com.amazonaws.rds#ClientPasswordAuthType": { + "type": "enum", + "members": { + "MYSQL_NATIVE_PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MYSQL_NATIVE_PASSWORD" + } + }, + "POSTGRES_SCRAM_SHA_256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSTGRES_SCRAM_SHA_256" + } + }, + "POSTGRES_MD5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSTGRES_MD5" + } + }, + "SQL_SERVER_AUTHENTICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL_SERVER_AUTHENTICATION" + } + } + } + }, + "com.amazonaws.rds#CloudwatchLogsExportConfiguration": { + "type": "structure", + "members": { + "EnableLogTypes": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of log types to enable.

" + } + }, + "DisableLogTypes": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of log types to disable.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration setting for the log types to be enabled for export to CloudWatch\n Logs for a specific DB instance or DB cluster.

\n

The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported\n (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB\n engine being used.

\n

For more information about exporting CloudWatch Logs for Amazon RDS DB instances, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

" + } + }, + "com.amazonaws.rds#ClusterPendingModifiedValues": { + "type": "structure", + "members": { + "PendingCloudwatchLogsExports": { + "target": "com.amazonaws.rds#PendingCloudwatchLogsExports" + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DBClusterIdentifier value for the DB cluster.

" + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The master credentials for the DB cluster.

" + } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine version.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automatic DB snapshots are retained.

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The allocated storage size in gibibytes (GiB) for all database engines except Amazon Aurora. For Aurora, \n AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but \n instead automatically adjusts as needed.

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the ModifyDBCluster operation and \n contains changes that will be applied during the next maintenance window.

" + } + }, + "com.amazonaws.rds#ConnectionPoolConfiguration": { + "type": "structure", + "members": { + "MaxConnectionsPercent": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

\n

If you specify MaxIdleConnectionsPercent, then you must also include a value for this parameter.

\n

Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines

\n

Constraints: Must be between 1 and 100.

" + } + }, + "MaxIdleConnectionsPercent": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Controls how actively the proxy closes idle database connections in the connection pool.\n The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.

\n

If you specify this parameter, then you must also include a value for MaxConnectionsPercent.

\n

Default: The default value is half of the value of MaxConnectionsPercent. For example, if MaxConnectionsPercent is 80, then the default value of \n MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and \n for all other engines, the default is 50.

\n

Constraints: Must be between 0 and the value of MaxConnectionsPercent.

" + } + }, + "ConnectionBorrowTimeout": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the\n proxy has opened its maximum number of connections and all connections are busy with client sessions.

\n

Default: 120

\n

Constraints: between 1 and 3600, or 0 representing unlimited

" + } + }, + "SessionPinningFilters": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

Each item in the list represents a class of SQL operations that normally cause all later statements\n in a session using a proxy to be pinned to the same underlying database connection. Including an item\n in the list exempts that class of SQL operations from the pinning behavior.

\n

Default: no session pinning filters

" + } + }, + "InitQuery": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

One or more SQL statements for the proxy to run when opening each new database connection.\n Typically used with SET statements to make sure that each connection has identical\n settings such as time zone and character set. For multiple statements, use semicolons as the separator.\n You can also include multiple variables in a single SET statement, such as\n SET x=1, y=2.

\n

Default: no initialization query

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the settings that control the size and behavior of the connection pool associated with a DBProxyTargetGroup.

" + } + }, + "com.amazonaws.rds#ConnectionPoolConfigurationInfo": { + "type": "structure", + "members": { + "MaxConnectionsPercent": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the\n max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

" + } + }, + "MaxIdleConnectionsPercent": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Controls how actively the proxy closes idle database connections in the connection pool.\n The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.\n With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.

" + } + }, + "ConnectionBorrowTimeout": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the\n proxy has opened its maximum number of connections and all connections are busy with client sessions.

" + } + }, + "SessionPinningFilters": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

Each item in the list represents a class of SQL operations that normally cause all later statements\n in a session using a proxy to be pinned to the same underlying database connection. Including an item\n in the list exempts that class of SQL operations from the pinning behavior. This setting is only supported for MySQL engine family databases. \n Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

" + } + }, + "InitQuery": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

One or more SQL statements for the proxy to run when opening each new database connection.\n Typically used with SET statements to make sure that each connection has identical\n settings such as time zone and character set. This setting is empty by default.\n For multiple statements, use semicolons as the separator.\n You can also include multiple variables in a single SET statement, such as\n SET x=1, y=2.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget.

" + } + }, + "com.amazonaws.rds#CopyDBClusterParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CopyDBClusterParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#CopyDBClusterParameterGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Copies the specified DB cluster parameter group.

" + } + }, + "com.amazonaws.rds#CopyDBClusterParameterGroupMessage": { + "type": "structure", + "members": { + "SourceDBClusterParameterGroupIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group.\n For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "TargetDBClusterParameterGroupIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the copied DB cluster parameter group.

\n

Constraints:

\n \n

Example: my-cluster-param-group1\n

", + "smithy.api#required": {} + } + }, + "TargetDBClusterParameterGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A description for the copied DB cluster parameter group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + } + }, + "com.amazonaws.rds#CopyDBClusterParameterGroupResult": { + "type": "structure", + "members": { + "DBClusterParameterGroup": { + "target": "com.amazonaws.rds#DBClusterParameterGroup" + } + } + }, + "com.amazonaws.rds#CopyDBClusterSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CopyDBClusterSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#CopyDBClusterSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterSnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Copies a snapshot of a DB cluster.

\n

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier\n must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

\n

You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case,\n the Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is the\n destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy\n an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the\n following values:

\n \n

To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified\n by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in \"copying\" status.

\n

For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see \n \n Copying a Snapshot in the Amazon Aurora User Guide.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" + } + }, + "com.amazonaws.rds#CopyDBClusterSnapshotMessage": { + "type": "structure", + "members": { + "SourceDBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.

\n

You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.

\n

Constraints:

\n \n

Example: my-cluster-snapshot1\n

", + "smithy.api#required": {} + } + }, + "TargetDBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.

\n

Constraints:

\n \n

Example: my-cluster-snapshot2\n

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.

\n

If you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS key. \n If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

\n

If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.

\n

To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier \n you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services \n Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region \n in another Amazon Web Services Region.

\n

If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, \n an error is returned.

" + } + }, + "PreSignedUrl": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud (US) Region\n to another, the URL that contains a Signature Version 4 signed request for the\n CopyDBClusterSnapshot API operation in the Amazon Web Services Region that contains\n the source DB cluster snapshot to copy. Use the PreSignedUrl parameter when\n copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify\n PreSignedUrl when copying an encrypted DB cluster snapshot in the same\n Amazon Web Services Region.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\n

The presigned URL must be a valid request for the\n CopyDBClusterSnapshot API operation that can run in the source\n Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request\n must contain the following parameter values:

\n \n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n " + } + }, + "CopyTags": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. \n By default, tags are not copied.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#CopyDBClusterSnapshotResult": { + "type": "structure", + "members": { + "DBClusterSnapshot": { + "target": "com.amazonaws.rds#DBClusterSnapshot" + } + } + }, + "com.amazonaws.rds#CopyDBParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CopyDBParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#CopyDBParameterGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Copies the specified DB parameter group.

" + } + }, + "com.amazonaws.rds#CopyDBParameterGroupMessage": { + "type": "structure", + "members": { + "SourceDBParameterGroupIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier or ARN for the source DB parameter group.\n For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "TargetDBParameterGroupIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the copied DB parameter group.

\n

Constraints:

\n \n

Example: my-db-parameter-group\n

", + "smithy.api#required": {} + } + }, + "TargetDBParameterGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A description for the copied DB parameter group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#CopyDBParameterGroupResult": { + "type": "structure", + "members": { + "DBParameterGroup": { + "target": "com.amazonaws.rds#DBParameterGroup" + } + } + }, + "com.amazonaws.rds#CopyDBSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CopyDBSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#CopyDBSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#CustomAvailabilityZoneNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Copies the specified DB snapshot. The source DB snapshot must be in the available state.

\n

You can copy a snapshot from one Amazon Web Services Region to another. In that case, the\n Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination\n Amazon Web Services Region for the DB snapshot copy.

\n

This command doesn't apply to RDS Custom.

\n

For more information about copying snapshots, see \n Copying a DB Snapshot in the Amazon RDS User Guide.

" + } + }, + "com.amazonaws.rds#CopyDBSnapshotMessage": { + "type": "structure", + "members": { + "SourceDBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the source DB snapshot.

\n

If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB\n snapshot identifier. For example, you might specify\n rds:mysql-instance1-snapshot-20130805.

\n

If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB\n snapshot ARN. For example, you might specify\n arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

\n

If you are copying from a shared manual DB snapshot, \n this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

\n

If you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region.

\n

Constraints:

\n \n

Example: rds:mydb-2012-04-02-00-01\n

\n

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805\n

", + "smithy.api#required": {} + } + }, + "TargetDBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the copy of the snapshot.

\n

Constraints:

\n \n

Example: my-db-snapshot\n

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB snapshot. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you copy an encrypted DB snapshot from your Amazon Web Services account, \n you can specify a value for this parameter to encrypt the copy with a new KMS key. \n If you don't specify a value for this parameter, \n then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot.

\n

If you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, \n then you must specify a value for this parameter.

\n

If you specify this parameter when you copy an unencrypted snapshot, \n the copy is encrypted.

\n

If you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify\n an Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region\n that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another\n Amazon Web Services Region.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "CopyTags": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. \n By default, tags aren't copied.

" + } + }, + "PreSignedUrl": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, \n the URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API \n operation in the source Amazon Web Services Region that contains the source DB snapshot to copy.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\n

You must specify this parameter when you copy an encrypted DB snapshot from another\n Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are \n copying an encrypted DB snapshot in the same Amazon Web Services Region.

\n

The presigned URL must be a valid request for the\n CopyDBClusterSnapshot API operation that can run in the source\n Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request\n must contain the following parameter values:

\n \n

To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n " + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of an option group to associate with the copy of the snapshot.

\n

Specify this option if you are copying a snapshot from one Amazon Web Services Region to another,\n and your DB instance uses a nondefault option group. \n If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, \n you must specify this option when copying across Amazon Web Services Regions. \n For more information, see \n Option group considerations in the Amazon RDS User Guide.

" + } + }, + "TargetCustomAvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The external custom Availability Zone (CAZ) identifier for the target CAZ.

\n

Example: rds-caz-aiqhTgQv.

" + } + }, + "CopyOptionGroup": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to copy the DB option group associated with the source DB snapshot to the target \n Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with \n cross-account snapshot copy calls.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#CopyDBSnapshotResult": { + "type": "structure", + "members": { + "DBSnapshot": { + "target": "com.amazonaws.rds#DBSnapshot" + } + } + }, + "com.amazonaws.rds#CopyOptionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CopyOptionGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#CopyOptionGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#OptionGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#OptionGroupQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Copies the specified option group.

" + } + }, + "com.amazonaws.rds#CopyOptionGroupMessage": { + "type": "structure", + "members": { + "SourceOptionGroupIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the source option group.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "TargetOptionGroupIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the copied option group.

\n

Constraints:

\n \n

Example: my-option-group\n

", + "smithy.api#required": {} + } + }, + "TargetOptionGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description for the copied option group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#CopyOptionGroupResult": { + "type": "structure", + "members": { + "OptionGroup": { + "target": "com.amazonaws.rds#OptionGroup" + } + } + }, + "com.amazonaws.rds#CreateBlueGreenDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateBlueGreenDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.rds#CreateBlueGreenDeploymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#BlueGreenDeploymentAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InstanceQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#SourceClusterNotSupportedFault" + }, + { + "target": "com.amazonaws.rds#SourceDatabaseNotSupportedFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a blue/green deployment.

\n

A blue/green deployment creates a staging environment that copies the production environment. \n In a blue/green deployment, the blue environment is the current production environment. \n The green environment is the staging environment. The staging environment stays in sync \n with the current production environment using logical replication.

\n

You can make changes to the databases in the green environment without affecting \n production workloads. For example, you can upgrade the major or minor DB engine version, change \n database parameters, or make schema changes in the staging environment. You can thoroughly test \n changes in the green environment. When ready, you can switch over the environments to promote the \n green environment to be the new production environment. The switchover typically takes under a minute.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

" + } + }, + "com.amazonaws.rds#CreateBlueGreenDeploymentRequest": { + "type": "structure", + "members": { + "BlueGreenDeploymentName": { + "target": "com.amazonaws.rds#BlueGreenDeploymentName", + "traits": { + "smithy.api#documentation": "

The name of the blue/green deployment.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "Source": { + "target": "com.amazonaws.rds#DatabaseArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source production database.

\n

Specify the database that you want to clone. The blue/green deployment creates this database in \n the green environment. You can make updates to the database in the green environment, such as an engine \n version upgrade. When you are ready, you can switch the database in the green environment to be the \n production database.

", + "smithy.api#required": {} + } + }, + "TargetEngineVersion": { + "target": "com.amazonaws.rds#TargetEngineVersion", + "traits": { + "smithy.api#documentation": "

The engine version of the database in the green environment.

\n

Specify the engine version to upgrade to in the green environment.

" + } + }, + "TargetDBParameterGroupName": { + "target": "com.amazonaws.rds#TargetDBParameterGroupName", + "traits": { + "smithy.api#documentation": "

The DB parameter group associated with the DB instance in the green environment.

\n

To test parameter changes, specify a DB parameter group that is different from the one associated \n with the source DB instance.

" + } + }, + "TargetDBClusterParameterGroupName": { + "target": "com.amazonaws.rds#TargetDBClusterParameterGroupName", + "traits": { + "smithy.api#documentation": "

The DB cluster parameter group associated with the Aurora DB cluster in the green environment.

\n

To test parameter changes, specify a DB cluster parameter group that is different from the one associated \n with the source DB cluster.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

Tags to assign to the blue/green deployment.

" + } + } + } + }, + "com.amazonaws.rds#CreateBlueGreenDeploymentResponse": { + "type": "structure", + "members": { + "BlueGreenDeployment": { + "target": "com.amazonaws.rds#BlueGreenDeployment" + } + } + }, + "com.amazonaws.rds#CreateCustomDBEngineVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateCustomDBEngineVersionMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBEngineVersion" + }, + "errors": [ + { + "target": "com.amazonaws.rds#CustomDBEngineVersionAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#CustomDBEngineVersionQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#Ec2ImagePropertiesNotSupportedFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a custom DB engine version (CEV).

" + } + }, + "com.amazonaws.rds#CreateCustomDBEngineVersionMessage": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#CustomEngineName", + "traits": { + "smithy.api#documentation": "

The database engine to use for your custom engine version (CEV). The only supported value is \n custom-oracle-ee.

", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#CustomEngineVersion", + "traits": { + "smithy.api#documentation": "

The name of your CEV. The name format is 19.customized_string.\n For example, a valid CEV name is 19.my_cev1. This setting is required for RDS\n Custom for Oracle, but optional for Amazon RDS. The combination of Engine\n and EngineVersion is unique per customer per Region.

", + "smithy.api#required": {} + } + }, + "DatabaseInstallationFilesS3BucketName": { + "target": "com.amazonaws.rds#BucketName", + "traits": { + "smithy.api#documentation": "

The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid \n bucket name is my-custom-installation-files.

" + } + }, + "DatabaseInstallationFilesS3Prefix": { + "target": "com.amazonaws.rds#String255", + "traits": { + "smithy.api#documentation": "

The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid \n bucket name is 123456789012/cev1. If this setting isn't specified, no prefix is assumed.

" + } + }, + "ImageId": { + "target": "com.amazonaws.rds#String255", + "traits": { + "smithy.api#documentation": "

The ID of the AMI. An AMI ID is required to create a CEV for RDS Custom for SQL Server.

" + } + }, + "KMSKeyId": { + "target": "com.amazonaws.rds#KmsKeyIdOrArn", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for \n RDS Custom, but optional for Amazon RDS.

\n

If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. \n No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, \n follow the instructions in \n Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service\n Developer Guide.

\n

You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#Description", + "traits": { + "smithy.api#documentation": "

An optional description of your CEV.

" + } + }, + "Manifest": { + "target": "com.amazonaws.rds#CustomDBEngineVersionManifest", + "traits": { + "smithy.api#documentation": "

The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. \n Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which \n they are listed.

\n

The following JSON fields are valid:

\n
\n
MediaImportTemplateVersion
\n
\n

Version of the CEV manifest. The date is in the format YYYY-MM-DD.

\n
\n
databaseInstallationFileNames
\n
\n

Ordered list of installation files for the CEV.

\n
\n
opatchFileNames
\n
\n

Ordered list of OPatch installers used for the Oracle DB engine.

\n
\n
psuRuPatchFileNames
\n
\n

The PSU and RU patches for this CEV.

\n
\n
OtherPatchFileNames
\n
\n

The patches that are not in the list of PSU and RU patches. \n Amazon RDS applies these patches after applying the PSU and RU patches.

\n
\n
\n

For more information, see \n Creating the CEV manifest in the Amazon RDS User Guide.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + } + }, + "com.amazonaws.rds#CreateDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DomainNotFoundFault" + }, + { + "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InsufficientStorageClusterCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSubnetGroupStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.

\n

You can use the ReplicationSourceIdentifier parameter to create an Amazon\n Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or\n PostgreSQL DB instance.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" + } + }, + "com.amazonaws.rds#CreateDBClusterEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBClusterEndpointMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterEndpoint" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterEndpointAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBClusterEndpointQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

\n \n

This action applies only to Aurora DB clusters.

\n " + } + }, + "com.amazonaws.rds#CreateDBClusterEndpointMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is\n stored as a lowercase string.

", + "smithy.api#required": {} + } + }, + "DBClusterEndpointIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

", + "smithy.api#required": {} + } + }, + "EndpointType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of the endpoint, one of: READER, WRITER, ANY.

", + "smithy.api#required": {} + } + }, + "StaticMembers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

List of DB instance identifiers that are part of the custom endpoint group.

" + } + }, + "ExcludedMembers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

List of DB instance identifiers that aren't part of the custom endpoint group.\n All other eligible instances are reachable through the custom endpoint.\n This parameter is relevant only if the list of static members is empty.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

The tags to be assigned to the Amazon RDS resource.

" + } + } + } + }, + "com.amazonaws.rds#CreateDBClusterMessage": { + "type": "structure", + "members": { + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZones", + "traits": { + "smithy.api#documentation": "

A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.

\n

For information on Amazon Web Services Regions and Availability Zones, see \n Choosing the Regions and \n Availability Zones in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automated backups are retained.

\n

Default: 1

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "CharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value that indicates that the DB cluster should be associated with the specified CharacterSet.

\n

Valid for: Aurora DB clusters only

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name for your database of up to 64 alphanumeric characters. If you do not\n provide a name, Amazon RDS doesn't create a database in the DB cluster you are\n creating.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster1\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", + "smithy.api#required": {} + } + }, + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group to associate\n with this DB cluster. If you do not specify a value, then \n the default DB cluster parameter group for the specified DB engine and version is used.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A DB subnet group to associate with this DB cluster.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mydbsubnetgroup\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database engine to be used for this DB cluster.

\n

Valid Values:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine to use.

\n

To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

For information, see MySQL on Amazon RDS Versions in the \n Amazon Aurora User Guide.

\n

\n Aurora PostgreSQL\n

\n

For information, see Amazon Aurora PostgreSQL releases and engine versions in the \n Amazon Aurora User Guide.

\n

\n MySQL\n

\n

For information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.

\n

\n PostgreSQL\n

\n

For information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the instances in the DB cluster accept connections.

\n

\n RDS for MySQL and Aurora MySQL\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

\n

\n RDS for PostgreSQL and Aurora PostgreSQL\n

\n

Default: 5432\n

\n

Valid values: 1150-65535\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the master user for the DB cluster.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value that indicates that the DB cluster should be associated with the specified option group.

\n

DB clusters are associated with a default option group that can't be modified.

" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "ReplicationSourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB\n cluster is created as a read replica.

\n

Valid for: Aurora DB clusters only

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

Tags to assign to the DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB cluster is encrypted.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

When a KMS key isn't specified in KmsKeyId:

\n \n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

\n

If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you\n must set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services\n Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "PreSignedUrl": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another,\n an URL that contains a Signature Version 4 signed request for the\n CreateDBCluster operation to be called in the source Amazon Web Services Region where\n the DB cluster is replicated from. Specify PreSignedUrl only when you are\n performing cross-Region replication from an encrypted DB cluster.

\n

The presigned URL must be a valid request for the CreateDBCluster API\n operation that can run in the source Amazon Web Services Region that contains the encrypted DB\n cluster to copy.

\n

The presigned URL request must contain the following parameter values:

\n \n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n \n

Valid for: Aurora DB clusters only

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + } + }, + "BacktrackWindow": { + "target": "com.amazonaws.rds#LongOptional", + "traits": { + "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n

Default: 0

\n

Constraints:

\n \n

Valid for: Aurora MySQL DB clusters only

" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "EngineMode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB engine mode of the DB cluster, either provisioned, serverless, \n parallelquery, global, or multimaster.

\n

The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, \n and version 2.09 and higher 2.x versions.

\n

The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, \n and global engine mode isn't required for any 2.x versions.

\n

The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.

\n

The serverless engine mode only applies for Aurora Serverless v1 DB clusters.

\n

For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery \n and the multimaster engine modes currently aren't supported.

\n

Limitations and requirements apply to some DB engine modes. For more information, see the \n following sections in the Amazon Aurora User Guide:

\n \n

Valid for: Aurora DB clusters only

" + } + }, + "ScalingConfiguration": { + "target": "com.amazonaws.rds#ScalingConfiguration", + "traits": { + "smithy.api#documentation": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

\n

Valid for: Aurora DB clusters only

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The global cluster ID of an Aurora cluster that becomes the primary cluster\n in the new global database cluster.

\n

Valid for: Aurora DB clusters only

" + } + }, + "EnableHttpEndpoint": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint \n is disabled.

\n

When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.

\n

For more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory directory ID to create the DB cluster in.

\n

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.

\n

For more information, see Kerberos authentication\n in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

Valid for: Aurora DB clusters only

" + } + }, + "EnableGlobalWriteForwarding": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an\n Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.

\n

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the\n primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.

\n

Valid for: Aurora DB clusters only

" + } + }, + "DBClusterInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Valid values: io1\n

\n

When specified, a value for the Iops parameter is required.

\n

Default: io1\n

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, see \n Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.

\n

This setting is required to create a Multi-AZ DB cluster.

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

Valid for: Multi-AZ DB clusters only

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off \n collecting Enhanced Monitoring metrics, specify 0. The default is 0.

\n

If MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. \n An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting \n up and enabling Enhanced Monitoring in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to turn on Performance Insights for the DB cluster.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" + } + }, + "DBSystemId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, + "ManageMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "MasterUserSecretKmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#CreateDBClusterParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBClusterParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBClusterParameterGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB cluster parameter group.

\n

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

\n

A DB cluster parameter group is initially created with the default parameters for the\n database engine used by instances in the DB cluster. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to\n associate it with your DB cluster using ModifyDBCluster.

\n

When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB\n instances in the DB cluster without failover for the new DB cluster parameter group and \n associated settings to take effect.

\n

When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB\n cluster without failover for the new DB cluster parameter group and associated settings to take effect.

\n \n

After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as\n the default parameter group. This allows Amazon RDS to fully complete the create\n action before the DB cluster parameter group is used as the default for a new DB\n cluster. This is especially important for parameters that are critical when creating\n the default database for a DB cluster, such as the character set for the default\n database defined by the character_set_database parameter. You can use\n the Parameter Groups option of the Amazon RDS console or the\n DescribeDBClusterParameters operation to verify that your DB\n cluster parameter group has been created or modified.

\n \n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" + } + }, + "com.amazonaws.rds#CreateDBClusterParameterGroupMessage": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group.

\n

Constraints:

\n \n \n

This value is stored as a lowercase string.

\n ", + "smithy.api#required": {} + } + }, + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster \n parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

\n

\n Aurora MySQL\n

\n

Example: aurora5.6, aurora-mysql5.7, aurora-mysql8.0\n

\n

\n Aurora PostgreSQL\n

\n

Example: aurora-postgresql9.6\n

\n

\n RDS for MySQL\n

\n

Example: mysql8.0\n

\n

\n RDS for PostgreSQL\n

\n

Example: postgres12\n

\n

To list all of the available parameter group families for a DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n

\n

For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine aurora-postgresql\n

\n \n

The output contains duplicates.

\n \n

The following are the valid DB engine values:

\n ", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description for the DB cluster parameter group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

Tags to assign to the DB cluster parameter group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#CreateDBClusterParameterGroupResult": { + "type": "structure", + "members": { + "DBClusterParameterGroup": { + "target": "com.amazonaws.rds#DBClusterParameterGroup" + } + } + }, + "com.amazonaws.rds#CreateDBClusterResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + } + }, + "com.amazonaws.rds#CreateDBClusterSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBClusterSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBClusterSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterSnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a snapshot of a DB cluster.

\n

For more information on Amazon Aurora, see What is Amazon\n Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" + } + }, + "com.amazonaws.rds#CreateDBClusterSnapshotMessage": { + "type": "structure", + "members": { + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster1-snapshot1\n

", + "smithy.api#required": {} + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DB cluster to create a snapshot for. This parameter isn't case-sensitive.

\n

Constraints:

\n \n

Example: my-cluster1\n

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

The tags to be assigned to the DB cluster snapshot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#CreateDBClusterSnapshotResult": { + "type": "structure", + "members": { + "DBClusterSnapshot": { + "target": "com.amazonaws.rds#DBClusterSnapshot" + } + } + }, + "com.amazonaws.rds#CreateDBInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBInstanceMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#AuthorizationNotFoundFault" + }, + { + "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#CertificateNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DomainNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InstanceQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB instance.

\n

The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. \n For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance \n to the cluster.

\n

For more information about creating an RDS DB instance, see \n Creating an Amazon RDS DB instance in the Amazon RDS User Guide.

\n

For more information about creating a DB instance in an Aurora DB cluster, see \n \n Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.

" + } + }, + "com.amazonaws.rds#CreateDBInstanceMessage": { + "type": "structure", + "members": { + "DBName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The meaning of this parameter differs according to the database engine you use.

\n

\n MySQL\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n \n

\n MariaDB\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n \n

\n PostgreSQL\n

\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres \n is created in the DB instance.

\n

Constraints:

\n \n

\n Oracle\n

\n

The Oracle System ID (SID) of the created DB instance.\n If you specify null, the default value ORCL is used.\n You can't specify the string NULL, or any other reserved word, for DBName.

\n

Default: ORCL\n

\n

Constraints:

\n \n

\n Amazon RDS Custom for Oracle\n

\n

The Oracle System ID (SID) of the created RDS Custom DB instance.\n If you don't specify a value, the default value is ORCL.

\n

Default: ORCL\n

\n

Constraints:

\n \n

\n Amazon RDS Custom for SQL Server\n

\n

Not applicable. Must be null.

\n

\n SQL Server\n

\n

Not applicable. Must be null.

\n

\n Amazon Aurora MySQL\n

\n

The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created \n in the DB cluster.

\n

Constraints:

\n \n

\n Amazon Aurora PostgreSQL\n

\n

The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, \n a database named postgres is created in the DB cluster.

\n

Constraints:

\n " + } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mydbinstance\n

", + "smithy.api#required": {} + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate for the DB instance.

\n

Type: Integer

\n

\n Amazon Aurora\n

\n

Not applicable. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.

\n

\n Amazon RDS Custom\n

\n

Constraints to the amount of storage for each storage type are the following:

\n \n

\n MySQL\n

\n

Constraints to the amount of storage for each storage type are the following:

\n \n

\n MariaDB\n

\n

Constraints to the amount of storage for each storage type are the following:

\n \n

\n PostgreSQL\n

\n

Constraints to the amount of storage for each storage type are the following:

\n \n

\n Oracle\n

\n

Constraints to the amount of storage for each storage type are the following:

\n \n

\n SQL Server\n

\n

Constraints to the amount of storage for each storage type are the following:

\n " + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of the DB instance, for example db.m5.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes, and availability for your engine, see\n DB instance \n classes in the Amazon RDS User Guide or \n Aurora \n DB instance classes in the Amazon Aurora User Guide.

", + "smithy.api#required": {} + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database engine to be used for this instance.

\n

Not every database engine is available for every Amazon Web Services Region.

\n

Valid Values:

\n ", + "smithy.api#required": {} + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name for the master user.

\n

\n Amazon Aurora\n

\n

Not applicable. The name for the master user is managed by the DB cluster.

\n

\n Amazon RDS\n

\n

Constraints:

\n " + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

\n Amazon Aurora\n

\n

Not applicable. The password for the master user is managed by the DB\n cluster.

\n

Constraints: Can't be specified if ManageMasterUserPassword is turned on.

\n

\n MariaDB\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Microsoft SQL Server\n

\n

Constraints: Must contain from 8 to 128 characters.

\n

\n MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Oracle\n

\n

Constraints: Must contain from 8 to 30 characters.

\n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

" + } + }, + "DBSecurityGroups": { + "target": "com.amazonaws.rds#DBSecurityGroupNameList", + "traits": { + "smithy.api#documentation": "

A list of DB security groups to associate with this DB instance.

\n

This setting applies to the legacy EC2-Classic platform, which is no longer used to create \n new DB instances. Use the VpcSecurityGroupIds setting instead.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to associate with this DB instance.

\n

\n Amazon Aurora\n

\n

Not applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone (AZ) where the database will be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.

\n

\n Amazon Aurora\n

\n

Each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these \n Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

Example: us-east-1d\n

\n

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A DB subnet group to associate with this DB instance.

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mydbsubnetgroup\n

" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The time range each week during which system maintenance can occur, \n in Universal Coordinated Time (UTC). \n For more information, see Amazon RDS Maintenance Window.

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week.

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

" + } + }, + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then \n the default DB parameter group for the specified DB engine and version is used.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n " + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automated backups are retained. Setting this parameter to a positive number enables \n backups. Setting this parameter to 0 disables automated backups.

\n

\n Amazon Aurora\n

\n

Not applicable. The retention period for automated backups is managed by the DB cluster.

\n

Default: 1

\n

Constraints:

\n " + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.

\n

\n Amazon Aurora\n

\n

Not applicable. The daily time range for creating automated backups is managed by\n the DB cluster.

\n

Constraints:

\n " + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

\n MySQL\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

\n

Type: Integer

\n

\n MariaDB\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

\n

Type: Integer

\n

\n PostgreSQL\n

\n

Default: 5432\n

\n

Valid values: 1150-65535\n

\n

Type: Integer

\n

\n Oracle\n

\n

Default: 1521\n

\n

Valid values: 1150-65535\n

\n

\n SQL Server\n

\n

Default: 1433\n

\n

Valid values: 1150-65535 except 1234, 1434,\n 3260, 3343, 3389, 47001, and\n 49152-49156.

\n

\n Amazon Aurora\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

\n

Type: Integer

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set \n the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. DB instance Availability Zones (AZs) are managed by the DB cluster.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine to use.

\n

For a list of valid engine versions, use the DescribeDBEngineVersions\n operation.

\n

The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.

\n

\n Amazon Aurora\n

\n

Not applicable. The version number of the database engine to be used by the DB\n instance is managed by the DB cluster.

\n

\n Amazon RDS Custom for Oracle\n

\n

A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV \n name has the following format: 19.customized_string. A valid CEV name is \n 19.my_cev1. For more information, see \n Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.

\n

\n Amazon RDS Custom for SQL Server\n

\n

See RDS Custom for SQL Server general requirements \n in the Amazon RDS User Guide.

\n

\n MariaDB\n

\n

For information, see MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.

\n

\n Microsoft SQL Server\n

\n

For information, see Microsoft SQL Server Versions on Amazon RDS in the \n Amazon RDS User Guide.

\n

\n MySQL\n

\n

For information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.

\n

\n Oracle\n

\n

For information, see Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.

\n

\n PostgreSQL\n

\n

For information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to \n false.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

License model information for this DB instance.

\n

Valid values: license-included | bring-your-own-license | general-public-license\n

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable.

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.\n For information about valid IOPS values, see \n Amazon RDS DB instance storage \n in the Amazon RDS User Guide.

\n

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 \n of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 \n of the storage amount for the DB instance.

\n

\n Amazon Aurora\n

\n

Not applicable. Storage is managed by the DB cluster.

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value that indicates that the DB instance should be associated with the specified option group.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group. Also, that option group can't be removed from a DB instance after it is \n associated with a DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable.

" + } + }, + "CharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

For supported engines, this value indicates that the DB instance should be associated with the \n specified CharacterSet.

\n

This setting doesn't apply to RDS Custom. However, if you need to change the character set, \n you can change it on the database itself.

\n

\n Amazon Aurora\n

\n

Not applicable. The character set is managed by\n the DB cluster. For more information, see CreateDBCluster.

" + } + }, + "NcharCharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the NCHAR character set for the Oracle DB instance.

\n

This parameter doesn't apply to RDS Custom.

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from \n within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n " + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

Tags to assign to the DB instance.

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DB cluster that the instance will belong to.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

\n

\n Amazon Aurora\n

\n

Not applicable. Storage is managed by the DB cluster.

" + } + }, + "TdeCredentialArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable.

" + } + }, + "TdeCredentialPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

\n

For RDS Custom instances, either set this parameter to true or leave it unset. \n If you set this parameter to false, RDS reports an error.

\n

\n Amazon Aurora\n

\n

Not applicable. The encryption for DB instances is managed by the DB cluster.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

\n Amazon Aurora\n

\n

Not applicable. The Amazon Web Services KMS key identifier is managed by\n the DB cluster. For more information, see CreateDBCluster.

\n

If StorageEncrypted is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS uses your default KMS key. There is a \n default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.

\n

\n Amazon RDS Custom\n

\n

A KMS key is required for RDS Custom instances. For most RDS engines, if you leave this parameter empty \n while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom \n doesn't use the default key when this parameter is empty. You must explicitly specify a key.

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. The domain is managed by the DB cluster.

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

\n

\n Amazon Aurora\n

\n

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting.

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for \n the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.

\n

If MonitoringRoleArn is specified, then you must set MonitoringInterval\n to a value other than 0.

\n

This setting doesn't apply to RDS Custom.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. The domain is managed by the DB cluster.

" + } + }, + "PromotionTier": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

\n

This setting doesn't apply to RDS Custom.

\n

Default: 1

\n

Valid Values: 0 - 15

" + } + }, + "Timezone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The time zone of the DB instance. \n The time zone parameter is currently supported only by\n Microsoft SQL Server.

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

For more information, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.

" + } + }, + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the DB instance. For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine. For more information, see \n \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

\n Amazon Aurora\n

\n

Not applicable. CloudWatch Logs exports are managed by the DB cluster.

\n

\n RDS Custom\n

\n

Not applicable.

\n

\n MariaDB\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Microsoft SQL Server\n

\n

Possible values are agent and error.

\n

\n MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Oracle\n

\n

Possible values are alert, audit, listener, trace, and\n oemagent.

\n

\n PostgreSQL\n

\n

Possible values are postgresql and upgrade.

" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

\n

\n Amazon Aurora\n

\n

Not applicable. You can enable or disable deletion protection for the DB cluster. \n For more information, see CreateDBCluster. DB instances in a DB \n cluster can be deleted even when deletion protection is enabled for the DB cluster.

" + } + }, + "MaxAllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. Storage is managed by the DB cluster.

" + } + }, + "EnableCustomerOwnedIp": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + } + }, + "CustomIamInstanceProfile": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n \n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" + } + }, + "BackupTarget": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies where automated backups and manual snapshots are stored.

\n

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" + } + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting applies only to the gp3 storage type.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + } + }, + "ManageMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

\n " + } + }, + "MasterUserSecretKmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" + } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the CA certificate identifier to use for the DB instanceā€™s server certificate.

\n

This setting doesn't apply to RDS Custom.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#CreateDBInstanceReadReplica": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBInstanceReadReplicaMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBInstanceReadReplicaResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotAllowedFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DomainNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InstanceQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSubnetGroupFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB instance that acts as a read replica for an existing source DB\n instance. You can create a read replica for a DB instance running MySQL, MariaDB,\n Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read\n Replicas in the Amazon RDS User Guide.

\n

Amazon Aurora doesn't support this operation. Call the CreateDBInstance\n operation to create a DB instance for an Aurora DB cluster.

\n

All read replica DB instances are created with backups disabled. All other DB\n instance attributes (including DB security groups and DB parameter groups) are inherited\n from the source DB instance, except as specified.

\n \n

Your source DB instance must have backup retention enabled.

\n " + } + }, + "com.amazonaws.rds#CreateDBInstanceReadReplicaMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance identifier of the read replica. This identifier is the unique key\n that identifies a DB instance. This parameter is stored as a lowercase string.

", + "smithy.api#required": {} + } + }, + "SourceDBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DB instance that will act as the source for the read replica.\n Each DB instance can have up to five read replicas.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of the read replica, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.

\n

Default: Inherits from the source DB instance.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone (AZ) where the read replica will be created.

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

Example: us-east-1d\n

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number that the DB instance uses for connections.

\n

Default: Inherits from the source DB instance

\n

Valid Values: 1150-65535\n

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the read replica is in a Multi-AZ deployment.

\n

You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of\n your replica in another Availability Zone for failover support for the replica. Creating\n your read replica as a Multi-AZ DB instance is independent of whether the source\n database is a Multi-AZ DB instance.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically to the\n read replica during the maintenance window.

\n

This setting doesn't apply to RDS Custom.

\n

Default: Inherits from the source DB instance

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.

\n \n

For SQL Server, you must use the option group associated with the source\n instance.

\n \n

This setting doesn't apply to RDS Custom.

" + } + }, + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance.

\n

If you do not specify a value for DBParameterGroupName, then Amazon RDS\n uses the DBParameterGroup of source DB instance for a same Region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross-Region read replica.

\n

Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. \n It isn't supported for RDS Custom.

\n

Constraints:

\n " + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

\n

Constraints:

\n \n

Example: mydbsubnetgroup\n

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to associate with the read replica.

\n

This setting doesn't apply to RDS Custom.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type to be associated with the read replica.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the read replica to snapshots of\n the read replica. By default, tags are not copied.

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are\n collected for the read replica. To disable collecting Enhanced Monitoring metrics,\n specify 0. The default is 0.

\n

If MonitoringRoleArn is specified, then you must also set MonitoringInterval\n to a value other than 0.

\n

This setting doesn't apply to RDS Custom.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

\n

If MonitoringInterval is set to a value other than 0, then you must \n supply a MonitoringRoleArn value.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted read replica.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you create an encrypted read replica in the same Amazon Web Services Region as the source DB\n instance, then do not specify a value for this parameter. A read replica in the same Amazon Web Services Region\n is always encrypted with the same KMS key as the source DB instance.

\n

If you create an encrypted read replica in a different Amazon Web Services Region, then you must\n specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to\n the Amazon Web Services Region that they are created in, and you can't use KMS keys from one\n Amazon Web Services Region in another Amazon Web Services Region.

\n

You can't create an encrypted read replica from an unencrypted DB instance.

\n

This setting doesn't apply to RDS Custom, which uses the same KMS key as the primary \n replica.

" + } + }, + "PreSignedUrl": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or\n from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4\n signed request for the CreateDBInstanceReadReplica API operation in the\n source Amazon Web Services Region that contains the source DB instance.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions and \n China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.

\n

You must specify this parameter when you create an encrypted read replica from\n another Amazon Web Services Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same Amazon Web Services Region.

\n

The presigned URL must be a valid request for the\n CreateDBInstanceReadReplica API operation that can run in the\n source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL\n request must contain the following parameter values:

\n \n

To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n

\n SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server \n doesn't support cross-Region read replicas.

\n \n

This setting doesn't apply to RDS Custom.

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the read replica.

\n

For more information, see Using\n Amazon Performance Insights in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of logs that the new DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing\n Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "UseDefaultProcessorFeatures": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "ReplicaMode": { + "target": "com.amazonaws.rds#ReplicaMode", + "traits": { + "smithy.api#documentation": "

The open mode of the replica database: mounted or read-only.

\n \n

This parameter is only supported for Oracle DB instances.

\n \n

Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for\n mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active\n Data Guard to transmit information to the mounted replica. Because it doesn't accept\n user connections, a mounted replica can't serve a read-only workload.

\n

You can create a combination of mounted and read-only DB replicas for the same primary DB instance.\n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.

\n

For RDS Custom, you must specify this parameter and set it to mounted. The value won't be set by default. \n After replica creation, you can manage the open mode manually.

" + } + }, + "MaxAllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

" + } + }, + "CustomIamInstanceProfile": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n \n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" + } + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for read replica. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the storage throughput value for the read replica.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + } + }, + "EnableCustomerOwnedIp": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts read replica.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the read replica from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + } + } + } + }, + "com.amazonaws.rds#CreateDBInstanceReadReplicaResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + } + }, + "com.amazonaws.rds#CreateDBInstanceResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + } + }, + "com.amazonaws.rds#CreateDBParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBParameterGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB parameter group.

\n

A DB parameter group is initially created with the default parameters for the\n database engine used by the DB instance. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBParameterGroup. Once you've created a DB parameter group, you need to\n associate it with your DB instance using ModifyDBInstance. When you associate\n a new DB parameter group with a running DB instance, you need to reboot the DB\n instance without failover for the new DB parameter group and associated settings to take effect.

\n

This command doesn't apply to RDS Custom.

\n \n

After you create a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.

\n " + } + }, + "com.amazonaws.rds#CreateDBParameterGroupMessage": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n \n \n

This value is stored as a lowercase string.

\n ", + "smithy.api#required": {} + } + }, + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

\n

To list all of the available parameter group families for a DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n

\n

For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

\n

\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine mysql\n

\n \n

The output contains duplicates.

\n \n

The following are the valid DB engine values:

\n ", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description for the DB parameter group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

Tags to assign to the DB parameter group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#CreateDBParameterGroupResult": { + "type": "structure", + "members": { + "DBParameterGroup": { + "target": "com.amazonaws.rds#DBParameterGroup" + } + } + }, + "com.amazonaws.rds#CreateDBProxy": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBProxyRequest" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBProxyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBProxyQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB proxy.

" + } + }, + "com.amazonaws.rds#CreateDBProxyEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBProxyEndpointRequest" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBProxyEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyEndpointAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBProxyEndpointQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters.\n You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use\n DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC.

" + } + }, + "com.amazonaws.rds#CreateDBProxyEndpointRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#DBProxyName", + "traits": { + "smithy.api#documentation": "

The name of the DB proxy associated with the DB proxy endpoint that you create.

", + "smithy.api#required": {} + } + }, + "DBProxyEndpointName": { + "target": "com.amazonaws.rds#DBProxyEndpointName", + "traits": { + "smithy.api#documentation": "

The name of the DB proxy endpoint to create.

", + "smithy.api#required": {} + } + }, + "VpcSubnetIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a\n different set of subnet IDs than for the original DB proxy.

", + "smithy.api#required": {} + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The VPC security group IDs for the DB proxy endpoint that you create. You can\n specify a different set of security group IDs than for the original DB proxy.\n The default is the default security group for the VPC.

" + } + }, + "TargetRole": { + "target": "com.amazonaws.rds#DBProxyEndpointTargetRole", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB proxy endpoint can be used for read/write\n or read-only operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server \n support is READ_WRITE.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + } + }, + "com.amazonaws.rds#CreateDBProxyEndpointResponse": { + "type": "structure", + "members": { + "DBProxyEndpoint": { + "target": "com.amazonaws.rds#DBProxyEndpoint", + "traits": { + "smithy.api#documentation": "

The DBProxyEndpoint object that is created by the API operation.\n The DB proxy endpoint that you create might provide capabilities such as read/write\n or read-only operations, or using a different VPC than the proxy's default VPC.

" + } + } + } + }, + "com.amazonaws.rds#CreateDBProxyRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

", + "smithy.api#required": {} + } + }, + "EngineFamily": { + "target": "com.amazonaws.rds#EngineFamily", + "traits": { + "smithy.api#documentation": "

The kinds of databases that the proxy can connect to. \n This value determines which database network protocol the proxy recognizes when it interprets\n network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL. \n For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL. For RDS for Microsoft SQL Server, specify \n SQLSERVER.

", + "smithy.api#required": {} + } + }, + "Auth": { + "target": "com.amazonaws.rds#UserAuthConfigList", + "traits": { + "smithy.api#documentation": "

The authorization mechanism that the proxy uses.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

", + "smithy.api#required": {} + } + }, + "VpcSubnetIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

One or more VPC subnet IDs to associate with the new proxy.

", + "smithy.api#required": {} + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

One or more VPC security group IDs to associate with the new proxy.

" + } + }, + "RequireTLS": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.\n By enabling this setting, you can enforce encrypted TLS connections to the proxy.

" + } + }, + "IdleClientTimeout": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this\n value higher or lower than the connection timeout limit for the associated database.

" + } + }, + "DebugLogging": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

" + } + } + } + }, + "com.amazonaws.rds#CreateDBProxyResponse": { + "type": "structure", + "members": { + "DBProxy": { + "target": "com.amazonaws.rds#DBProxy", + "traits": { + "smithy.api#documentation": "

The DBProxy structure corresponding to the new proxy.

" + } + } + } + }, + "com.amazonaws.rds#CreateDBSecurityGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBSecurityGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBSecurityGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSecurityGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBSecurityGroupNotSupportedFault" + }, + { + "target": "com.amazonaws.rds#DBSecurityGroupQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB security group. DB security groups control access to a DB instance.

\n

A DB security group controls access to EC2-Classic DB instances that are not in a VPC.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring ā€“ \n Hereā€™s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n " + } + }, + "com.amazonaws.rds#CreateDBSecurityGroupMessage": { + "type": "structure", + "members": { + "DBSecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name for the DB security group. This value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mysecuritygroup\n

", + "smithy.api#required": {} + } + }, + "DBSecurityGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description for the DB security group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

Tags to assign to the DB security group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#CreateDBSecurityGroupResult": { + "type": "structure", + "members": { + "DBSecurityGroup": { + "target": "com.amazonaws.rds#DBSecurityGroup" + } + } + }, + "com.amazonaws.rds#CreateDBSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a snapshot of a DB instance. The source DB instance must be in the available or\n storage-optimization state.

" + } + }, + "com.amazonaws.rds#CreateDBSnapshotMessage": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the DB snapshot.

\n

Constraints:

\n \n

Example: my-snapshot-id\n

", + "smithy.api#required": {} + } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DB instance that you want to create the snapshot of.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#CreateDBSnapshotResult": { + "type": "structure", + "members": { + "DBSnapshot": { + "target": "com.amazonaws.rds#DBSnapshot" + } + } + }, + "com.amazonaws.rds#CreateDBSubnetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateDBSubnetGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateDBSubnetGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSubnetGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

" + } + }, + "com.amazonaws.rds#CreateDBSubnetGroupMessage": { + "type": "structure", + "members": { + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name for the DB subnet group. This value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mydbsubnetgroup\n

", + "smithy.api#required": {} + } + }, + "DBSubnetGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description for the DB subnet group.

", + "smithy.api#required": {} + } + }, + "SubnetIds": { + "target": "com.amazonaws.rds#SubnetIdentifierList", + "traits": { + "smithy.api#documentation": "

The EC2 Subnet IDs for the DB subnet group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

Tags to assign to the DB subnet group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#CreateDBSubnetGroupResult": { + "type": "structure", + "members": { + "DBSubnetGroup": { + "target": "com.amazonaws.rds#DBSubnetGroup" + } + } + }, + "com.amazonaws.rds#CreateEventSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateEventSubscriptionMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateEventSubscriptionResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#EventSubscriptionQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#SNSInvalidTopicFault" + }, + { + "target": "com.amazonaws.rds#SNSNoAuthorizationFault" + }, + { + "target": "com.amazonaws.rds#SNSTopicArnNotFoundFault" + }, + { + "target": "com.amazonaws.rds#SourceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#SubscriptionAlreadyExistFault" + }, + { + "target": "com.amazonaws.rds#SubscriptionCategoryNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an RDS event notification subscription. This operation requires a topic Amazon\n Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API.\n To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the\n topic. The ARN is displayed in the SNS console.

\n

You can specify the type of source (SourceType) that you want to be\n notified of and provide a list of RDS sources (SourceIds) that triggers the\n events. You can also provide a list of event categories (EventCategories)\n for events that you want to be notified of. For example, you can specify\n SourceType = db-instance, SourceIds =\n mydbinstance1, mydbinstance2 and\n EventCategories = Availability,\n Backup.

\n

If you specify both the SourceType and SourceIds, such as SourceType = db-instance\n and SourceIds = myDBInstance1, you are notified of all the db-instance events for\n the specified source. If you specify a SourceType but do not specify SourceIds,\n you receive notice of the events for that source type for all your RDS sources. If you\n don't specify either the SourceType or the SourceIds, you are notified of events\n generated from all RDS sources belonging to your customer account.

\n

For more information about subscribing to an event for RDS DB engines, see \n \n Subscribing to Amazon RDS event notification in the Amazon RDS User Guide.

\n

For more information about subscribing to an event for Aurora DB engines, see \n \n Subscribing to Amazon RDS event notification in the Amazon Aurora User Guide.

" + } + }, + "com.amazonaws.rds#CreateEventSubscriptionMessage": { + "type": "structure", + "members": { + "SubscriptionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the subscription.

\n

Constraints: The name must be less than 255 characters.

", + "smithy.api#required": {} + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

", + "smithy.api#required": {} + } + }, + "SourceType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of source that is generating the events. For example, if you want to be\n notified of events generated by a DB instance, you set this parameter to\n db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are\n returned.

\n

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n

" + } + }, + "EventCategories": { + "target": "com.amazonaws.rds#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

A list of event categories for a particular source type (SourceType)\n that you want to subscribe to. You can see a list of the categories for a given source type in the \"Amazon RDS event categories and event messages\" section of the \n Amazon RDS User Guide\n or the\n \n Amazon Aurora User Guide\n .\n You can also see this list by using the DescribeEventCategories operation.

" + } + }, + "SourceIds": { + "target": "com.amazonaws.rds#SourceIdsList", + "traits": { + "smithy.api#documentation": "

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. \n An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.

\n

Constraints:

\n " + } + }, + "Enabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#CreateEventSubscriptionResult": { + "type": "structure", + "members": { + "EventSubscription": { + "target": "com.amazonaws.rds#EventSubscription" + } + } + }, + "com.amazonaws.rds#CreateGlobalCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateGlobalClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateGlobalClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#GlobalClusterAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#GlobalClusterQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Aurora global database\n spread across multiple Amazon Web Services Regions. The global database\n contains a single primary cluster with read-write capability,\n and a read-only secondary cluster that receives\n data from the primary cluster through high-speed replication\n performed by the Aurora storage subsystem.

\n

You can create a global database that is initially empty, and then\n add a primary cluster and a secondary cluster to it.\n Or you can specify an existing Aurora cluster during the create operation,\n and this cluster becomes the primary cluster of the global database.

\n \n

This action applies only to Aurora DB clusters.

\n " + } + }, + "com.amazonaws.rds#CreateGlobalClusterMessage": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The cluster identifier of the new global database cluster.

" + } + }, + "SourceDBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) to use as the primary cluster of the global database.\n This parameter is optional.

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database engine to be used for this DB cluster.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The engine version of the Aurora global database.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

The deletion protection setting for the new global database.\n The global database can't be deleted when deletion protection is enabled.

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name for your database of up to 64 alphanumeric characters. If you do not provide\n a name, Amazon Aurora will not create a database in the global database cluster you are\n creating.

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

The storage encryption setting for the new global database cluster.

" + } + } + } + }, + "com.amazonaws.rds#CreateGlobalClusterResult": { + "type": "structure", + "members": { + "GlobalCluster": { + "target": "com.amazonaws.rds#GlobalCluster" + } + } + }, + "com.amazonaws.rds#CreateOptionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#CreateOptionGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#CreateOptionGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#OptionGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#OptionGroupQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new option group. You can create up to 20 option groups.

\n

This command doesn't apply to RDS Custom.

" + } + }, + "com.amazonaws.rds#CreateOptionGroupMessage": { + "type": "structure", + "members": { + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the option group to be created.

\n

Constraints:

\n \n

Example: myoptiongroup\n

", + "smithy.api#required": {} + } + }, + "EngineName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the engine that this option group should be associated with.

\n

Valid Values:

\n ", + "smithy.api#required": {} + } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the major version of the engine that this option group should be associated with.

", + "smithy.api#required": {} + } + }, + "OptionGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description of the option group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

Tags to assign to the option group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#CreateOptionGroupResult": { + "type": "structure", + "members": { + "OptionGroup": { + "target": "com.amazonaws.rds#OptionGroup" + } + } + }, + "com.amazonaws.rds#CustomAvailabilityZoneNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CustomAvailabilityZoneNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n CustomAvailabilityZoneId doesn't refer to an existing custom\n Availability Zone identifier.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#CustomDBEngineVersionAMI": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value that indicates the ID of the AMI.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value that indicates the status of a custom engine version (CEV).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A value that indicates the AMI information.

" + } + }, + "com.amazonaws.rds#CustomDBEngineVersionAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CustomDBEngineVersionAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A CEV with the specified name already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#CustomDBEngineVersionManifest": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 51000 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.rds#CustomDBEngineVersionNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CustomDBEngineVersionNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified CEV was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#CustomDBEngineVersionQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CustomDBEngineVersionQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You have exceeded your CEV quota.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#CustomEngineName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 35 + }, + "smithy.api#pattern": "^[A-Za-z0-9-]{1,35}$" + } + }, + "com.amazonaws.rds#CustomEngineVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60 + }, + "smithy.api#pattern": "^[a-z0-9_.-]{1,60}$" + } + }, + "com.amazonaws.rds#CustomEngineVersionStatus": { + "type": "enum", + "members": { + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "inactive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inactive" + } + }, + "inactive_except_restore": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inactive-except-restore" + } + } + } + }, + "com.amazonaws.rds#DBCluster": { + "type": "structure", + "members": { + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). \n For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically\n adjusts as needed.

" + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZones", + "traits": { + "smithy.api#documentation": "

Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the number of days for which automatic DB snapshots are retained.

" + } + }, + "CharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If present, specifies the name of the character set that this cluster is associated with.

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

" + } + }, + "DBClusterParameterGroup": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the DB cluster parameter group for the DB cluster.

" + } + }, + "DBSubnetGroup": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the current state of this DB cluster.

" + } + }, + "AutomaticRestartTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time when a stopped DB cluster is restarted automatically.

" + } + }, + "PercentProgress": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the progress of the operation as a percentage.

" + } + }, + "EarliestRestorableTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The earliest time to which a database can be restored with point-in-time\n restore.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the connection endpoint for the primary instance of the DB cluster.

" + } + }, + "ReaderEndpoint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances \n connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections \n to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. \n This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

\n

If a failover occurs, and the Aurora Replica that you are connected to is promoted \n to be the primary instance, your connection is dropped. To \n continue sending your read workload to other Aurora Replicas in the cluster,\n you can then reconnect to the reader endpoint.

" + } + }, + "CustomEndpoints": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

Identifies all custom endpoints associated with the cluster.

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB cluster has instances in multiple Availability Zones.

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database engine to be used for this DB cluster.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Indicates the database engine version.

" + } + }, + "LatestRestorableTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Specifies the latest time to which a database can be restored with point-in-time restore.

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the port that the database engine is listening on.

" + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Contains the master username for the DB cluster.

" + } + }, + "DBClusterOptionGroupMemberships": { + "target": "com.amazonaws.rds#DBClusterOptionGroupMemberships", + "traits": { + "smithy.api#documentation": "

Provides the list of option group memberships for this DB cluster.

" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.

" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

" + } + }, + "ReplicationSourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Contains the identifier of the source DB cluster if this DB cluster is a read\n replica.

" + } + }, + "ReadReplicaIdentifiers": { + "target": "com.amazonaws.rds#ReadReplicaIdentifierList", + "traits": { + "smithy.api#documentation": "

Contains one or more identifiers of the read replicas associated with this DB\n cluster.

" + } + }, + "DBClusterMembers": { + "target": "com.amazonaws.rds#DBClusterMemberList", + "traits": { + "smithy.api#documentation": "

Provides the list of instances that make up the DB cluster.

" + } + }, + "VpcSecurityGroups": { + "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", + "traits": { + "smithy.api#documentation": "

Provides a list of VPC security groups that the DB cluster belongs to.

" + } + }, + "HostedZoneId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the DB cluster is encrypted.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "DbClusterResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever \n the KMS key for the DB cluster is accessed.

" + } + }, + "DBClusterArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB cluster.

" + } + }, + "AssociatedRoles": { + "target": "com.amazonaws.rds#DBClusterRoles", + "traits": { + "smithy.api#documentation": "

Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. \n IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services\n on your behalf.

" + } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" + } + }, + "CloneGroupId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Identifies the clone group to which the DB cluster is associated.

" + } + }, + "ClusterCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

" + } + }, + "EarliestBacktrackTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The earliest time to which a DB cluster can be backtracked.

" + } + }, + "BacktrackWindow": { + "target": "com.amazonaws.rds#LongOptional", + "traits": { + "smithy.api#documentation": "

The target backtrack window, in seconds. If this value is set to 0, backtracking is\n disabled for the DB cluster. Otherwise, backtracking is enabled.

" + } + }, + "BacktrackConsumedChangeRecords": { + "target": "com.amazonaws.rds#LongOptional", + "traits": { + "smithy.api#documentation": "

The number of change records stored for Backtrack.

" + } + }, + "EnabledCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

A list of log types that this DB cluster is configured to export to CloudWatch Logs.

\n

Log types vary by DB engine. For information about the log types for each DB engine, see\n Amazon RDS Database Log Files in the Amazon Aurora User Guide.\n

" + } + }, + "Capacity": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) \n when the cluster is paused.

\n

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.

" + } + }, + "EngineMode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB engine mode of the DB cluster, either provisioned, serverless,\n parallelquery, global, or multimaster.

\n

For more information, see \n CreateDBCluster.

" + } + }, + "ScalingConfigurationInfo": { + "target": "com.amazonaws.rds#ScalingConfigurationInfo" + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates if the DB cluster has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.

" + } + }, + "HttpEndpointEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.

\n

When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.

\n

For more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.

" + } + }, + "ActivityStreamMode": { + "target": "com.amazonaws.rds#ActivityStreamMode", + "traits": { + "smithy.api#documentation": "

The mode of the database activity stream.\n Database events such as a change or access generate an activity stream event.\n The database session can handle these events either synchronously or asynchronously.

" + } + }, + "ActivityStreamStatus": { + "target": "com.amazonaws.rds#ActivityStreamStatus", + "traits": { + "smithy.api#documentation": "

The status of the database activity stream.

" + } + }, + "ActivityStreamKmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "ActivityStreamKinesisStreamName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Kinesis data stream used for the database activity stream.

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

" + } + }, + "CrossAccountClone": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

" + } + }, + "DomainMemberships": { + "target": "com.amazonaws.rds#DomainMembershipList", + "traits": { + "smithy.api#documentation": "

The Active Directory Domain membership records associated with the DB cluster.

" + } + }, + "TagList": { + "target": "com.amazonaws.rds#TagList" + }, + "GlobalWriteForwardingStatus": { + "target": "com.amazonaws.rds#WriteForwardingStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether a secondary cluster in an Aurora global database has\n write forwarding enabled, not enabled, or is in the process of enabling it.

" + } + }, + "GlobalWriteForwardingRequested": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether you have requested to enable write forwarding for a secondary cluster\n in an Aurora global database. Because write forwarding takes time to enable, check the\n value of GlobalWriteForwardingStatus to confirm that the request has completed\n before using the write forwarding feature for this cluster.

" + } + }, + "PendingModifiedValues": { + "target": "com.amazonaws.rds#ClusterPendingModifiedValues", + "traits": { + "smithy.api#documentation": "

A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. \n Specific changes are identified by subelements.

" + } + }, + "DBClusterInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the compute and memory capacity class of the DB instance.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type associated with the DB cluster.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The Provisioned IOPS (I/O operations per second) value.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies the accessibility options for the DB instance.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private \n IP address from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates that minor version patches are applied automatically.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "PerformanceInsightsEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

True if Performance Insights is enabled for the DB cluster, and otherwise false.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

This setting is only for non-Aurora Multi-AZ DB clusters.

" + } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfigurationInfo" + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

This setting is only for Aurora DB clusters.

" + } + }, + "DBSystemId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + }, + "MasterUserSecret": { + "target": "com.amazonaws.rds#MasterUserSecret", + "traits": { + "smithy.api#documentation": "

Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.

\n

For an Amazon Aurora DB cluster, this data type is used as a response element in the operations \n CreateDBCluster, DeleteDBCluster, DescribeDBClusters, \n FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, \n RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, \n RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.

\n

For a Multi-AZ DB cluster, this data type is used as a response element in the operations \n CreateDBCluster, DeleteDBCluster, DescribeDBClusters, \n FailoverDBCluster, ModifyDBCluster, RebootDBCluster, \n RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + } + }, + "com.amazonaws.rds#DBClusterAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The user already has a DB cluster with the given identifier.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBClusterBacktrack": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

" + } + }, + "BacktrackIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Contains the backtrack identifier.

" + } + }, + "BacktrackTo": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the time to which the DB cluster was backtracked.

" + } + }, + "BacktrackedFrom": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the time from which the DB cluster was backtracked.

" + } + }, + "BacktrackRequestCreationTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the time at which the backtrack was requested.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the backtrack. This property returns one of the following\n values:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the DescribeDBClusterBacktracks action.

" + } + }, + "com.amazonaws.rds#DBClusterBacktrackList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterBacktrack", + "traits": { + "smithy.api#xmlName": "DBClusterBacktrack" + } + } + }, + "com.amazonaws.rds#DBClusterBacktrackMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a later DescribeDBClusterBacktracks request.

" + } + }, + "DBClusterBacktracks": { + "target": "com.amazonaws.rds#DBClusterBacktrackList", + "traits": { + "smithy.api#documentation": "

Contains a list of backtracks for the user.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBClusterBacktracks action.

" + } + }, + "com.amazonaws.rds#DBClusterBacktrackNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterBacktrackNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n BacktrackIdentifier doesn't refer to an existing backtrack.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBClusterCapacityInfo": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A user-supplied DB cluster identifier. This identifier is the unique key that\n identifies a DB cluster.

" + } + }, + "PendingCapacity": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

A value that specifies the capacity that the DB cluster scales to next.

" + } + }, + "CurrentCapacity": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The current capacity of the DB cluster.

" + } + }, + "SecondsBeforeTimeout": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.

" + } + }, + "TimeoutAction": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The timeout action of a call to ModifyCurrentDBClusterCapacity, either \n ForceApplyCapacityChange or RollbackCapacityChange.

" + } + } + } + }, + "com.amazonaws.rds#DBClusterEndpoint": { + "type": "structure", + "members": { + "DBClusterEndpointIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier associated with the endpoint. This parameter is stored as a lowercase string.

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is\n stored as a lowercase string.

" + } + }, + "DBClusterEndpointResourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DNS address of the endpoint.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster,\n such as a writer endpoint for a read-only secondary cluster in a global database.

" + } + }, + "EndpointType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of the endpoint. One of: READER, WRITER, CUSTOM.

" + } + }, + "CustomEndpointType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type associated with a custom endpoint. One of: READER,\n WRITER, ANY.

" + } + }, + "StaticMembers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

List of DB instance identifiers that are part of the custom endpoint group.

" + } + }, + "ExcludedMembers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

List of DB instance identifiers that aren't part of the custom endpoint group.\n All other eligible instances are reachable through the custom endpoint.\n Only relevant if the list of static members is empty.

" + } + }, + "DBClusterEndpointArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the endpoint.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type represents the information you need to connect to an Amazon Aurora DB cluster.\n This data type is used as a response element in the following actions:

\n \n

For the data structure that represents Amazon RDS DB instance endpoints,\n see Endpoint.

" + } + }, + "com.amazonaws.rds#DBClusterEndpointAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterEndpointAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified custom endpoint can't be created because it already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBClusterEndpointList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterEndpoint", + "traits": { + "smithy.api#xmlName": "DBClusterEndpointList" + } + } + }, + "com.amazonaws.rds#DBClusterEndpointMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterEndpoints request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBClusterEndpoints": { + "target": "com.amazonaws.rds#DBClusterEndpointList", + "traits": { + "smithy.api#documentation": "

Contains the details of the endpoints associated with the cluster\n and matching any filter conditions.

" + } + } + } + }, + "com.amazonaws.rds#DBClusterEndpointNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterEndpointNotFoundFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified custom endpoint doesn't exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBClusterEndpointQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterEndpointQuotaExceededFault", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

The cluster already has the maximum number of custom endpoints.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.rds#DBClusterIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z][0-9A-Za-z-:._]*$" + } + }, + "com.amazonaws.rds#DBClusterList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBCluster", + "traits": { + "smithy.api#xmlName": "DBCluster" + } + } + }, + "com.amazonaws.rds#DBClusterMember": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the instance identifier for this member of the DB cluster.

" + } + }, + "IsClusterWriter": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

" + } + }, + "DBClusterParameterGroupStatus": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the status of the DB cluster parameter group for this member of the DB cluster.

" + } + }, + "PromotionTier": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an instance that is part of a DB cluster.

" + } + }, + "com.amazonaws.rds#DBClusterMemberList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterMember", + "traits": { + "smithy.api#xmlName": "DBClusterMember" + } + } + }, + "com.amazonaws.rds#DBClusterMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a later DescribeDBClusters request.

" + } + }, + "DBClusters": { + "target": "com.amazonaws.rds#DBClusterList", + "traits": { + "smithy.api#documentation": "

Contains a list of DB clusters for the user.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBClusters action.

" + } + }, + "com.amazonaws.rds#DBClusterNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n DBClusterIdentifier doesn't refer to an existing DB cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBClusterOptionGroupMemberships": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterOptionGroupStatus", + "traits": { + "smithy.api#xmlName": "DBClusterOptionGroup" + } + } + }, + "com.amazonaws.rds#DBClusterOptionGroupStatus": { + "type": "structure", + "members": { + "DBClusterOptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the DB cluster option group.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the status of the DB cluster option group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains status information for a DB cluster option group.

" + } + }, + "com.amazonaws.rds#DBClusterParameterGroup": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group.

" + } + }, + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group family that this DB cluster parameter group is compatible with.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the customer-specified description for this DB cluster parameter group.

" + } + }, + "DBClusterParameterGroupArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB cluster parameter group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of an Amazon RDS DB cluster parameter group.

\n

This data type is used as a response element in the DescribeDBClusterParameterGroups action.

" + } + }, + "com.amazonaws.rds#DBClusterParameterGroupDetails": { + "type": "structure", + "members": { + "Parameters": { + "target": "com.amazonaws.rds#ParametersList", + "traits": { + "smithy.api#documentation": "

Provides a list of parameters for the DB cluster parameter group.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.

" + } + }, + "com.amazonaws.rds#DBClusterParameterGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterParameterGroup", + "traits": { + "smithy.api#xmlName": "DBClusterParameterGroup" + } + } + }, + "com.amazonaws.rds#DBClusterParameterGroupNameMessage": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group.

\n

Constraints:

\n \n \n

This value is stored as a lowercase string.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterParameterGroupNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n DBClusterParameterGroupName doesn't refer to an existing DB\n cluster parameter group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBClusterParameterGroupsMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBClusterParameterGroups": { + "target": "com.amazonaws.rds#DBClusterParameterGroupList", + "traits": { + "smithy.api#documentation": "

A list of DB cluster parameter groups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DBClusterQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterQuotaExceededFault", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

The user attempted to create a new DB cluster and the user has already reached the\n maximum allowed DB cluster quota.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.rds#DBClusterRole": { + "type": "structure", + "members": { + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following\n values:

\n " + } + }, + "FeatureName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role.\n For information about supported feature names, see DBEngineVersion.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.

" + } + }, + "com.amazonaws.rds#DBClusterRoleAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterRoleAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBClusterRoleNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterRoleNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified IAM role Amazon Resource Name (ARN) isn't associated with the specified DB cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBClusterRoleQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterRoleQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBClusterRoles": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterRole", + "traits": { + "smithy.api#xmlName": "DBClusterRole" + } + } + }, + "com.amazonaws.rds#DBClusterSnapshot": { + "type": "structure", + "members": { + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZones", + "traits": { + "smithy.api#documentation": "

Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

" + } + }, + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the identifier for the DB cluster snapshot.

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

" + } + }, + "SnapshotCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the database engine for this DB cluster snapshot.

" + } + }, + "EngineMode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the engine mode of the database engine for this DB cluster snapshot.

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the allocated storage size in gibibytes (GiB).

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the status of this DB cluster snapshot. Valid statuses are the following:

\n " + } + }, + "Port": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the port that the DB cluster was listening on at the time of the snapshot.

" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the VPC ID associated with the DB cluster snapshot.

" + } + }, + "ClusterCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

" + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the master username for this DB cluster snapshot.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the version of the database engine for this DB cluster snapshot.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the license model information for this DB cluster snapshot.

" + } + }, + "SnapshotType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the type of the DB cluster snapshot.

" + } + }, + "PercentProgress": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the percentage of the estimated data that has been transferred.

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the DB cluster snapshot is encrypted.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "DBClusterSnapshotArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB cluster snapshot.

" + } + }, + "SourceDBClusterSnapshotArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon\n Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

" + } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

" + } + }, + "TagList": { + "target": "com.amazonaws.rds#TagList" + }, + "DBSystemId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details for an Amazon RDS DB cluster snapshot

\n

This data type is used as a response element \n in the DescribeDBClusterSnapshots action.

" + } + }, + "com.amazonaws.rds#DBClusterSnapshotAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterSnapshotAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The user already has a DB cluster snapshot with the given identifier.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBClusterSnapshotAttribute": { + "type": "structure", + "members": { + "AttributeName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the manual DB cluster snapshot attribute.

\n

The attribute named restore refers to the list of Amazon Web Services accounts that\n have permission to copy or restore the manual DB cluster snapshot. For more information, \n see the ModifyDBClusterSnapshotAttribute\n API action.

" + } + }, + "AttributeValues": { + "target": "com.amazonaws.rds#AttributeValueList", + "traits": { + "smithy.api#documentation": "

The value(s) for the manual DB cluster snapshot attribute.

\n

If the AttributeName field is set to restore, then this element\n returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual\n DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot\n is public and available for any Amazon Web Services account to copy or restore.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the name and values of a manual DB cluster snapshot attribute.

\n

Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts\n to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute\n API action.

" + } + }, + "com.amazonaws.rds#DBClusterSnapshotAttributeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterSnapshotAttribute", + "traits": { + "smithy.api#xmlName": "DBClusterSnapshotAttribute" + } + } + }, + "com.amazonaws.rds#DBClusterSnapshotAttributesResult": { + "type": "structure", + "members": { + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the manual DB cluster snapshot that the attributes apply to.

" + } + }, + "DBClusterSnapshotAttributes": { + "target": "com.amazonaws.rds#DBClusterSnapshotAttributeList", + "traits": { + "smithy.api#documentation": "

The list of attributes and values for the manual DB cluster snapshot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes\n API action.

\n

Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts\n to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute\n API action.

" + } + }, + "com.amazonaws.rds#DBClusterSnapshotList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBClusterSnapshot", + "traits": { + "smithy.api#xmlName": "DBClusterSnapshot" + } + } + }, + "com.amazonaws.rds#DBClusterSnapshotMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBClusterSnapshots": { + "target": "com.amazonaws.rds#DBClusterSnapshotList", + "traits": { + "smithy.api#documentation": "

Provides a list of DB cluster snapshots for the user.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.

" + } + }, + "com.amazonaws.rds#DBClusterSnapshotNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBClusterSnapshotNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBEngineVersion": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database engine.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine.

" + } + }, + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group family for the database engine.

" + } + }, + "DBEngineDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description of the database engine.

" + } + }, + "DBEngineVersionDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description of the database engine version.

" + } + }, + "DefaultCharacterSet": { + "target": "com.amazonaws.rds#CharacterSet", + "traits": { + "smithy.api#documentation": "

The default character set for new instances of this engine version,\n if the CharacterSetName parameter of the CreateDBInstance API\n isn't specified.

" + } + }, + "Image": { + "target": "com.amazonaws.rds#CustomDBEngineVersionAMI", + "traits": { + "smithy.api#documentation": "

The EC2 image

" + } + }, + "DBEngineMediaType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.

" + } + }, + "SupportedCharacterSets": { + "target": "com.amazonaws.rds#SupportedCharacterSetsList", + "traits": { + "smithy.api#documentation": "

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.

" + } + }, + "SupportedNcharCharacterSets": { + "target": "com.amazonaws.rds#SupportedCharacterSetsList", + "traits": { + "smithy.api#documentation": "

A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.

" + } + }, + "ValidUpgradeTarget": { + "target": "com.amazonaws.rds#ValidUpgradeTargetList", + "traits": { + "smithy.api#documentation": "

A list of engine versions that this database engine version can be upgraded to.

" + } + }, + "SupportedTimezones": { + "target": "com.amazonaws.rds#SupportedTimezonesList", + "traits": { + "smithy.api#documentation": "

A list of the time zones supported by this engine for the\n Timezone parameter of the CreateDBInstance action.

" + } + }, + "ExportableLogTypes": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The types of logs that the database engine has available for export to CloudWatch Logs.

" + } + }, + "SupportsLogExportsToCloudwatchLogs": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

" + } + }, + "SupportsReadReplica": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the database engine version supports read replicas.

" + } + }, + "SupportedEngineModes": { + "target": "com.amazonaws.rds#EngineModeList", + "traits": { + "smithy.api#documentation": "

A list of the supported DB engine modes.

" + } + }, + "SupportedFeatureNames": { + "target": "com.amazonaws.rds#FeatureNameList", + "traits": { + "smithy.api#documentation": "

A list of features supported by the DB engine.

\n

The supported features vary by DB engine and DB engine version.

\n

To determine the supported features for a specific DB engine and DB engine version using the CLI, \n use the following command:

\n

\n aws rds describe-db-engine-versions --engine --engine-version \n

\n

For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, \n use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --engine-version 13.3\n

\n

The supported features are listed under SupportedFeatureNames in the output.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the DB engine version, either available or deprecated.

" + } + }, + "SupportsParallelQuery": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether you can use Aurora parallel query with a specific DB engine version.

" + } + }, + "SupportsGlobalDatabases": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether you can use Aurora global databases with a specific DB engine version.

" + } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The major engine version of the CEV.

" + } + }, + "DatabaseInstallationFilesS3BucketName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket that contains your database installation files.

" + } + }, + "DatabaseInstallationFilesS3Prefix": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon S3 directory that contains the database installation files. \n If not specified, then no prefix is assumed.

" + } + }, + "DBEngineVersionArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN of the custom engine version.

" + } + }, + "KMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for \n RDS Custom, but optional for Amazon RDS.

" + } + }, + "CreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The creation time of the DB engine version.

" + } + }, + "TagList": { + "target": "com.amazonaws.rds#TagList" + }, + "SupportsBabelfish": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

" + } + }, + "CustomDBEngineVersionManifest": { + "target": "com.amazonaws.rds#CustomDBEngineVersionManifest", + "traits": { + "smithy.api#documentation": "

JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). \n RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, \n and UNIX/Linux user and group using the installation parameters. For more information, \n see JSON fields in the CEV manifest in the Amazon RDS User Guide.\n

" + } + }, + "SupportsCertificateRotationWithoutRestart": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the engine version supports rotating the server certificate without \n rebooting the DB instance.

" + } + }, + "SupportedCACertificateIdentifiers": { + "target": "com.amazonaws.rds#CACertificateIdentifiersList", + "traits": { + "smithy.api#documentation": "

A list of the supported CA certificate identifiers.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the action DescribeDBEngineVersions.

" + } + }, + "com.amazonaws.rds#DBEngineVersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBEngineVersion", + "traits": { + "smithy.api#xmlName": "DBEngineVersion" + } + } + }, + "com.amazonaws.rds#DBEngineVersionMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBEngineVersions": { + "target": "com.amazonaws.rds#DBEngineVersionList", + "traits": { + "smithy.api#documentation": "

A list of DBEngineVersion elements.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBEngineVersions action.

" + } + }, + "com.amazonaws.rds#DBInstance": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Contains the name of the compute and memory capacity class of the DB instance.

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database engine to be used for this DB instance.

" + } + }, + "DBInstanceStatus": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the current state of this database.

\n

For information about DB instance statuses, see\n Viewing DB instance status \n in the Amazon RDS User Guide.\n

" + } + }, + "AutomaticRestartTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time when a stopped DB instance is restarted automatically.

" + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Contains the master username for the DB instance.

" + } + }, + "DBName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The meaning of this parameter differs according to the database engine you use.

\n

\n MySQL, MariaDB, SQL Server, PostgreSQL\n

\n

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

\n

Type: String

\n

\n Oracle\n

\n

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.rds#Endpoint", + "traits": { + "smithy.api#documentation": "

Specifies the connection endpoint.

\n \n

The endpoint might not be shown for instances whose status is creating.

\n " + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the allocated storage size specified in gibibytes (GiB).

" + } + }, + "InstanceCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Provides the date and time the DB instance was created.

" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the number of days for which automatic DB snapshots are retained.

" + } + }, + "DBSecurityGroups": { + "target": "com.amazonaws.rds#DBSecurityGroupMembershipList", + "traits": { + "smithy.api#documentation": "

A list of DB security group elements containing \n DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

" + } + }, + "VpcSecurityGroups": { + "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", + "traits": { + "smithy.api#documentation": "

Provides a list of VPC security group elements that the DB instance belongs to.

" + } + }, + "DBParameterGroups": { + "target": "com.amazonaws.rds#DBParameterGroupStatusList", + "traits": { + "smithy.api#documentation": "

Provides the list of DB parameter groups applied to this DB instance.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the Availability Zone the DB instance is located in.

" + } + }, + "DBSubnetGroup": { + "target": "com.amazonaws.rds#DBSubnetGroup", + "traits": { + "smithy.api#documentation": "

Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

" + } + }, + "PendingModifiedValues": { + "target": "com.amazonaws.rds#PendingModifiedValues", + "traits": { + "smithy.api#documentation": "

A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

" + } + }, + "LatestRestorableTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Specifies the latest time to which a database can be restored with point-in-time restore.

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Indicates the database engine version.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates that minor version patches are applied automatically.

" + } + }, + "ReadReplicaSourceDBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Contains the identifier of the source DB instance if this DB instance is a read\n replica.

" + } + }, + "ReadReplicaDBInstanceIdentifiers": { + "target": "com.amazonaws.rds#ReadReplicaDBInstanceIdentifierList", + "traits": { + "smithy.api#documentation": "

Contains one or more identifiers of the read replicas associated with this DB\n instance.

" + } + }, + "ReadReplicaDBClusterIdentifiers": { + "target": "com.amazonaws.rds#ReadReplicaDBClusterIdentifierList", + "traits": { + "smithy.api#documentation": "

Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance\n is replicated as a read replica. For example, when you create an Aurora read replica of\n an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is\n shown. This output doesn't contain information about cross-Region Aurora read\n replicas.

\n \n

Currently, each RDS DB instance can have only one Aurora read replica.

\n " + } + }, + "ReplicaMode": { + "target": "com.amazonaws.rds#ReplicaMode", + "traits": { + "smithy.api#documentation": "

The open mode of an Oracle read replica. The default is open-read-only. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.

\n \n

This attribute is only supported in RDS for Oracle.

\n " + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

License model information for this DB instance. This setting doesn't apply to RDS Custom.

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the Provisioned IOPS (I/O operations per second) value.

" + } + }, + "OptionGroupMemberships": { + "target": "com.amazonaws.rds#OptionGroupMembershipList", + "traits": { + "smithy.api#documentation": "

Provides the list of option group memberships for this DB instance.

" + } + }, + "CharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If present, specifies the name of the character set that this instance is associated with.

" + } + }, + "NcharCharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the NCHAR character set for the Oracle DB instance. This character set specifies the\n Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

" + } + }, + "SecondaryAvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies the accessibility options for the DB instance.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" + } + }, + "StatusInfos": { + "target": "com.amazonaws.rds#DBInstanceStatusInfoList", + "traits": { + "smithy.api#documentation": "

The status of a read replica. If the instance isn't a read replica, this is\n blank.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type associated with the DB instance.

" + } + }, + "TdeCredentialArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN from the key store with which the instance is associated for TDE encryption.

" + } + }, + "DbInstancePort": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the DB instance is encrypted.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If StorageEncrypted is true, the Amazon Web Services KMS key identifier \n for the encrypted DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "DbiResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log \n entries whenever the Amazon Web Services KMS key for the DB instance is accessed.

" + } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the CA certificate for this DB instance.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + } + }, + "DomainMemberships": { + "target": "com.amazonaws.rds#DomainMembershipList", + "traits": { + "smithy.api#documentation": "

The Active Directory Domain membership records associated with the DB instance.

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

\n

\n Amazon Aurora\n

\n

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see DBCluster.

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

" + } + }, + "EnhancedMonitoringResourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

" + } + }, + "PromotionTier": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

" + } + }, + "DBInstanceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB instance.

" + } + }, + "Timezone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The time zone of the DB instance.\n In most cases, the Timezone element is empty.\n Timezone content appears only for\n Microsoft SQL Server DB instances \n that were created with a time zone specified.

" + } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

\n

IAM database authentication can be enabled for the following database engines

\n " + } + }, + "PerformanceInsightsEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

True if Performance Insights is enabled for the DB instance, and otherwise false.

" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n " + } + }, + "EnabledCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

A list of log types that this DB instance is configured to export to CloudWatch Logs.

\n

Log types vary by DB engine. For information about the log types for each DB engine, see\n Amazon RDS Database Log Files in the Amazon RDS User Guide.\n

" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates if the DB instance has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled.\n For more information, see \n \n Deleting a DB Instance.

" + } + }, + "AssociatedRoles": { + "target": "com.amazonaws.rds#DBInstanceRoles", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

" + } + }, + "ListenerEndpoint": { + "target": "com.amazonaws.rds#Endpoint", + "traits": { + "smithy.api#documentation": "

Specifies the listener connection endpoint for SQL Server Always On.

" + } + }, + "MaxAllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

" + } + }, + "TagList": { + "target": "com.amazonaws.rds#TagList" + }, + "DBInstanceAutomatedBackupsReplications": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupsReplicationList", + "traits": { + "smithy.api#documentation": "

The list of replicated automated backups associated with the DB instance.

" + } + }, + "CustomerOwnedIpEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + } + }, + "AwsBackupRecoveryPointArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

" + } + }, + "ActivityStreamStatus": { + "target": "com.amazonaws.rds#ActivityStreamStatus", + "traits": { + "smithy.api#documentation": "

The status of the database activity stream.

" + } + }, + "ActivityStreamKmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "ActivityStreamKinesisStreamName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Kinesis data stream used for the database activity stream.

" + } + }, + "ActivityStreamMode": { + "target": "com.amazonaws.rds#ActivityStreamMode", + "traits": { + "smithy.api#documentation": "

The mode of the database activity stream. Database events such as a change or access generate \n an activity stream event. RDS for Oracle always handles these events asynchronously.

" + } + }, + "ActivityStreamEngineNativeAuditFieldsIncluded": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether engine-native audit fields are included in the database activity stream.

" + } + }, + "AutomationMode": { + "target": "com.amazonaws.rds#AutomationMode", + "traits": { + "smithy.api#documentation": "

The automation mode of the RDS Custom DB instance: full or all paused. \n If full, the DB instance automates monitoring and instance recovery. If \n all paused, the instance pauses automation for the duration set by \n --resume-full-automation-mode-minutes.

" + } + }, + "ResumeFullAutomationModeTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. \n The minimum value is 60 (default). The maximum value is 1,440.

" + } + }, + "CustomIamInstanceProfile": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n \n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

" + } + }, + "BackupTarget": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

" + } + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide and \n \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

" + } + }, + "ActivityStreamPolicyStatus": { + "target": "com.amazonaws.rds#ActivityStreamPolicyStatus", + "traits": { + "smithy.api#documentation": "

The status of the policy state of the activity stream.

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the storage throughput for the DB instance.

\n

This setting applies only to the gp3 storage type.

" + } + }, + "DBSystemId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also\n the name of the CDB. This setting is valid for RDS Custom only.

" + } + }, + "MasterUserSecret": { + "target": "com.amazonaws.rds#MasterUserSecret", + "traits": { + "smithy.api#documentation": "

Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

" + } + }, + "CertificateDetails": { + "target": "com.amazonaws.rds#CertificateDetails", + "traits": { + "smithy.api#documentation": "

The details of the DB instance's server certificate.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of an Amazon RDS DB instance.

\n

This data type is used as a response element in the operations CreateDBInstance, \n CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, \n ModifyDBInstance, PromoteReadReplica, RebootDBInstance, \n RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, \n StartDBInstance, and StopDBInstance.

" + } + }, + "com.amazonaws.rds#DBInstanceAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The user already has a DB instance with the given identifier.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBInstanceAutomatedBackup": { + "type": "structure", + "members": { + "DBInstanceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the automated backups.

" + } + }, + "DbiResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

" + } + }, + "Region": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region associated with the automated backup.

" + } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The customer id of the instance that is/was associated with the automated backup.

" + } + }, + "RestoreWindow": { + "target": "com.amazonaws.rds#RestoreWindow", + "traits": { + "smithy.api#documentation": "

Earliest and latest time an instance can be restored to.

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the allocated storage size in gibibytes (GiB).

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides a list of status information for an automated backup:

\n " + } + }, + "Port": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The port number that the automated backup used for connections.

\n

Default: Inherits from the source DB instance

\n

Valid Values: 1150-65535\n

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone that the automated backup was created in. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.

" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the VPC ID associated with the DB instance.

" + } + }, + "InstanceCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Provides the date and time that the DB instance was created.

" + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The license model of an automated backup.

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database engine for this automated backup.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the database engine for the automated backup.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

License model information for the automated backup.

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The IOPS (I/O operations per second) value for the automated backup.

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.

" + } + }, + "TdeCredentialArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN from the key store with which the automated backup is associated for TDE encryption.

" + } + }, + "Encrypted": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the automated backup is encrypted.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type associated with the automated backup.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key ID for an automated backup.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "Timezone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The time zone of the automated backup. In most cases, the Timezone element is empty.\n Timezone content appears only for Microsoft SQL Server DB instances \n that were created with a time zone specified.

" + } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, \n and otherwise false.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The retention period for the automated backups.

" + } + }, + "DBInstanceAutomatedBackupsArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the replicated automated backups.

" + } + }, + "DBInstanceAutomatedBackupsReplications": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupsReplicationList", + "traits": { + "smithy.api#documentation": "

The list of replications to different Amazon Web Services Regions associated with the automated backup.

" + } + }, + "BackupTarget": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the storage throughput for the automated backup.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that\n existed at the time you deleted the source instance.

" + } + }, + "com.amazonaws.rds#DBInstanceAutomatedBackupList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackup", + "traits": { + "smithy.api#xmlName": "DBInstanceAutomatedBackup" + } + } + }, + "com.amazonaws.rds#DBInstanceAutomatedBackupMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBInstanceAutomatedBackups": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupList", + "traits": { + "smithy.api#documentation": "

A list of DBInstanceAutomatedBackup instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.

" + } + }, + "com.amazonaws.rds#DBInstanceAutomatedBackupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceAutomatedBackupNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

No automated backup for this DB instance was found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBInstanceAutomatedBackupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceAutomatedBackupQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The quota for retained automated backups was exceeded. This prevents you\n from retaining any additional automated backups. The retained automated backups \n quota is the same as your DB Instance quota.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBInstanceAutomatedBackupsReplication": { + "type": "structure", + "members": { + "DBInstanceAutomatedBackupsArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicated automated backups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.

" + } + }, + "com.amazonaws.rds#DBInstanceAutomatedBackupsReplicationList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupsReplication", + "traits": { + "smithy.api#xmlName": "DBInstanceAutomatedBackupsReplication" + } + } + }, + "com.amazonaws.rds#DBInstanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBInstance", + "traits": { + "smithy.api#xmlName": "DBInstance" + } + } + }, + "com.amazonaws.rds#DBInstanceMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .

" + } + }, + "DBInstances": { + "target": "com.amazonaws.rds#DBInstanceList", + "traits": { + "smithy.api#documentation": "

A list of DBInstance instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBInstances action.

" + } + }, + "com.amazonaws.rds#DBInstanceNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n DBInstanceIdentifier doesn't refer to an existing DB instance.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBInstanceRole": { + "type": "structure", + "members": { + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB\n instance.

" + } + }, + "FeatureName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role.\n For information about supported feature names, see DBEngineVersion.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following\n values:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.

" + } + }, + "com.amazonaws.rds#DBInstanceRoleAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceRoleAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified RoleArn or FeatureName value is already associated with the DB instance.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBInstanceRoleNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceRoleNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified RoleArn value doesn't match the specified feature for\n the DB instance.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBInstanceRoleQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBInstanceRoleQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You can't associate any more Amazon Web Services Identity and Access Management (IAM) roles with the DB instance because the quota has been reached.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBInstanceRoles": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBInstanceRole", + "traits": { + "smithy.api#xmlName": "DBInstanceRole" + } + } + }, + "com.amazonaws.rds#DBInstanceStatusInfo": { + "type": "structure", + "members": { + "StatusType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

This value is currently \"read replication.\"

" + } + }, + "Normal": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Status of the DB instance. For a StatusType of read replica, the values can be\n replicating, replication stop point set, replication stop point reached, error, stopped,\n or terminated.

" + } + }, + "Message": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides a list of status information for a DB instance.

" + } + }, + "com.amazonaws.rds#DBInstanceStatusInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBInstanceStatusInfo", + "traits": { + "smithy.api#xmlName": "DBInstanceStatusInfo" + } + } + }, + "com.amazonaws.rds#DBLogFileNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBLogFileNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n LogFileName doesn't refer to an existing DB log file.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBParameterGroup": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group.

" + } + }, + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group family that this DB parameter group is compatible with.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the customer-specified description for this DB parameter group.

" + } + }, + "DBParameterGroupArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB parameter group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of an Amazon RDS DB parameter group.

\n

This data type is used as a response element in the DescribeDBParameterGroups action.

" + } + }, + "com.amazonaws.rds#DBParameterGroupAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBParameterGroupAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A DB parameter group with the same name exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBParameterGroupDetails": { + "type": "structure", + "members": { + "Parameters": { + "target": "com.amazonaws.rds#ParametersList", + "traits": { + "smithy.api#documentation": "

A list of Parameter values.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBParameters action.

" + } + }, + "com.amazonaws.rds#DBParameterGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBParameterGroup", + "traits": { + "smithy.api#xmlName": "DBParameterGroup" + } + } + }, + "com.amazonaws.rds#DBParameterGroupNameMessage": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the \n ModifyDBParameterGroup or ResetDBParameterGroup action.

" + } + }, + "com.amazonaws.rds#DBParameterGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBParameterGroupNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n DBParameterGroupName doesn't refer to an\n existing DB parameter group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBParameterGroupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBParameterGroupQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB parameter\n groups.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBParameterGroupStatus": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group.

" + } + }, + "ParameterApplyStatus": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of parameter updates.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the DB parameter group.

\n

This data type is used as a response element in the following actions:

\n " + } + }, + "com.amazonaws.rds#DBParameterGroupStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBParameterGroupStatus", + "traits": { + "smithy.api#xmlName": "DBParameterGroup" + } + } + }, + "com.amazonaws.rds#DBParameterGroupsMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBParameterGroups": { + "target": "com.amazonaws.rds#DBParameterGroupList", + "traits": { + "smithy.api#documentation": "

A list of DBParameterGroup instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBParameterGroups action.

" + } + }, + "com.amazonaws.rds#DBProxy": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

" + } + }, + "DBProxyArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the proxy.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#DBProxyStatus", + "traits": { + "smithy.api#documentation": "

The current status of this proxy. A status of available means the\n proxy is ready to handle requests. Other values indicate that you must wait for\n the proxy to be ready, or take some action to resolve an issue.

" + } + }, + "EngineFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The kinds of databases that the proxy can connect to. This value determines which database network protocol \n the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, \n RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases. \n SQLSERVER supports RDS for Microsoft SQL Server databases.

" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the VPC ID of the DB proxy.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

Provides a list of VPC security groups that the proxy belongs to.

" + } + }, + "VpcSubnetIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The EC2 subnet IDs for the proxy.

" + } + }, + "Auth": { + "target": "com.amazonaws.rds#UserAuthConfigInfoList", + "traits": { + "smithy.api#documentation": "

One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance\n or Aurora DB cluster.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the\n connection string for a database client application.

" + } + }, + "RequireTLS": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.

" + } + }, + "IdleClientTimeout": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.\n The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by\n later connection requests.

\n

Default: 1800 (30 minutes)

\n

Constraints: 1 to 28,800

" + } + }, + "DebugLogging": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

" + } + }, + "CreatedDate": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the proxy was first created.

" + } + }, + "UpdatedDate": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the proxy was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data structure representing a proxy managed by the RDS Proxy.

\n

This data type is used as a response element in the DescribeDBProxies action.

" + } + }, + "com.amazonaws.rds#DBProxyAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBProxyEndpoint": { + "type": "structure", + "members": { + "DBProxyEndpointName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name for the DB proxy endpoint. An identifier must begin with a letter and\n must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen\n or contain two consecutive hyphens.

" + } + }, + "DBProxyEndpointArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB proxy endpoint.

" + } + }, + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the DB proxy that is associated with this DB proxy endpoint.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#DBProxyEndpointStatus", + "traits": { + "smithy.api#documentation": "

The current status of this DB proxy endpoint. A status of available means the\n endpoint is ready to handle requests. Other values indicate that you must wait for\n the endpoint to be ready, or take some action to resolve an issue.

" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the VPC ID of the DB proxy endpoint.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

Provides a list of VPC security groups that the DB proxy endpoint belongs to.

" + } + }, + "VpcSubnetIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The EC2 subnet IDs for the DB proxy endpoint.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the\n connection string for a database client application.

" + } + }, + "CreatedDate": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the DB proxy endpoint was first created.

" + } + }, + "TargetRole": { + "target": "com.amazonaws.rds#DBProxyEndpointTargetRole", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.

" + } + }, + "IsDefault": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether this endpoint is the default endpoint for the associated DB proxy.\n Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the\n DB proxy can be either read/write or read-only.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one\n endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same\n DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the\n associated DB proxy.

\n

This data type is used as a response element in the DescribeDBProxyEndpoints operation.

" + } + }, + "com.amazonaws.rds#DBProxyEndpointAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyEndpointAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBProxyEndpointList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBProxyEndpoint" + } + }, + "com.amazonaws.rds#DBProxyEndpointName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" + } + }, + "com.amazonaws.rds#DBProxyEndpointNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyEndpointNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The DB proxy endpoint doesn't exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBProxyEndpointQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyEndpointQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB proxy already has the maximum number of endpoints.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBProxyEndpointStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "MODIFYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" + } + }, + "INCOMPATIBLE_NETWORK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "incompatible-network" + } + }, + "INSUFFICIENT_RESOURCE_LIMITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "insufficient-resource-limits" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "creating" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + } + } + }, + "com.amazonaws.rds#DBProxyEndpointTargetRole": { + "type": "enum", + "members": { + "READ_WRITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ_WRITE" + } + }, + "READ_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ_ONLY" + } + } + } + }, + "com.amazonaws.rds#DBProxyList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBProxy" + } + }, + "com.amazonaws.rds#DBProxyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" + } + }, + "com.amazonaws.rds#DBProxyNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBProxyQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Your Amazon Web Services account already has the maximum number of proxies in the specified Amazon Web Services Region.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBProxyStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "MODIFYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "modifying" + } + }, + "INCOMPATIBLE_NETWORK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "incompatible-network" + } + }, + "INSUFFICIENT_RESOURCE_LIMITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "insufficient-resource-limits" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "creating" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "SUSPENDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "suspended" + } + }, + "SUSPENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "suspending" + } + }, + "REACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "reactivating" + } + } + } + }, + "com.amazonaws.rds#DBProxyTarget": { + "type": "structure", + "members": { + "TargetArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The writer endpoint for the RDS DB instance or Aurora DB cluster.

" + } + }, + "TrackedClusterId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.

" + } + }, + "RdsResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier representing the target. It can be the instance identifier for an RDS DB instance,\n or the cluster identifier for an Aurora DB cluster.

" + } + }, + "Port": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.

" + } + }, + "Type": { + "target": "com.amazonaws.rds#TargetType", + "traits": { + "smithy.api#documentation": "

Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.

" + } + }, + "Role": { + "target": "com.amazonaws.rds#TargetRole", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the target of the proxy can be used for read/write or read-only operations.

" + } + }, + "TargetHealth": { + "target": "com.amazonaws.rds#TargetHealth", + "traits": { + "smithy.api#documentation": "

Information about the connection health of the RDS Proxy target.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster\n that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.

\n

This data type is used as a response element in the DescribeDBProxyTargets action.

" + } + }, + "com.amazonaws.rds#DBProxyTargetAlreadyRegisteredFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyTargetAlreadyRegisteredFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The proxy is already associated with the specified RDS DB instance or Aurora DB cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBProxyTargetGroup": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the RDS proxy associated with this target group.

" + } + }, + "TargetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the target group. This name must be unique for all target groups owned by your Amazon Web Services account in the specified Amazon Web Services Region.

" + } + }, + "TargetGroupArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) representing the target group.

" + } + }, + "IsDefault": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether this target group is the first one used for connection requests by the associated proxy.\n Because each proxy is currently associated with a single target group, currently this setting\n is always true.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The current status of this target group. A status of available means the\n target group is correctly associated with a database. Other values indicate that you must wait for\n the target group to be ready, or take some action to resolve an issue.

" + } + }, + "ConnectionPoolConfig": { + "target": "com.amazonaws.rds#ConnectionPoolConfigurationInfo", + "traits": { + "smithy.api#documentation": "

The settings that determine the size and behavior of the connection pool for the target group.

" + } + }, + "CreatedDate": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the target group was first created.

" + } + }, + "UpdatedDate": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the target group was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group\n is associated with exactly one RDS DB instance or Aurora DB cluster.

\n

This data type is used as a response element in the DescribeDBProxyTargetGroups action.

" + } + }, + "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyTargetGroupNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBProxyTargetNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBProxyTargetNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBSecurityGroup": { + "type": "structure", + "members": { + "OwnerId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the Amazon Web Services ID of the owner of a specific DB security group.

" + } + }, + "DBSecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the DB security group.

" + } + }, + "DBSecurityGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the description of the DB security group.

" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the VpcId of the DB security group.

" + } + }, + "EC2SecurityGroups": { + "target": "com.amazonaws.rds#EC2SecurityGroupList", + "traits": { + "smithy.api#documentation": "

Contains a list of EC2SecurityGroup elements.

" + } + }, + "IPRanges": { + "target": "com.amazonaws.rds#IPRangeList", + "traits": { + "smithy.api#documentation": "

Contains a list of IPRange elements.

" + } + }, + "DBSecurityGroupArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB security group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details for an Amazon RDS DB security group.

\n

This data type is used as a response element \n in the DescribeDBSecurityGroups action.

" + } + }, + "com.amazonaws.rds#DBSecurityGroupAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSecurityGroupAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A DB security group with the name specified in\n DBSecurityGroupName already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBSecurityGroupMembership": { + "type": "structure", + "members": { + "DBSecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB security group.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the DB security group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the following actions:

\n " + } + }, + "com.amazonaws.rds#DBSecurityGroupMembershipList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBSecurityGroupMembership", + "traits": { + "smithy.api#xmlName": "DBSecurityGroup" + } + } + }, + "com.amazonaws.rds#DBSecurityGroupMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBSecurityGroups": { + "target": "com.amazonaws.rds#DBSecurityGroups", + "traits": { + "smithy.api#documentation": "

A list of DBSecurityGroup instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

" + } + }, + "com.amazonaws.rds#DBSecurityGroupNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "DBSecurityGroupName" + } + } + }, + "com.amazonaws.rds#DBSecurityGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSecurityGroupNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n DBSecurityGroupName doesn't refer to an existing DB security group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBSecurityGroupNotSupportedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSecurityGroupNotSupported", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A DB security group isn't allowed for this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBSecurityGroupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "QuotaExceeded.DBSecurityGroup", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB security\n groups.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBSecurityGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBSecurityGroup", + "traits": { + "smithy.api#xmlName": "DBSecurityGroup" + } + } + }, + "com.amazonaws.rds#DBSnapshot": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the identifier for the DB snapshot.

" + } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

" + } + }, + "SnapshotCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the database engine.

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the allocated storage size in gibibytes (GiB).

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the status of this DB snapshot.

" + } + }, + "Port": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the port that the database engine was listening on at the time of the snapshot.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the VPC ID associated with the DB snapshot.

" + } + }, + "InstanceCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from\n which the snapshot was taken, was created.

" + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the master username for the DB snapshot.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the version of the database engine.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

License model information for the restored DB instance.

" + } + }, + "SnapshotType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the type of the DB snapshot.

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the option group name for the DB snapshot.

" + } + }, + "PercentProgress": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The percentage of the estimated data that has been transferred.

" + } + }, + "SourceRegion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region that the DB snapshot was created in or copied from.

" + } + }, + "SourceDBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type associated with DB snapshot.

" + } + }, + "TdeCredentialArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

" + } + }, + "Encrypted": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the DB snapshot is encrypted.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If Encrypted is true, the Amazon Web Services KMS key identifier \n for the encrypted DB snapshot.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "DBSnapshotArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB snapshot.

" + } + }, + "Timezone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The time zone of the DB snapshot.\n In most cases, the Timezone element is empty.\n Timezone content appears only for\n snapshots taken from \n Microsoft SQL Server DB instances \n that were created with a time zone specified.

" + } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class\n of the DB instance when the DB snapshot was created.

" + } + }, + "DbiResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

" + } + }, + "TagList": { + "target": "com.amazonaws.rds#TagList" + }, + "OriginalSnapshotCreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.

" + } + }, + "SnapshotDatabaseTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the most recent transaction applied to the database that you're backing up. \n Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. \n In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

\n

If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime \n with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than \n SnapshotDatabaseTime, then the replica lag is two hours.

" + } + }, + "SnapshotTarget": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the storage throughput for the DB snapshot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of an Amazon RDS DB snapshot.

\n

This data type is used as a response element \n in the DescribeDBSnapshots action.

" + } + }, + "com.amazonaws.rds#DBSnapshotAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSnapshotAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

\n DBSnapshotIdentifier is already used by an existing snapshot.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBSnapshotAttribute": { + "type": "structure", + "members": { + "AttributeName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the manual DB snapshot attribute.

\n

The attribute named restore refers to the list of Amazon Web Services accounts that\n have permission to copy or restore the manual DB cluster snapshot. For more information, \n see the ModifyDBSnapshotAttribute\n API action.

" + } + }, + "AttributeValues": { + "target": "com.amazonaws.rds#AttributeValueList", + "traits": { + "smithy.api#documentation": "

The value or values for the manual DB snapshot attribute.

\n

If the AttributeName field is set to restore, then this element\n returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual\n DB snapshot. If a value of all is in the list, then the manual DB snapshot\n is public and available for any Amazon Web Services account to copy or restore.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the name and values of a manual DB snapshot attribute

\n

Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts\n to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute\n API.

" + } + }, + "com.amazonaws.rds#DBSnapshotAttributeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBSnapshotAttribute", + "traits": { + "smithy.api#xmlName": "DBSnapshotAttribute" + } + } + }, + "com.amazonaws.rds#DBSnapshotAttributesResult": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the manual DB snapshot that the attributes apply to.

" + } + }, + "DBSnapshotAttributes": { + "target": "com.amazonaws.rds#DBSnapshotAttributeList", + "traits": { + "smithy.api#documentation": "

The list of attributes and values for the manual DB snapshot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the results of a successful call to the DescribeDBSnapshotAttributes\n API action.

\n

Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts\n to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute\n API action.

" + } + }, + "com.amazonaws.rds#DBSnapshotList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBSnapshot", + "traits": { + "smithy.api#xmlName": "DBSnapshot" + } + } + }, + "com.amazonaws.rds#DBSnapshotMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBSnapshots": { + "target": "com.amazonaws.rds#DBSnapshotList", + "traits": { + "smithy.api#documentation": "

A list of DBSnapshot instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBSnapshots action.

" + } + }, + "com.amazonaws.rds#DBSnapshotNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSnapshotNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBSubnetGroup": { + "type": "structure", + "members": { + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB subnet group.

" + } + }, + "DBSubnetGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the description of the DB subnet group.

" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the VpcId of the DB subnet group.

" + } + }, + "SubnetGroupStatus": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the status of the DB subnet group.

" + } + }, + "Subnets": { + "target": "com.amazonaws.rds#SubnetList", + "traits": { + "smithy.api#documentation": "

Contains a list of Subnet elements.

" + } + }, + "DBSubnetGroupArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB subnet group.

" + } + }, + "SupportedNetworkTypes": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The network type of the DB subnet group.

\n

Valid values:

\n \n

A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of an Amazon RDS DB subnet group.

\n

This data type is used as a response element \n in the DescribeDBSubnetGroups action.

" + } + }, + "com.amazonaws.rds#DBSubnetGroupAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

\n DBSubnetGroupName is already used by an existing DB subnet group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupDoesNotCoverEnoughAZs", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBSubnetGroupMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DBSubnetGroups": { + "target": "com.amazonaws.rds#DBSubnetGroups", + "traits": { + "smithy.api#documentation": "

A list of DBSubnetGroup instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

" + } + }, + "com.amazonaws.rds#DBSubnetGroupNotAllowedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupNotAllowedFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DBSubnetGroup shouldn't be specified while creating read replicas that lie\n in the same region as the source instance.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBSubnetGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n DBSubnetGroupName doesn't refer to an existing DB subnet group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#DBSubnetGroupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetGroupQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB subnet\n groups.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBSubnetGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBSubnetGroup", + "traits": { + "smithy.api#xmlName": "DBSubnetGroup" + } + } + }, + "com.amazonaws.rds#DBSubnetQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBSubnetQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of subnets in a\n DB subnet groups.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DBUpgradeDependencyFailureFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DBUpgradeDependencyFailure", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB upgrade failed because a resource the DB depends on can't be\n modified.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#DatabaseArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[A-Za-z][0-9A-Za-z-:._]*$" + } + }, + "com.amazonaws.rds#DeleteBlueGreenDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteBlueGreenDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.rds#DeleteBlueGreenDeploymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidBlueGreenDeploymentStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a blue/green deployment.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

" + } + }, + "com.amazonaws.rds#DeleteBlueGreenDeploymentRequest": { + "type": "structure", + "members": { + "BlueGreenDeploymentIdentifier": { + "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", + "traits": { + "smithy.api#documentation": "

The blue/green deployment identifier of the deployment to be deleted. This parameter isn't case-sensitive.

\n

Constraints:\n

\n ", + "smithy.api#required": {} + } + }, + "DeleteTarget": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to delete the resources in the green environment.

" + } + } + } + }, + "com.amazonaws.rds#DeleteBlueGreenDeploymentResponse": { + "type": "structure", + "members": { + "BlueGreenDeployment": { + "target": "com.amazonaws.rds#BlueGreenDeployment" + } + } + }, + "com.amazonaws.rds#DeleteCustomDBEngineVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteCustomDBEngineVersionMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBEngineVersion" + }, + "errors": [ + { + "target": "com.amazonaws.rds#CustomDBEngineVersionNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidCustomDBEngineVersionStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:

\n \n

Typically, deletion takes a few minutes.

\n \n

The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the DeleteCustomDbEngineVersion event.

\n \n

For more information, see \n Deleting a CEV in the Amazon RDS User Guide.

" + } + }, + "com.amazonaws.rds#DeleteCustomDBEngineVersionMessage": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#CustomEngineName", + "traits": { + "smithy.api#documentation": "

The database engine. The only supported engine is custom-oracle-ee.

", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#CustomEngineVersion", + "traits": { + "smithy.api#documentation": "

The custom engine version (CEV) for your DB instance. This option is required for \n RDS Custom, but optional for Amazon RDS. The combination of Engine and \n EngineVersion is unique per customer per Amazon Web Services Region.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.rds#DeleteDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#DeleteDBClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterSnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

The DeleteDBCluster action deletes a previously provisioned DB cluster. \n When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. \n Manual DB cluster snapshots of the specified DB cluster are not deleted.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" + } + }, + "com.amazonaws.rds#DeleteDBClusterEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBClusterEndpointMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterEndpoint" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterEndpointNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterEndpointStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.

\n \n

This action only applies to Aurora DB clusters.

\n " + } + }, + "com.amazonaws.rds#DeleteDBClusterEndpointMessage": { + "type": "structure", + "members": { + "DBClusterEndpointIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.rds#DeleteDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "SkipFinalSnapshot": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted.\n If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot \n is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. \n By default, this parameter is disabled.

\n \n

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.

\n " + } + }, + "FinalDBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot\n is disabled.

\n \n

Specifying this parameter and also skipping the creation of a final DB cluster snapshot \n with the SkipFinalShapshot parameter results in an error.

\n \n

Constraints:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DeleteDBClusterParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBClusterParameterGroupMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" + } + }, + "com.amazonaws.rds#DeleteDBClusterParameterGroupMessage": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DeleteDBClusterResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + } + }, + "com.amazonaws.rds#DeleteDBClusterSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBClusterSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#DeleteDBClusterSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

\n \n

The DB cluster snapshot must be in the available state to be\n deleted.

\n \n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" + } + }, + "com.amazonaws.rds#DeleteDBClusterSnapshotMessage": { + "type": "structure", + "members": { + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DB cluster snapshot to delete.

\n

Constraints: Must be the name of an existing DB cluster snapshot in the available state.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DeleteDBClusterSnapshotResult": { + "type": "structure", + "members": { + "DBClusterSnapshot": { + "target": "com.amazonaws.rds#DBClusterSnapshot" + } + } + }, + "com.amazonaws.rds#DeleteDBInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBInstanceMessage" + }, + "output": { + "target": "com.amazonaws.rds#DeleteDBInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

The DeleteDBInstance action deletes a previously provisioned DB instance. \n When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. \n Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

\n

If you request a final DB snapshot \n the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance\n is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.

\n

When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.

\n

If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following\n conditions are true:

\n \n

To delete a DB instance in this case, first call the\n PromoteReadReplicaDBCluster API action to promote the DB cluster so\n it's no longer a read replica. After the promotion completes, then call the\n DeleteDBInstance API action to delete the final instance in the DB\n cluster.

" + } + }, + "com.amazonaws.rds#DeleteDBInstanceAutomatedBackup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBInstanceAutomatedBackupMessage" + }, + "output": { + "target": "com.amazonaws.rds#DeleteDBInstanceAutomatedBackupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceAutomatedBackupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.

" + } + }, + "com.amazonaws.rds#DeleteDBInstanceAutomatedBackupMessage": { + "type": "structure", + "members": { + "DbiResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

" + } + }, + "DBInstanceAutomatedBackupsArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the automated backups to delete, for example,\n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

\n

This setting doesn't apply to RDS Custom.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Parameter input for the DeleteDBInstanceAutomatedBackup operation.

" + } + }, + "com.amazonaws.rds#DeleteDBInstanceAutomatedBackupResult": { + "type": "structure", + "members": { + "DBInstanceAutomatedBackup": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackup" + } + } + }, + "com.amazonaws.rds#DeleteDBInstanceMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "SkipFinalSnapshot": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance.\n If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, \n RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, \n and the DB snapshot is created.

\n \n

If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.

\n \n

When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, RDS can delete the instance only if you enable this parameter.

\n

If you delete a read replica or an RDS Custom instance, you must enable this setting.

\n

This setting is required for RDS Custom.

" + } + }, + "FinalDBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot\n parameter is disabled.

\n \n

If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.

\n \n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n " + } + }, + "DeleteAutomatedBackups": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to remove automated backups immediately after the DB\n instance is deleted. This parameter isn't case-sensitive. The default is to remove \n automated backups immediately after the DB instance is deleted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DeleteDBInstanceResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + } + }, + "com.amazonaws.rds#DeleteDBParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBParameterGroupMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.

" + } + }, + "com.amazonaws.rds#DeleteDBParameterGroupMessage": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DeleteDBProxy": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBProxyRequest" + }, + "output": { + "target": "com.amazonaws.rds#DeleteDBProxyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an existing DB proxy.

" + } + }, + "com.amazonaws.rds#DeleteDBProxyEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBProxyEndpointRequest" + }, + "output": { + "target": "com.amazonaws.rds#DeleteDBProxyEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyEndpointNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyEndpointStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a DBProxyEndpoint. Doing so removes the ability to access the DB proxy using the\n endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write\n or read-only operations, or using a different VPC than the DB proxy's default VPC.

" + } + }, + "com.amazonaws.rds#DeleteDBProxyEndpointRequest": { + "type": "structure", + "members": { + "DBProxyEndpointName": { + "target": "com.amazonaws.rds#DBProxyEndpointName", + "traits": { + "smithy.api#documentation": "

The name of the DB proxy endpoint to delete.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.rds#DeleteDBProxyEndpointResponse": { + "type": "structure", + "members": { + "DBProxyEndpoint": { + "target": "com.amazonaws.rds#DBProxyEndpoint", + "traits": { + "smithy.api#documentation": "

The data structure representing the details of the DB proxy endpoint that you delete.

" + } + } + } + }, + "com.amazonaws.rds#DeleteDBProxyRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB proxy to delete.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.rds#DeleteDBProxyResponse": { + "type": "structure", + "members": { + "DBProxy": { + "target": "com.amazonaws.rds#DBProxy", + "traits": { + "smithy.api#documentation": "

The data structure representing the details of the DB proxy that you delete.

" + } + } + } + }, + "com.amazonaws.rds#DeleteDBSecurityGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBSecurityGroupMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a DB security group.

\n

The specified DB security group must not be associated with any DB instances.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring ā€“ \n Hereā€™s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n " + } + }, + "com.amazonaws.rds#DeleteDBSecurityGroupMessage": { + "type": "structure", + "members": { + "DBSecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB security group to delete.

\n \n

You can't delete the default DB security group.

\n \n

Constraints:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DeleteDBSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#DeleteDBSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a DB snapshot. If the snapshot is being copied, the copy operation is\n terminated.

\n \n

The DB snapshot must be in the available state to be deleted.

\n " + } + }, + "com.amazonaws.rds#DeleteDBSnapshotMessage": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB snapshot identifier.

\n

Constraints: Must be the name of an existing DB snapshot in the available state.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DeleteDBSnapshotResult": { + "type": "structure", + "members": { + "DBSnapshot": { + "target": "com.amazonaws.rds#DBSnapshot" + } + } + }, + "com.amazonaws.rds#DeleteDBSubnetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteDBSubnetGroupMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSubnetGroupStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSubnetStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a DB subnet group.

\n \n

The specified database subnet group must not be associated with any DB instances.

\n " + } + }, + "com.amazonaws.rds#DeleteDBSubnetGroupMessage": { + "type": "structure", + "members": { + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database subnet group to delete.

\n \n

You can't delete the default subnet group.

\n \n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mydbsubnetgroup\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DeleteEventSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteEventSubscriptionMessage" + }, + "output": { + "target": "com.amazonaws.rds#DeleteEventSubscriptionResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#InvalidEventSubscriptionStateFault" + }, + { + "target": "com.amazonaws.rds#SubscriptionNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an RDS event notification subscription.

" + } + }, + "com.amazonaws.rds#DeleteEventSubscriptionMessage": { + "type": "structure", + "members": { + "SubscriptionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the RDS event notification subscription you want to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DeleteEventSubscriptionResult": { + "type": "structure", + "members": { + "EventSubscription": { + "target": "com.amazonaws.rds#EventSubscription" + } + } + }, + "com.amazonaws.rds#DeleteGlobalCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteGlobalClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#DeleteGlobalClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a global database cluster. The primary and secondary clusters must already be detached or\n destroyed first.

\n \n

This action only applies to Aurora DB clusters.

\n " + } + }, + "com.amazonaws.rds#DeleteGlobalClusterMessage": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The cluster identifier of the global database cluster being deleted.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.rds#DeleteGlobalClusterResult": { + "type": "structure", + "members": { + "GlobalCluster": { + "target": "com.amazonaws.rds#GlobalCluster" + } + } + }, + "com.amazonaws.rds#DeleteOptionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteOptionGroupMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#InvalidOptionGroupStateFault" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an existing option group.

" + } + }, + "com.amazonaws.rds#DeleteOptionGroupMessage": { + "type": "structure", + "members": { + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group to be deleted.

\n \n

You can't delete default option groups.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DeregisterDBProxyTargets": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeregisterDBProxyTargetsRequest" + }, + "output": { + "target": "com.amazonaws.rds#DeregisterDBProxyTargetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.

" + } + }, + "com.amazonaws.rds#DeregisterDBProxyTargetsRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DBProxy that is associated with the DBProxyTargetGroup.

", + "smithy.api#required": {} + } + }, + "TargetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DBProxyTargetGroup.

" + } + }, + "DBInstanceIdentifiers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

One or more DB instance identifiers.

" + } + }, + "DBClusterIdentifiers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

One or more DB cluster identifiers.

" + } + } + } + }, + "com.amazonaws.rds#DeregisterDBProxyTargetsResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.rds#DescribeAccountAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeAccountAttributesMessage" + }, + "output": { + "target": "com.amazonaws.rds#AccountAttributesMessage" + }, + "traits": { + "smithy.api#documentation": "

Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

\n

This command doesn't take any parameters.

" + } + }, + "com.amazonaws.rds#DescribeAccountAttributesMessage": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeBlueGreenDeployments": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeBlueGreenDeploymentsRequest" + }, + "output": { + "target": "com.amazonaws.rds#DescribeBlueGreenDeploymentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about blue/green deployments.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "BlueGreenDeployments", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeBlueGreenDeploymentsRequest": { + "type": "structure", + "members": { + "BlueGreenDeploymentIdentifier": { + "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", + "traits": { + "smithy.api#documentation": "

The blue/green deployment identifier. If this parameter is specified, information from only the \n specific blue/green deployment is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n " + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more blue/green deployments to describe.

\n

Supported filters:

\n " + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeBlueGreenDeployments request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + } + } + }, + "com.amazonaws.rds#DescribeBlueGreenDeploymentsResponse": { + "type": "structure", + "members": { + "BlueGreenDeployments": { + "target": "com.amazonaws.rds#BlueGreenDeploymentList", + "traits": { + "smithy.api#documentation": "

Contains a list of blue/green deployments for the user.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a later DescribeBlueGreenDeployments request.

" + } + } + } + }, + "com.amazonaws.rds#DescribeCertificates": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeCertificatesMessage" + }, + "output": { + "target": "com.amazonaws.rds#CertificateMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#CertificateNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Certificates", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeCertificatesMessage": { + "type": "structure", + "members": { + "CertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n " + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeCertificates request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeDBClusterBacktracks": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBClusterBacktracksMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterBacktrackMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterBacktrackNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about backtracks for a DB cluster.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora MySQL DB clusters.

\n ", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBClusterBacktracks", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBClusterBacktracksMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier of the DB cluster to be described. This parameter is\n stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster1\n

", + "smithy.api#required": {} + } + }, + "BacktrackIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If specified, this value is the backtrack identifier of the backtrack to be\n described.

\n

Constraints:

\n \n

Example: 123e4567-e89b-12d3-a456-426655440000\n

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more DB clusters to describe. Supported filters\n include the following:

\n " + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterBacktracks request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeDBClusterEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBClusterEndpointsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterEndpointMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about endpoints for an Amazon Aurora DB cluster.

\n \n

This action only applies to Aurora DB clusters.

\n ", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBClusterEndpoints", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBClusterEndpointsMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is\n stored as a lowercase string.

" + } + }, + "DBClusterEndpointIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the endpoint to describe. This parameter is stored as a lowercase string.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A set of name-value pairs that define which endpoints to include in the output.\n The filters are specified as name-value pairs, in the format\n Name=endpoint_type,Values=endpoint_type1,endpoint_type2,....\n Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status.\n Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom.\n Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any.\n Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterEndpoints request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + } + }, + "com.amazonaws.rds#DescribeDBClusterParameterGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBClusterParameterGroupsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterParameterGroupsMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of DBClusterParameterGroup descriptions. If a \n DBClusterParameterGroupName parameter is specified,\n the list will contain only the description of the specified DB cluster parameter group.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBClusterParameterGroups", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBClusterParameterGroupsMessage": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of a specific DB cluster parameter group to return details for.

\n

Constraints:

\n " + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeDBClusterParameters": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBClusterParametersMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterParameterGroupDetails" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the detailed parameter list for a particular DB cluster parameter group.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Parameters", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBClusterParametersMessage": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of a specific DB cluster parameter group to return parameter details for.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "Source": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value that indicates to return only parameters for a specific source. \n Parameter sources can be engine, service,\n or customer.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeDBClusterSnapshotAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBClusterSnapshotAttributesMessage" + }, + "output": { + "target": "com.amazonaws.rds#DescribeDBClusterSnapshotAttributesResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

\n

When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes\n returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are \n authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB cluster snapshot is public and\n can be copied or restored by all Amazon Web Services accounts.

\n

To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the\n manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

" + } + }, + "com.amazonaws.rds#DescribeDBClusterSnapshotAttributesMessage": { + "type": "structure", + "members": { + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the DB cluster snapshot to describe the attributes for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeDBClusterSnapshotAttributesResult": { + "type": "structure", + "members": { + "DBClusterSnapshotAttributesResult": { + "target": "com.amazonaws.rds#DBClusterSnapshotAttributesResult" + } + } + }, + "com.amazonaws.rds#DescribeDBClusterSnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBClusterSnapshotsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterSnapshotMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about DB cluster snapshots. This API action supports pagination.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBClusterSnapshots", + "pageSize": "MaxRecords" + }, + "smithy.waiters#waitable": { + "DBClusterSnapshotAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "deleted", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "deleting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "failed", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "incompatible-restore", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "incompatible-parameters", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + }, + "DBClusterSnapshotDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(DBClusterSnapshots) == `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "DBClusterSnapshotNotFoundFault" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "creating", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "modifying", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "rebooting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusterSnapshots[].Status", + "expected": "resetting-master-credentials", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.rds#DescribeDBClusterSnapshotsMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. \n This parameter can't be used in conjunction with the\n DBClusterSnapshotIdentifier parameter.\n This parameter isn't case-sensitive.

\n

Constraints:

\n " + } + }, + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A specific DB cluster snapshot identifier to describe. \n This parameter can't be used in conjunction with the\n DBClusterIdentifier parameter. \n This value is stored as a lowercase string.

\n

Constraints:

\n " + } + }, + "SnapshotType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of DB cluster snapshots to be returned. You can specify one of the following values:

\n \n

If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are\n returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared\n parameter. You can include public DB cluster snapshots with these results by enabling the \n IncludePublic parameter.

\n

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more DB cluster snapshots to describe.

\n

Supported filters:

\n " + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusterSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "IncludeShared": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.

\n

You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from\n another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.

" + } + }, + "IncludePublic": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.

\n

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeDBClusters": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBClustersMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

\n

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBClusters", + "pageSize": "MaxRecords" + }, + "smithy.waiters#waitable": { + "DBClusterAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "deleted", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "deleting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "failed", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "incompatible-restore", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "incompatible-parameters", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + }, + "DBClusterDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(DBClusters) == `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "DBClusterNotFoundFault" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "creating", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "modifying", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "rebooting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBClusters[].Status", + "expected": "resetting-master-credentials", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.rds#DescribeDBClustersMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, \n information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n " + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more DB clusters to describe.

\n

Supported filters:

\n " + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBClusters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "IncludeShared": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Optional Boolean parameter that specifies whether the output includes information about clusters\n shared from other Amazon Web Services accounts.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeDBEngineVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBEngineVersionsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBEngineVersionMessage" + }, + "traits": { + "smithy.api#documentation": "

Returns a list of the available DB engines.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBEngineVersions", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBEngineVersionsMessage": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine to return.

\n

Valid Values:

\n " + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine version to return.

\n

Example: 5.1.49\n

" + } + }, + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of a specific DB parameter group family to return details for.

\n

Constraints:

\n " + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more DB engine versions to describe.

\n

Supported filters:

\n " + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "DefaultOnly": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.

" + } + }, + "ListSupportedCharacterSets": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to list the supported character sets for each engine version.

\n

If this parameter is enabled and the requested engine supports the CharacterSetName parameter for\n CreateDBInstance, the response includes a list of supported character sets for each engine\n version.

\n

For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets\n to true, RDS Custom returns no results.

" + } + }, + "ListSupportedTimezones": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to list the supported time zones for each engine version.

\n

If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, \n the response includes a list of supported time zones for each engine version.

\n

For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones\n to true, RDS Custom returns no results.

" + } + }, + "IncludeAll": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.

" + } + } + } + }, + "com.amazonaws.rds#DescribeDBInstanceAutomatedBackups": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBInstanceAutomatedBackupsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Displays backups for both current and deleted\n instances. For example, use this operation to\n find details about automated backups for previously deleted instances. Current instances\n with retention periods greater than zero (0) are returned for both the \n DescribeDBInstanceAutomatedBackups and\n DescribeDBInstances operations.

\n

All parameters are optional.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBInstanceAutomatedBackups", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBInstanceAutomatedBackupsMessage": { + "type": "structure", + "members": { + "DbiResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The resource ID of the DB instance that is the source of \n the automated backup. This parameter isn't case-sensitive.

" + } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

(Optional) The user-supplied instance identifier. If this parameter is specified, it must\n match the identifier of an existing DB instance. It returns information from the\n specific DB instance' automated backup. This parameter isn't case-sensitive.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies which resources to return based on status.

\n

Supported filters are the following:

\n \n

Returns all resources by default. The status for each resource is specified in the response.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified \n MaxRecords value, a pagination token called a marker is included in the response so that \n you can retrieve the remaining results.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The pagination token provided in the previous request. If this parameter is specified the response \n includes only records beyond the marker, up to MaxRecords.

" + } + }, + "DBInstanceAutomatedBackupsArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicated automated backups, for example,\n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

\n

This setting doesn't apply to RDS Custom.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Parameter input for DescribeDBInstanceAutomatedBackups.

" + } + }, + "com.amazonaws.rds#DescribeDBInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBInstancesMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBInstanceMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about provisioned RDS instances. This API supports pagination.

\n \n

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

\n ", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBInstances", + "pageSize": "MaxRecords" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "DBInstanceAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "deleted", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "deleting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "failed", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "incompatible-restore", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "incompatible-parameters", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + }, + "DBInstanceDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(DBInstances) == `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "DBInstanceNotFound" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "creating", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "modifying", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "rebooting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBInstances[].DBInstanceStatus", + "expected": "resetting-master-credentials", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.rds#DescribeDBInstancesMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, \n information from only the specific DB instance is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n " + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more DB instances to describe.

\n

Supported filters:

\n " + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBInstances request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeDBLogFiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBLogFilesMessage" + }, + "output": { + "target": "com.amazonaws.rds#DescribeDBLogFilesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of DB log files for the DB instance.

\n

This command doesn't apply to RDS Custom.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DescribeDBLogFiles", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBLogFilesDetails": { + "type": "structure", + "members": { + "LogFileName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the log file for the specified DB instance.

" + } + }, + "LastWritten": { + "target": "com.amazonaws.rds#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

A POSIX timestamp when the last log entry was written.

" + } + }, + "Size": { + "target": "com.amazonaws.rds#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The size, in bytes, of the log file for the specified DB instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element to DescribeDBLogFiles.

" + } + }, + "com.amazonaws.rds#DescribeDBLogFilesList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DescribeDBLogFilesDetails", + "traits": { + "smithy.api#xmlName": "DescribeDBLogFilesDetails" + } + } + }, + "com.amazonaws.rds#DescribeDBLogFilesMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The customer-assigned name of the DB instance that contains the log files you want to list.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "FilenameContains": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Filters the available log files for log file names that contain the specified string.

" + } + }, + "FileLastWritten": { + "target": "com.amazonaws.rds#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

" + } + }, + "FileSize": { + "target": "com.amazonaws.rds#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Filters the available log files for files larger than the specified size.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeDBLogFilesResponse": { + "type": "structure", + "members": { + "DescribeDBLogFiles": { + "target": "com.amazonaws.rds#DescribeDBLogFilesList", + "traits": { + "smithy.api#documentation": "

The DB log files returned.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a later DescribeDBLogFiles request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The response from a call to DescribeDBLogFiles.

" + } + }, + "com.amazonaws.rds#DescribeDBParameterGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBParameterGroupsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBParameterGroupsMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified,\n the list will contain only the description of the specified DB parameter group.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBParameterGroups", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBParameterGroupsMessage": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of a specific DB parameter group to return details for.

\n

Constraints:

\n " + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeDBParameters": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBParametersMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBParameterGroupDetails" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the detailed parameter list for a particular DB parameter group.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Parameters", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBParametersMessage": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of a specific DB parameter group to return details for.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "Source": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The parameter types to return.

\n

Default: All parameter types returned

\n

Valid Values: user | system | engine-default\n

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + } + }, + "com.amazonaws.rds#DescribeDBProxies": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBProxiesRequest" + }, + "output": { + "target": "com.amazonaws.rds#DescribeDBProxiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about DB proxies.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBProxies", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBProxiesRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB proxy. If you omit this parameter,\n the output includes information about all DB proxies owned by\n your Amazon Web Services account ID.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter is not currently supported.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + } + } + }, + "com.amazonaws.rds#DescribeDBProxiesResponse": { + "type": "structure", + "members": { + "DBProxies": { + "target": "com.amazonaws.rds#DBProxyList", + "traits": { + "smithy.api#documentation": "

A return value representing an arbitrary number of DBProxy data structures.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + } + }, + "com.amazonaws.rds#DescribeDBProxyEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBProxyEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.rds#DescribeDBProxyEndpointsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyEndpointNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about DB proxy endpoints.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBProxyEndpoints", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBProxyEndpointsRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#DBProxyName", + "traits": { + "smithy.api#documentation": "

The name of the DB proxy whose endpoints you want to describe. If you omit\n this parameter, the output includes information about all DB proxy endpoints\n associated with all your DB proxies.

" + } + }, + "DBProxyEndpointName": { + "target": "com.amazonaws.rds#DBProxyEndpointName", + "traits": { + "smithy.api#documentation": "

The name of a DB proxy endpoint to describe. If you omit this parameter,\n the output includes information about all DB proxy endpoints associated with\n the specified proxy.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter is not currently supported.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + } + } + }, + "com.amazonaws.rds#DescribeDBProxyEndpointsResponse": { + "type": "structure", + "members": { + "DBProxyEndpoints": { + "target": "com.amazonaws.rds#DBProxyEndpointList", + "traits": { + "smithy.api#documentation": "

The list of ProxyEndpoint objects returned by the API operation.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + } + }, + "com.amazonaws.rds#DescribeDBProxyTargetGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBProxyTargetGroupsRequest" + }, + "output": { + "target": "com.amazonaws.rds#DescribeDBProxyTargetGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "TargetGroups", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBProxyTargetGroupsRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DBProxy associated with the target group.

", + "smithy.api#required": {} + } + }, + "TargetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DBProxyTargetGroup to describe.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter is not currently supported.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + } + } + }, + "com.amazonaws.rds#DescribeDBProxyTargetGroupsResponse": { + "type": "structure", + "members": { + "TargetGroups": { + "target": "com.amazonaws.rds#TargetGroupList", + "traits": { + "smithy.api#documentation": "

An arbitrary number of DBProxyTargetGroup objects, containing details of the corresponding target groups.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + } + }, + "com.amazonaws.rds#DescribeDBProxyTargets": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBProxyTargetsRequest" + }, + "output": { + "target": "com.amazonaws.rds#DescribeDBProxyTargetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about DBProxyTarget objects. This API supports pagination.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Targets", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBProxyTargetsRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DBProxyTarget to describe.

", + "smithy.api#required": {} + } + }, + "TargetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DBProxyTargetGroup to describe.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter is not currently supported.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + } + } + }, + "com.amazonaws.rds#DescribeDBProxyTargetsResponse": { + "type": "structure", + "members": { + "Targets": { + "target": "com.amazonaws.rds#TargetList", + "traits": { + "smithy.api#documentation": "

An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + } + }, + "com.amazonaws.rds#DescribeDBSecurityGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBSecurityGroupsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBSecurityGroupMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified,\n the list will contain only the descriptions of the specified DB security group.

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring ā€“ \n Hereā€™s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n ", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBSecurityGroups", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBSecurityGroupsMessage": { + "type": "structure", + "members": { + "DBSecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB security group to return details for.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBSecurityGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeDBSnapshotAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBSnapshotAttributesMessage" + }, + "output": { + "target": "com.amazonaws.rds#DescribeDBSnapshotAttributesResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

\n

When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes\n returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are \n authorized to copy or restore the manual DB snapshot. If all is included in the list of\n values for the restore attribute, then the manual DB snapshot is public and\n can be copied or restored by all Amazon Web Services accounts.

\n

To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the\n manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

" + } + }, + "com.amazonaws.rds#DescribeDBSnapshotAttributesMessage": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the DB snapshot to describe the attributes for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeDBSnapshotAttributesResult": { + "type": "structure", + "members": { + "DBSnapshotAttributesResult": { + "target": "com.amazonaws.rds#DBSnapshotAttributesResult" + } + } + }, + "com.amazonaws.rds#DescribeDBSnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBSnapshotsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBSnapshotMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about DB snapshots. This API action supports pagination.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBSnapshots", + "pageSize": "MaxRecords" + }, + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "DBSnapshotAvailable": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "available", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "deleted", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "deleting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "failed", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "incompatible-restore", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "incompatible-parameters", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + }, + "DBSnapshotDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(DBSnapshots) == `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "DBSnapshotNotFound" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "creating", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "modifying", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "rebooting", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "DBSnapshots[].Status", + "expected": "resetting-master-credentials", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.rds#DescribeDBSnapshotsMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ID of the DB instance to retrieve the list of DB snapshots for. \n This parameter isn't case-sensitive.

\n

Constraints:

\n " + } + }, + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A specific DB snapshot identifier to describe.\n This value is stored as a lowercase string.

\n

Constraints:

\n " + } + }, + "SnapshotType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of snapshots to be returned. You can specify one of the following values:

\n \n

If you don't specify a SnapshotType value, then both automated and manual snapshots are\n returned. Shared and public DB snapshots are not included in the returned results by default.\n You can include shared snapshots with these results by enabling the IncludeShared\n parameter. You can include public snapshots with these results by enabling the \n IncludePublic parameter.

\n

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values\n of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is\n set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to\n public.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more DB snapshots to describe.

\n

Supported filters:

\n " + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeDBSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "IncludeShared": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.

\n

You can give an Amazon Web Services account permission to restore a manual DB snapshot from\n another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "IncludePublic": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.

\n

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "DbiResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A specific DB resource ID to describe.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeDBSubnetGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeDBSubnetGroupsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBSubnetGroupMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

\n

For an overview of CIDR ranges, go to the \n Wikipedia Tutorial.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBSubnetGroups", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeDBSubnetGroupsMessage": { + "type": "structure", + "members": { + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB subnet group to return details for.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeDBSubnetGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeEngineDefaultClusterParameters": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeEngineDefaultClusterParametersMessage" + }, + "output": { + "target": "com.amazonaws.rds#DescribeEngineDefaultClusterParametersResult" + }, + "traits": { + "smithy.api#documentation": "

Returns the default engine and system parameter information for the cluster database engine.

\n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

" + } + }, + "com.amazonaws.rds#DescribeEngineDefaultClusterParametersMessage": { + "type": "structure", + "members": { + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group family to return engine parameter information for.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeEngineDefaultClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeEngineDefaultClusterParametersResult": { + "type": "structure", + "members": { + "EngineDefaults": { + "target": "com.amazonaws.rds#EngineDefaults" + } + } + }, + "com.amazonaws.rds#DescribeEngineDefaultParameters": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeEngineDefaultParametersMessage" + }, + "output": { + "target": "com.amazonaws.rds#DescribeEngineDefaultParametersResult" + }, + "traits": { + "smithy.api#documentation": "

Returns the default engine and system parameter information for the specified database engine.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "EngineDefaults.Marker", + "items": "EngineDefaults.Parameters", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeEngineDefaultParametersMessage": { + "type": "structure", + "members": { + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group family.

\n

Valid Values:

\n ", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeEngineDefaultParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeEngineDefaultParametersResult": { + "type": "structure", + "members": { + "EngineDefaults": { + "target": "com.amazonaws.rds#EngineDefaults" + } + } + }, + "com.amazonaws.rds#DescribeEventCategories": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeEventCategoriesMessage" + }, + "output": { + "target": "com.amazonaws.rds#EventCategoriesMessage" + }, + "traits": { + "smithy.api#documentation": "

Displays a list of categories for all event source types, or, if specified, for a specified source type.\n You can also see this list in the \"Amazon RDS event categories and event messages\" section of the \n Amazon RDS User Guide\n or the\n \n Amazon Aurora User Guide\n .

" + } + }, + "com.amazonaws.rds#DescribeEventCategoriesMessage": { + "type": "structure", + "members": { + "SourceType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of source that is generating the events. For RDS Proxy events, specify db-proxy.

\n

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeEventSubscriptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeEventSubscriptionsMessage" + }, + "output": { + "target": "com.amazonaws.rds#EventSubscriptionsMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#SubscriptionNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the subscription descriptions for a customer account. The description for a subscription includes \n SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

\n

If you specify a SubscriptionName, lists the description for that subscription.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "EventSubscriptionsList", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeEventSubscriptionsMessage": { + "type": "structure", + "members": { + "SubscriptionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the RDS event notification subscription you want to describe.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeEventsMessage" + }, + "output": { + "target": "com.amazonaws.rds#EventsMessage" + }, + "traits": { + "smithy.api#documentation": "

Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. \n Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be \n obtained by providing the name as a parameter.

\n

For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora\n events in the Amazon Aurora User Guide.

\n \n

By default, RDS returns events that were generated in the past hour.

\n ", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Events", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeEventsMessage": { + "type": "structure", + "members": { + "SourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

\n

Constraints:

\n " + } + }, + "SourceType": { + "target": "com.amazonaws.rds#SourceType", + "traits": { + "smithy.api#documentation": "

The event source to retrieve events for. If no value is specified, all events are returned.

" + } + }, + "StartTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The beginning of the time interval to retrieve events for,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

\n

Example: 2009-07-08T18:00Z

" + } + }, + "EndTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The end of the time interval for which to retrieve events,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

\n

Example: 2009-07-08T18:00Z

" + } + }, + "Duration": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of minutes to retrieve events for.

\n

Default: 60

" + } + }, + "EventCategories": { + "target": "com.amazonaws.rds#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

A list of event categories that trigger notifications for a event notification subscription.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeEvents request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeExportTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeExportTasksMessage" + }, + "output": { + "target": "com.amazonaws.rds#ExportTasksMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#ExportTaskNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a snapshot export to Amazon S3. This API operation supports\n pagination.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "ExportTasks", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeExportTasksMessage": { + "type": "structure", + "members": { + "ExportTaskIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the snapshot export task to be described.

" + } + }, + "SourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to\n include in the output. Filter names and values are case-sensitive.

\n

Supported filters include the following:

\n " + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeExportTasks request.\n If you specify this parameter, the response includes only records beyond the marker,\n up to the value specified by the MaxRecords parameter.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the \n specified value, a pagination token called a marker is included in the response. \n You can use the marker in a later DescribeExportTasks request \n to retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "SourceType": { + "target": "com.amazonaws.rds#ExportSourceType", + "traits": { + "smithy.api#documentation": "

The type of source for the export.

" + } + } + } + }, + "com.amazonaws.rds#DescribeGlobalClusters": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeGlobalClustersMessage" + }, + "output": { + "target": "com.amazonaws.rds#GlobalClustersMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about Aurora global database clusters. This API supports pagination.

\n

For more information on Amazon Aurora, see What is Amazon Aurora? in the\n Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters.

\n ", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "GlobalClusters", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeGlobalClustersMessage": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n " + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified\n MaxRecords value, a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeGlobalClusters request. If\n this parameter is specified, the response includes only records beyond the marker, up to the value\n specified by MaxRecords.

" + } + } + } + }, + "com.amazonaws.rds#DescribeOptionGroupOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeOptionGroupOptionsMessage" + }, + "output": { + "target": "com.amazonaws.rds#OptionGroupOptionsMessage" + }, + "traits": { + "smithy.api#documentation": "

Describes all available options.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "OptionGroupOptions", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeOptionGroupOptionsMessage": { + "type": "structure", + "members": { + "EngineName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A required parameter. Options available for the given engine name are described.

\n

Valid Values:

\n ", + "smithy.api#required": {} + } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If specified, filters the results to include only options for the specified major engine version.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeOptionGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeOptionGroupsMessage" + }, + "output": { + "target": "com.amazonaws.rds#OptionGroups" + }, + "errors": [ + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the available option groups.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "OptionGroupsList", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeOptionGroupsMessage": { + "type": "structure", + "members": { + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeOptionGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "EngineName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Filters the list of option groups to only include groups associated with a specific database engine.

\n

Valid Values:

\n " + } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeOrderableDBInstanceOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeOrderableDBInstanceOptionsMessage" + }, + "output": { + "target": "com.amazonaws.rds#OrderableDBInstanceOptionsMessage" + }, + "traits": { + "smithy.api#documentation": "

Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "OrderableDBInstanceOptions", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeOrderableDBInstanceOptionsMessage": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the engine to retrieve DB instance options for.

\n

Valid Values:

\n ", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The license model filter value. Specify this parameter to show only the available offerings \n matching the specified license model.

\n

RDS Custom supports only the BYOL licensing model.

" + } + }, + "AvailabilityZoneGroup": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.

\n

Omit this parameter to show the available offerings in the specified Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "Vpc": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports \n only VPC offerings.

\n

RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output \n shows VPC offerings.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 10000.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribePendingMaintenanceActions": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribePendingMaintenanceActionsMessage" + }, + "output": { + "target": "com.amazonaws.rds#PendingMaintenanceActionsMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "PendingMaintenanceActions", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribePendingMaintenanceActionsMessage": { + "type": "structure", + "members": { + "ResourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN of a resource to return pending maintenance actions for.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more resources to return pending maintenance actions for.

\n

Supported filters:

\n " + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribePendingMaintenanceActions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to a number of records specified by MaxRecords.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that\n you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeReservedDBInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeReservedDBInstancesMessage" + }, + "output": { + "target": "com.amazonaws.rds#ReservedDBInstanceMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#ReservedDBInstanceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "ReservedDBInstances", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeReservedDBInstancesMessage": { + "type": "structure", + "members": { + "ReservedDBInstanceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

" + } + }, + "ReservedDBInstancesOfferingId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

" + } + }, + "Duration": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

\n

Valid Values: 1 | 3 | 31536000 | 94608000\n

" + } + }, + "ProductDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

" + } + }, + "OfferingType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

\n

Valid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\" \n

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to show only those reservations that support Multi-AZ.

" + } + }, + "LeaseId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.

\n \n

Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

\n " + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeReservedDBInstancesOfferings": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeReservedDBInstancesOfferingsMessage" + }, + "output": { + "target": "com.amazonaws.rds#ReservedDBInstancesOfferingMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#ReservedDBInstancesOfferingNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Lists available reserved DB instance offerings.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "ReservedDBInstancesOfferings", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeReservedDBInstancesOfferingsMessage": { + "type": "structure", + "members": { + "ReservedDBInstancesOfferingId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

\n

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706\n

" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

" + } + }, + "Duration": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

\n

Valid Values: 1 | 3 | 31536000 | 94608000\n

" + } + }, + "ProductDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.

\n \n

The results show offerings that partially match the filter value.

\n " + } + }, + "OfferingType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

\n

Valid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\" \n

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to show only those reservations that support Multi-AZ.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeSourceRegions": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeSourceRegionsMessage" + }, + "output": { + "target": "com.amazonaws.rds#SourceRegionMessage" + }, + "traits": { + "smithy.api#documentation": "

Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, \n copy a DB snapshot from, or replicate automated backups from.

\n

Use this operation to determine whether cross-Region features are supported between other Regions \n and your current Region. This operation supports pagination.

\n

To return information about the Regions that are enabled for your account, or all Regions, \n use the EC2 operation DescribeRegions. For more information, see \n \n DescribeRegions in the Amazon EC2 API Reference.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "SourceRegions", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.rds#DescribeSourceRegionsMessage": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The source Amazon Web Services Region name. For example, us-east-1.

\n

Constraints:

\n " + } + }, + "MaxRecords": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist\n than the specified MaxRecords value, a pagination token called a marker is\n included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeSourceRegions request. If this parameter is specified, the response\n includes only records beyond the marker, up to the value specified by\n MaxRecords.

" + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeValidDBInstanceModifications": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DescribeValidDBInstanceModificationsMessage" + }, + "output": { + "target": "com.amazonaws.rds#DescribeValidDBInstanceModificationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to \n your DB instance. You can use this information when you call ModifyDBInstance.

\n

This command doesn't apply to RDS Custom.

" + } + }, + "com.amazonaws.rds#DescribeValidDBInstanceModificationsMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The customer identifier or the ARN of your DB instance.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#DescribeValidDBInstanceModificationsResult": { + "type": "structure", + "members": { + "ValidDBInstanceModificationsMessage": { + "target": "com.amazonaws.rds#ValidDBInstanceModificationsMessage" + } + } + }, + "com.amazonaws.rds#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.rds#DomainMembership": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the Active Directory Domain.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.

" + } + }, + "FQDN": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The fully qualified domain name of the Active Directory Domain.

" + } + }, + "IAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the IAM role to be used when making API calls to the Directory Service.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Active Directory Domain membership record associated with the DB instance or cluster.

" + } + }, + "com.amazonaws.rds#DomainMembershipList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DomainMembership", + "traits": { + "smithy.api#xmlName": "DomainMembership" + } + } + }, + "com.amazonaws.rds#DomainNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DomainNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

\n Domain doesn't refer to an existing Active Directory domain.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#Double": { + "type": "double", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.rds#DoubleOptional": { + "type": "double" + }, + "com.amazonaws.rds#DoubleRange": { + "type": "structure", + "members": { + "From": { + "target": "com.amazonaws.rds#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum value in the range.

" + } + }, + "To": { + "target": "com.amazonaws.rds#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum value in the range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A range of double values.

" + } + }, + "com.amazonaws.rds#DoubleRangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DoubleRange", + "traits": { + "smithy.api#xmlName": "DoubleRange" + } + } + }, + "com.amazonaws.rds#DownloadDBLogFilePortion": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DownloadDBLogFilePortionMessage" + }, + "output": { + "target": "com.amazonaws.rds#DownloadDBLogFilePortionDetails" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBLogFileNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Downloads all or a portion of the specified log file, up to 1 MB in size.

\n

This command doesn't apply to RDS Custom.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "pageSize": "NumberOfLines" + } + } + }, + "com.amazonaws.rds#DownloadDBLogFilePortionDetails": { + "type": "structure", + "members": { + "LogFileData": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Entries from the specified log file.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a later DownloadDBLogFilePortion request.

" + } + }, + "AdditionalDataPending": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Boolean value that if true, indicates there is more data to be downloaded.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element to DownloadDBLogFilePortion.

" + } + }, + "com.amazonaws.rds#DownloadDBLogFilePortionMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The customer-assigned name of the DB instance that contains the log files you want to list.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "LogFileName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the log file to be downloaded.

", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The pagination token provided in the previous request or \"0\". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.

" + } + }, + "NumberOfLines": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.

\n

If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning \n or the end of the log file, depending on the value of the Marker parameter.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#EC2SecurityGroup": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the status of the EC2 security group. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

" + } + }, + "EC2SecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the EC2 security group.

" + } + }, + "EC2SecurityGroupId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the id of the EC2 security group.

" + } + }, + "EC2SecurityGroupOwnerId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon Web Services ID of the owner of the EC2 security group\n specified in the EC2SecurityGroupName field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the following actions:

\n " + } + }, + "com.amazonaws.rds#EC2SecurityGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#EC2SecurityGroup", + "traits": { + "smithy.api#xmlName": "EC2SecurityGroup" + } + } + }, + "com.amazonaws.rds#Ec2ImagePropertiesNotSupportedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "Ec2ImagePropertiesNotSupportedFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The AMI configuration prerequisite has not been met.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#Endpoint": { + "type": "structure", + "members": { + "Address": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the DNS address of the DB instance.

" + } + }, + "Port": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Specifies the port that the database engine is listening on.

" + } + }, + "HostedZoneId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type represents the information you need to connect to an Amazon RDS DB instance.\n This data type is used as a response element in the following actions:

\n \n

For the data structure that represents Amazon Aurora DB cluster endpoints,\n see DBClusterEndpoint.

" + } + }, + "com.amazonaws.rds#EngineDefaults": { + "type": "structure", + "members": { + "DBParameterGroupFamily": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the DB parameter group family that the engine default parameters apply to.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n EngineDefaults request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .

" + } + }, + "Parameters": { + "target": "com.amazonaws.rds#ParametersList", + "traits": { + "smithy.api#documentation": "

Contains a list of engine default parameters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

" + } + }, + "com.amazonaws.rds#EngineFamily": { + "type": "enum", + "members": { + "MYSQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MYSQL" + } + }, + "POSTGRESQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSTGRESQL" + } + }, + "SQLSERVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQLSERVER" + } + } + } + }, + "com.amazonaws.rds#EngineModeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } + }, + "com.amazonaws.rds#Event": { + "type": "structure", + "members": { + "SourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the identifier for the source of the event.

" + } + }, + "SourceType": { + "target": "com.amazonaws.rds#SourceType", + "traits": { + "smithy.api#documentation": "

Specifies the source type for this event.

" + } + }, + "Message": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides the text of this event.

" + } + }, + "EventCategories": { + "target": "com.amazonaws.rds#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

Specifies the category for the event.

" + } + }, + "Date": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Specifies the date and time of the event.

" + } + }, + "SourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the event.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the DescribeEvents action.

" + } + }, + "com.amazonaws.rds#EventCategoriesList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "EventCategory" + } + } + }, + "com.amazonaws.rds#EventCategoriesMap": { + "type": "structure", + "members": { + "SourceType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The source type that the returned categories belong to

" + } + }, + "EventCategories": { + "target": "com.amazonaws.rds#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

The event categories for the specified source type

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the results of a successful invocation of the DescribeEventCategories\n operation.

" + } + }, + "com.amazonaws.rds#EventCategoriesMapList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#EventCategoriesMap", + "traits": { + "smithy.api#xmlName": "EventCategoriesMap" + } + } + }, + "com.amazonaws.rds#EventCategoriesMessage": { + "type": "structure", + "members": { + "EventCategoriesMapList": { + "target": "com.amazonaws.rds#EventCategoriesMapList", + "traits": { + "smithy.api#documentation": "

A list of EventCategoriesMap data types.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Data returned from the DescribeEventCategories operation.

" + } + }, + "com.amazonaws.rds#EventList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Event", + "traits": { + "smithy.api#xmlName": "Event" + } + } + }, + "com.amazonaws.rds#EventSubscription": { + "type": "structure", + "members": { + "CustomerAwsId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services customer account associated with the RDS event notification subscription.

" + } + }, + "CustSubscriptionId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The RDS event notification subscription Id.

" + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The topic ARN of the RDS event notification subscription.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the RDS event notification subscription.

\n

Constraints:

\n

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

\n

The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

" + } + }, + "SubscriptionCreationTime": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The time the RDS event notification subscription was created.

" + } + }, + "SourceType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The source type for the RDS event notification subscription.

" + } + }, + "SourceIdsList": { + "target": "com.amazonaws.rds#SourceIdsList", + "traits": { + "smithy.api#documentation": "

A list of source IDs for the RDS event notification subscription.

" + } + }, + "EventCategoriesList": { + "target": "com.amazonaws.rds#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

A list of event categories for the RDS event notification subscription.

" + } + }, + "Enabled": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

" + } + }, + "EventSubscriptionArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the event subscription.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

" + } + }, + "com.amazonaws.rds#EventSubscriptionQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventSubscriptionQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You have reached the maximum number of event subscriptions.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#EventSubscriptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#EventSubscription", + "traits": { + "smithy.api#xmlName": "EventSubscription" + } + } + }, + "com.amazonaws.rds#EventSubscriptionsMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "EventSubscriptionsList": { + "target": "com.amazonaws.rds#EventSubscriptionsList", + "traits": { + "smithy.api#documentation": "

A list of EventSubscriptions data types.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Data returned by the DescribeEventSubscriptions action.

" + } + }, + "com.amazonaws.rds#EventsMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous \n Events request.\n If this parameter is specified, the response includes\n only records beyond the marker, \n up to the value specified by MaxRecords.

" + } + }, + "Events": { + "target": "com.amazonaws.rds#EventList", + "traits": { + "smithy.api#documentation": "

A list of Event instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeEvents action.

" + } + }, + "com.amazonaws.rds#ExceptionMessage": { + "type": "string" + }, + "com.amazonaws.rds#ExportSourceType": { + "type": "enum", + "members": { + "SNAPSHOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SNAPSHOT" + } + }, + "CLUSTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLUSTER" + } + } + } + }, + "com.amazonaws.rds#ExportTask": { + "type": "structure", + "members": { + "ExportTaskIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A unique identifier for the snapshot export task. This ID isn't an identifier for\n the Amazon S3 bucket where the snapshot is exported to.

" + } + }, + "SourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

" + } + }, + "ExportOnly": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The data exported from the snapshot. Valid values are the following:

\n " + } + }, + "SnapshotTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time that the snapshot was created.

" + } + }, + "TaskStartTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time that the snapshot export task started.

" + } + }, + "TaskEndTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time that the snapshot export task completed.

" + } + }, + "S3Bucket": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket that the snapshot is exported to.

" + } + }, + "S3Prefix": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.

" + } + }, + "IamRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot when it's exported to\n Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export\n must have encryption and decryption permissions to use this KMS key.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The progress status of the export task.

" + } + }, + "PercentProgress": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The progress of the snapshot export task as a percentage.

" + } + }, + "TotalExtractedDataInGB": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total amount of data exported, in gigabytes.

" + } + }, + "FailureCause": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The reason the export failed, if it failed.

" + } + }, + "WarningMessage": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A warning about the snapshot export task.

" + } + }, + "SourceType": { + "target": "com.amazonaws.rds#ExportSourceType", + "traits": { + "smithy.api#documentation": "

The type of source for the export.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of a snapshot export to Amazon S3.

\n

This data type is used as a response element in the DescribeExportTasks action.

" + } + }, + "com.amazonaws.rds#ExportTaskAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ExportTaskAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You can't start an export task that's already running.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#ExportTaskNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ExportTaskNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The export task doesn't exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#ExportTasksList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#ExportTask", + "traits": { + "smithy.api#xmlName": "ExportTask" + } + } + }, + "com.amazonaws.rds#ExportTasksMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a later DescribeExportTasks\n request. A marker is used for pagination to identify the location to begin output for\n the next response of DescribeExportTasks.

" + } + }, + "ExportTasks": { + "target": "com.amazonaws.rds#ExportTasksList", + "traits": { + "smithy.api#documentation": "

Information about an export of a snapshot to Amazon S3.

" + } + } + } + }, + "com.amazonaws.rds#FailoverDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#FailoverDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#FailoverDBClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Forces a failover for a DB cluster.

\n

For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).

\n

For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances)\n in the DB cluster to be the primary DB instance (the cluster writer).

\n

An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists,\n when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby \n DB instance when the primary DB instance fails.

\n

To simulate a failure of a primary instance for testing, you can force a failover. \n Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing \n connections that use those endpoint addresses when the failover is complete.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" + } + }, + "com.amazonaws.rds#FailoverDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A DB cluster identifier to force a failover for. This parameter isn't case-sensitive.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "TargetDBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB instance to promote to the primary DB instance.

\n

Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster,\n for example mydbcluster-replica1.

\n

This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#FailoverDBClusterResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + } + }, + "com.amazonaws.rds#FailoverGlobalCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#FailoverGlobalClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#FailoverGlobalClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Initiates the failover process for an Aurora global database (GlobalCluster).

\n

A failover for an Aurora global database promotes one of secondary read-only DB clusters to be\n the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words,\n the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected\n secondary DB cluster assumes full read/write capabilities for the Aurora global database.

\n

For more information about failing over an Amazon Aurora global database, see\n Managed planned failover for Amazon Aurora global\n databases in the Amazon Aurora User Guide.

\n \n

This action applies to GlobalCluster (Aurora global databases) only. Use this action only on\n healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to\n reconfigure your Aurora global database topology.

\n " + } + }, + "com.amazonaws.rds#FailoverGlobalClusterMessage": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#GlobalClusterIdentifier", + "traits": { + "smithy.api#documentation": "

Identifier of the Aurora global database (GlobalCluster)\n that should be failed over. The identifier is the unique key assigned by\n the user when the Aurora global database was created. In other words,\n it's the name of the Aurora global database that you want to fail over.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "TargetDbClusterIdentifier": { + "target": "com.amazonaws.rds#DBClusterIdentifier", + "traits": { + "smithy.api#documentation": "

Identifier of the secondary Aurora DB cluster that you want to promote to primary for the Aurora\n global database (GlobalCluster.) Use the Amazon Resource Name (ARN) for the identifier so that\n Aurora can locate the cluster in its Amazon Web Services Region.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.rds#FailoverGlobalClusterResult": { + "type": "structure", + "members": { + "GlobalCluster": { + "target": "com.amazonaws.rds#GlobalCluster" + } + } + }, + "com.amazonaws.rds#FailoverState": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.rds#FailoverStatus", + "traits": { + "smithy.api#documentation": "

The current status of the Aurora global database (GlobalCluster). Possible values are as follows:

\n " + } + }, + "FromDbClusterArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this\n state.

" + } + }, + "ToDbClusterArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated\n with this state.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the state of scheduled or in-process failover operations on an\n Aurora global database (GlobalCluster). This Data type is empty unless a failover\n operation is scheduled or is currently underway on the Aurora global database.

" + } + }, + "com.amazonaws.rds#FailoverStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "FAILING_OVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failing-over" + } + }, + "CANCELLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelling" + } + } + } + }, + "com.amazonaws.rds#FeatureNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } + }, + "com.amazonaws.rds#Filter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the filter. Filter names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.rds#FilterValueList", + "traits": { + "smithy.api#documentation": "

One or more filter values. Filter values are case-sensitive.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter name and value pair that is used to return a more specific list of results \n from a describe operation. Filters can be used to match a set of resources by specific \n criteria, such as IDs. The filters supported by a describe operation are documented \n with the describe operation.

\n \n

Currently, wildcards are not supported in filters.

\n \n

The following actions can be filtered:

\n " + } + }, + "com.amazonaws.rds#FilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Filter", + "traits": { + "smithy.api#xmlName": "Filter" + } + } + }, + "com.amazonaws.rds#FilterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "Value" + } + } + }, + "com.amazonaws.rds#GlobalCluster": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Contains a user-supplied global database cluster identifier. This identifier is the unique key that\n identifies a global database cluster.

" + } + }, + "GlobalClusterResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in\n Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.

" + } + }, + "GlobalClusterArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the global database cluster.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the current state of this global database cluster.

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Aurora database engine used by the global database cluster.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Indicates the database engine version.

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The default database name within the new global database cluster.

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

The storage encryption setting for the global database cluster.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

The deletion protection setting for the new global database cluster.

" + } + }, + "GlobalClusterMembers": { + "target": "com.amazonaws.rds#GlobalClusterMemberList", + "traits": { + "smithy.api#documentation": "

The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to\n 1 item.

" + } + }, + "FailoverState": { + "target": "com.amazonaws.rds#FailoverState", + "traits": { + "smithy.api#documentation": "

A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database.\n This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database (GlobalCluster).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A data type representing an Aurora global database.

" + } + }, + "com.amazonaws.rds#GlobalClusterAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "GlobalClusterAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The GlobalClusterIdentifier already exists. Choose a new global database identifier (unique name) to create a new global database cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#GlobalClusterIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z][0-9A-Za-z-:._]*$" + } + }, + "com.amazonaws.rds#GlobalClusterList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#GlobalCluster", + "traits": { + "smithy.api#xmlName": "GlobalClusterMember" + } + } + }, + "com.amazonaws.rds#GlobalClusterMember": { + "type": "structure", + "members": { + "DBClusterArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for each Aurora cluster.

" + } + }, + "Readers": { + "target": "com.amazonaws.rds#ReadersArnList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for each read-only secondary cluster\n associated with the Aurora global database.

" + } + }, + "IsWriter": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the Aurora cluster is the primary cluster\n (that is, has read-write capability) for the Aurora global\n database with which it is associated.

" + } + }, + "GlobalWriteForwardingStatus": { + "target": "com.amazonaws.rds#WriteForwardingStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether a secondary cluster in an Aurora global database has\n write forwarding enabled, not enabled, or is in the process of enabling it.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A data structure with information about any primary and\n secondary clusters associated with an Aurora global database.

" + } + }, + "com.amazonaws.rds#GlobalClusterMemberList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#GlobalClusterMember", + "traits": { + "smithy.api#xmlName": "GlobalClusterMember" + } + } + }, + "com.amazonaws.rds#GlobalClusterNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "GlobalClusterNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The GlobalClusterIdentifier doesn't refer to an existing global database cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#GlobalClusterQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "GlobalClusterQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The number of global database clusters for this account is already at the maximum allowed.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#GlobalClustersMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeGlobalClusters request.\n If this parameter is specified, the response includes\n only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "GlobalClusters": { + "target": "com.amazonaws.rds#GlobalClusterList", + "traits": { + "smithy.api#documentation": "

The list of global clusters returned by this request.

" + } + } + } + }, + "com.amazonaws.rds#IAMAuthMode": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUIRED" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + } + } + }, + "com.amazonaws.rds#IPRange": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

" + } + }, + "CIDRIP": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the IP range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the DescribeDBSecurityGroups action.

" + } + }, + "com.amazonaws.rds#IPRangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#IPRange", + "traits": { + "smithy.api#xmlName": "IPRange" + } + } + }, + "com.amazonaws.rds#IamRoleMissingPermissionsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "IamRoleMissingPermissions", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The IAM role requires additional permissions to export to an Amazon S3 bucket.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#IamRoleNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "IamRoleNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The IAM role is missing for exporting to an Amazon S3 bucket.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#InstanceQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InstanceQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB\n instances.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InsufficientAvailableIPsInSubnetFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientAvailableIPsInSubnetFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The requested operation can't be performed because there aren't enough available IP addresses \n in the proxy's subnets. Add more CIDR blocks to the VPC or remove IP address that aren't required \n from the subnets.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InsufficientDBClusterCapacityFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientDBClusterCapacityFault", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

The DB cluster doesn't have enough capacity for the current operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.rds#InsufficientDBInstanceCapacityFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientDBInstanceCapacity", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified DB instance class isn't available in the specified Availability\n Zone.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InsufficientStorageClusterCapacityFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientStorageClusterCapacity", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

There is insufficient storage available for the current action. You might be able to\n resolve this error by updating your subnet group to use different Availability Zones\n that have more storage available.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#Integer": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.rds#IntegerOptional": { + "type": "integer" + }, + "com.amazonaws.rds#InvalidBlueGreenDeploymentStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidBlueGreenDeploymentStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The blue/green deployment can't be switched over or deleted because there is an invalid configuration in \n the green environment.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidCustomDBEngineVersionStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidCustomDBEngineVersionStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You can't delete the CEV.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBClusterCapacityFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBClusterCapacityFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

\n Capacity isn't a valid Aurora Serverless DB cluster\n capacity. Valid capacity values are 2, 4, 8, 16, \n 32, 64, 128, and 256.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBClusterEndpointStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBClusterEndpointStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The requested operation can't be performed on the endpoint while the endpoint is in this state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBClusterSnapshotStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The supplied value isn't a valid DB cluster snapshot state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBClusterStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBClusterStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The requested operation can't be performed while the cluster is in this state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBInstanceAutomatedBackupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBInstanceAutomatedBackupState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The automated backup is in an invalid state. \n For example, this automated backup is associated with an active instance.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBInstanceStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBInstanceState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB instance isn't in a valid state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBParameterGroupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBParameterGroupState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB parameter group is in use or is in an invalid state. If you are attempting\n to delete the parameter group, you can't delete it when the parameter group is in\n this state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBProxyEndpointStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBProxyEndpointStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You can't perform this operation while the DB proxy endpoint is in a particular state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBProxyStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBProxyStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The requested operation can't be performed while the proxy is in this state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBSecurityGroupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBSecurityGroupState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The state of the DB security group doesn't allow deletion.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBSnapshotStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBSnapshotState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The state of the DB snapshot doesn't allow deletion.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBSubnetGroupFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBSubnetGroupFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DBSubnetGroup doesn't belong to the same VPC as that of an existing\n cross-region read replica of the same source instance.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBSubnetGroupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBSubnetGroupStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB subnet group cannot be deleted because it's in use.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidDBSubnetStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDBSubnetStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB subnet isn't in the available state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidEventSubscriptionStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidEventSubscriptionState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

This error can occur if someone else is modifying a subscription. You should retry the action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidExportOnlyFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidExportOnly", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The export is invalid for exporting to an Amazon S3 bucket.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidExportSourceStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidExportSourceState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidExportTaskStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidExportTaskStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You can't cancel an export task that has completed.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidGlobalClusterStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidGlobalClusterStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The global cluster is in an invalid state and can't perform the requested operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidOptionGroupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidOptionGroupStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The option group isn't in the available state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidRestoreFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidRestoreFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Cannot restore from VPC backup to non-VPC DB instance.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidS3BucketFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidS3BucketFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified Amazon S3 bucket name can't be found or Amazon RDS isn't\n authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidSubnet": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidSubnet", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#InvalidVPCNetworkStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidVPCNetworkStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB subnet group doesn't cover all Availability Zones after it's\n created because of users' change.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#KMSKeyNotAccessibleFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMSKeyNotAccessibleFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

An error occurred accessing an Amazon Web Services KMS key.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#KeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } + }, + "com.amazonaws.rds#KmsKeyIdOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_:\\-\\/]+$" + } + }, + "com.amazonaws.rds#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ListTagsForResourceMessage" + }, + "output": { + "target": "com.amazonaws.rds#TagListMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all tags on an Amazon RDS resource.

\n

For an overview on tagging an Amazon RDS resource, \n see Tagging Amazon RDS Resources \n in the Amazon RDS User Guide.

" + } + }, + "com.amazonaws.rds#ListTagsForResourceMessage": { + "type": "structure", + "members": { + "ResourceName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.rds#FilterList", + "traits": { + "smithy.api#documentation": "

This parameter isn't currently supported.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#LogTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } + }, + "com.amazonaws.rds#Long": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.rds#LongOptional": { + "type": "long" + }, + "com.amazonaws.rds#MasterUserSecret": { + "type": "structure", + "members": { + "SecretArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secret.

" + } + }, + "SecretStatus": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the secret.

\n

The possible status values include the following:

\n " + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier that is used to encrypt the secret.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

" + } + }, + "com.amazonaws.rds#MaxRecords": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 20, + "max": 100 + } + } + }, + "com.amazonaws.rds#MinimumEngineVersionPerAllowedValue": { + "type": "structure", + "members": { + "AllowedValue": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The allowed value for an option setting.

" + } + }, + "MinimumEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The minimum DB engine version required for the allowed value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum DB engine version required for each corresponding allowed value for an option setting.

" + } + }, + "com.amazonaws.rds#MinimumEngineVersionPerAllowedValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#MinimumEngineVersionPerAllowedValue", + "traits": { + "smithy.api#xmlName": "MinimumEngineVersionPerAllowedValue" + } + } + }, + "com.amazonaws.rds#ModifyActivityStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyActivityStreamRequest" + }, + "output": { + "target": "com.amazonaws.rds#ModifyActivityStreamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only,\n whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy,\n and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream in the\n Amazon RDS User Guide.

\n

This operation is supported for RDS for Oracle only.

" + } + }, + "com.amazonaws.rds#ModifyActivityStreamRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the RDS for Oracle DB instance,\n for example, arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db.

" + } + }, + "AuditPolicyState": { + "target": "com.amazonaws.rds#AuditPolicyState", + "traits": { + "smithy.api#documentation": "

The audit policy state. When a policy is unlocked, it is read/write. When it is locked, it is\n read-only. You can edit your audit policy only when the activity stream is unlocked or stopped.

" + } + } + } + }, + "com.amazonaws.rds#ModifyActivityStreamResponse": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.

" + } + }, + "KinesisStreamName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Kinesis data stream to be used for the database activity stream.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#ActivityStreamStatus", + "traits": { + "smithy.api#documentation": "

The status of the modification to the database activity stream.

" + } + }, + "Mode": { + "target": "com.amazonaws.rds#ActivityStreamMode", + "traits": { + "smithy.api#documentation": "

The mode of the database activity stream.

" + } + }, + "EngineNativeAuditFieldsIncluded": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether engine-native audit fields are included in the database activity stream.

" + } + }, + "PolicyStatus": { + "target": "com.amazonaws.rds#ActivityStreamPolicyStatus", + "traits": { + "smithy.api#documentation": "

The status of the modification to the policy state of the database activity stream.

" + } + } + } + }, + "com.amazonaws.rds#ModifyCertificates": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyCertificatesMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyCertificatesResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#CertificateNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS)\n certificate for Amazon RDS for new DB instances, or remove the override.

\n

By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB\n instances that is different from the default certificate provided by RDS. You can also\n use this operation to remove the override, so that new DB instances use the default\n certificate provided by RDS.

\n

You might need to override the default certificate in the following situations:

\n \n

For more information about rotating your SSL/TLS certificate for RDS DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.

\n

For more information about rotating your SSL/TLS certificate for Aurora DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.

" + } + }, + "com.amazonaws.rds#ModifyCertificatesMessage": { + "type": "structure", + "members": { + "CertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new default certificate identifier to override the current one with.

\n

To determine the valid values, use the describe-certificates CLI\n command or the DescribeCertificates API operation.

" + } + }, + "RemoveCustomerOverride": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to remove the override for the default certificate. \n If the override is removed, the default certificate is the system\n default.

" + } + } + } + }, + "com.amazonaws.rds#ModifyCertificatesResult": { + "type": "structure", + "members": { + "Certificate": { + "target": "com.amazonaws.rds#Certificate" + } + } + }, + "com.amazonaws.rds#ModifyCurrentDBClusterCapacity": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyCurrentDBClusterCapacityMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterCapacityInfo" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.

\n

Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale \n fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity \n to set the capacity explicitly.

\n

After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale\n the DB cluster based on the cooldown period for scaling up and the cooldown period\n for scaling down.

\n

For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the \n Amazon Aurora User Guide.

\n \n

If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that \n prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, \n see \n Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

\n \n \n

This action only applies to Aurora Serverless v1 DB clusters.

\n " + } + }, + "com.amazonaws.rds#ModifyCurrentDBClusterCapacityMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "Capacity": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The DB cluster capacity.

\n

When you change the capacity of a paused Aurora Serverless v1 DB cluster, it automatically resumes.

\n

Constraints:

\n " + } + }, + "SecondsBeforeTimeout": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point\n to perform seamless scaling before enforcing the timeout action. The default is\n 300.

\n

Specify a value between 10 and 600 seconds.

" + } + }, + "TimeoutAction": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

\n

\n ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

\n

\n RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.

" + } + } + } + }, + "com.amazonaws.rds#ModifyCustomDBEngineVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyCustomDBEngineVersionMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBEngineVersion" + }, + "errors": [ + { + "target": "com.amazonaws.rds#CustomDBEngineVersionNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidCustomDBEngineVersionStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling \n DescribeDBEngineVersions.

\n \n

The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the ModifyCustomDbEngineVersion event.

\n \n

For more information, see Modifying CEV status \n in the Amazon RDS User Guide.

" + } + }, + "com.amazonaws.rds#ModifyCustomDBEngineVersionMessage": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#CustomEngineName", + "traits": { + "smithy.api#documentation": "

The DB engine. The only supported value is custom-oracle-ee.

", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#CustomEngineVersion", + "traits": { + "smithy.api#documentation": "

The custom engine version (CEV) that you want to modify. This option is required for \n RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and \n EngineVersion is unique per customer per Amazon Web Services Region.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.rds#Description", + "traits": { + "smithy.api#documentation": "

An optional description of your CEV.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#CustomEngineVersionStatus", + "traits": { + "smithy.api#documentation": "

The availability status to be assigned to the CEV. Valid values are as follows:

\n
\n
available
\n
\n

You can use this CEV to create a new RDS Custom DB instance.

\n
\n
inactive
\n
\n

You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. \n You can't patch or create new instances with this CEV.

\n
\n
\n

You can change any status to any status. A typical reason to change status is to prevent the accidental \n use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status \n of your CEV from available to inactive, and from inactive back to \n available. To change the availability status of the CEV, it must not currently be in use by an \n RDS Custom instance, snapshot, or automated backup.

" + } + } + } + }, + "com.amazonaws.rds#ModifyDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DomainNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSubnetGroupStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB cluster. \n You can change one or more settings by specifying these parameters and the new values in the\n request.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" + } + }, + "com.amazonaws.rds#ModifyDBClusterEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBClusterEndpointMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterEndpoint" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterEndpointNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterEndpointStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

\n \n

This action only applies to Aurora DB clusters.

\n " + } + }, + "com.amazonaws.rds#ModifyDBClusterEndpointMessage": { + "type": "structure", + "members": { + "DBClusterEndpointIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the endpoint to modify. This parameter is stored as a lowercase string.

", + "smithy.api#required": {} + } + }, + "EndpointType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of the endpoint. One of: READER, WRITER, ANY.

" + } + }, + "StaticMembers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

List of DB instance identifiers that are part of the custom endpoint group.

" + } + }, + "ExcludedMembers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

List of DB instance identifiers that aren't part of the custom endpoint group.\n All other eligible instances are reachable through the custom endpoint.\n Only relevant if the list of static members is empty.

" + } + } + } + }, + "com.amazonaws.rds#ModifyDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

\n

Constraints: This identifier must match the identifier of an existing DB\n cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", + "smithy.api#required": {} + } + }, + "NewDBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster2\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether the modifications in this request and\n any pending modifications are asynchronously applied\n as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the DB cluster. \n If this parameter is disabled, changes to the\n DB cluster are applied during the next maintenance window.

\n

The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, \n MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately \n parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, \n and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are\n applied immediately, regardless of the value of the ApplyImmediately parameter.

\n

By default, this parameter is disabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automated backups are retained. Specify a minimum value of 1.

\n

Default: 1

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group to use for the DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of VPC security groups that the DB cluster will belong to.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the DB cluster accepts connections.

\n

Constraints: Value must be 1150-65535\n

\n

Default: The same port as the original DB cluster.

\n

Valid for: Aurora DB clusters only

" + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value that indicates that the DB cluster should be associated with the specified option group.

\n

DB clusters are associated with a default option group that can't be modified.

" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + } + }, + "BacktrackWindow": { + "target": "com.amazonaws.rds#LongOptional", + "traits": { + "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n

Default: 0

\n

Constraints:

\n \n

Valid for: Aurora MySQL DB clusters only

" + } + }, + "CloudwatchLogsExportConfiguration": { + "target": "com.amazonaws.rds#CloudwatchLogsExportConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. The values\n in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine to which you want to upgrade. \n Changing this parameter results in an outage. The change is applied during\n the next maintenance window unless ApplyImmediately is enabled.

\n

To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "AllowMajorVersionUpgrade": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether major version upgrades are allowed.

\n

Constraints: You must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\n cluster's current version.

\n

Valid for: Aurora DB clusters only

" + } + }, + "DBInstanceParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group to apply to all instances of the DB cluster.

\n \n

When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB\n cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than \n during the next maintenance window.

\n \n

Default: The existing name setting

\n

Constraints:

\n \n

Valid for: Aurora DB clusters only

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory directory ID to move the DB cluster to. \n Specify none to remove the cluster from its current domain.\n The domain must be created prior to this operation.

\n

For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

Valid for: Aurora DB clusters only

" + } + }, + "ScalingConfiguration": { + "target": "com.amazonaws.rds#ScalingConfiguration", + "traits": { + "smithy.api#documentation": "

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

\n

Valid for: Aurora DB clusters only

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "EnableHttpEndpoint": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint \n is disabled.

\n

When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.

\n

For more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "EnableGlobalWriteForwarding": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an\n Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.

\n

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is\n demoted by the FailoverGlobalCluster API operation, but it does nothing until then.

\n

Valid for: Aurora DB clusters only

" + } + }, + "DBClusterInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes and availability for your engine, see \n DB Instance Class in the Amazon RDS User Guide.

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

\n

Type: Integer

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

Valid values: io1\n

\n

When specified, a value for the Iops parameter is required.

\n

Default: io1\n

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, see \n Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. \n To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.

\n

If MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An\n example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to turn on Performance Insights for the DB cluster.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" + } + }, + "ManageMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn \n on this management. In this case, you can't specify MasterUserPassword.

\n

If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the \n master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. \n In this case, RDS deletes the secret and uses the new password for the master user specified by \n MasterUserPassword.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "RotateMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to rotate the secret managed by Amazon Web Services Secrets Manager for the \n master user password.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster. The secret value contains the updated password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "MasterUserSecretKmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if both of the following conditions are met:

\n \n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#ModifyDBClusterParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBClusterParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterParameterGroupNameMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, \n and ApplyMethod. A maximum of 20\n parameters can be modified in a single request.

\n \n

After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters operation to verify \n that your DB cluster parameter group has been created or modified.

\n

If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora\n applies the update immediately. The cluster restart might interrupt your workload. In that case,\n your application must reopen any connections and retry any transactions that were active\n when the parameter changes took effect.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + } + }, + "com.amazonaws.rds#ModifyDBClusterParameterGroupMessage": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group to modify.

", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.rds#ParametersList", + "traits": { + "smithy.api#documentation": "

A list of parameters in the DB cluster parameter group to modify.

\n

Valid Values (for the application method): immediate | pending-reboot\n

\n \n

You can use the immediate value with dynamic parameters only. You can use the \n pending-reboot value for both dynamic and static parameters.

\n

When the application method is immediate, changes to dynamic parameters are applied immediately \n to the DB clusters associated with the parameter group. When the application method is pending-reboot, \n changes to dynamic and static parameters are applied after a reboot without failover to the DB clusters associated with the \n parameter group.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#ModifyDBClusterResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + } + }, + "com.amazonaws.rds#ModifyDBClusterSnapshotAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#SharedSnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

\n

To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify\n restore as the AttributeName and use the\n ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are\n authorized to restore the manual DB cluster snapshot. Use the value all to\n make the manual DB cluster snapshot public, which means that it can be copied or\n restored by all Amazon Web Services accounts.

\n \n

Don't add the all value for any manual DB cluster snapshots\n that contain private information that you don't want available to all Amazon Web Services\n accounts.

\n \n

If a manual DB cluster snapshot is encrypted, it can be shared, but only by\n specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd\n parameter. You can't use all as a value for that parameter in this\n case.

\n

To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster\n snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are\n returned as values for the restore attribute.

" + } + }, + "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeMessage": { + "type": "structure", + "members": { + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the DB cluster snapshot to modify the attributes for.

", + "smithy.api#required": {} + } + }, + "AttributeName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster snapshot attribute to modify.

\n

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, \n set this value to restore.

\n \n

To view the list of attributes available to modify, use the\n DescribeDBClusterSnapshotAttributes API operation.

\n ", + "smithy.api#required": {} + } + }, + "ValuesToAdd": { + "target": "com.amazonaws.rds#AttributeValueList", + "traits": { + "smithy.api#documentation": "

A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.

\n

To authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account\n IDs, or all to make the manual DB cluster snapshot restorable by \n any Amazon Web Services account. Do not add the all value for any\n manual DB cluster snapshots that contain private information that you don't want available\n to all Amazon Web Services accounts.

" + } + }, + "ValuesToRemove": { + "target": "com.amazonaws.rds#AttributeValueList", + "traits": { + "smithy.api#documentation": "

A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.

\n

To remove authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include\n one or more Amazon Web Services account\n identifiers, or all to remove authorization for any Amazon Web Services account to copy or\n restore the DB cluster snapshot. If you specify all, an Amazon Web Services account whose account ID is\n explicitly added to the restore attribute\n can still copy or restore a manual DB cluster snapshot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeResult": { + "type": "structure", + "members": { + "DBClusterSnapshotAttributesResult": { + "target": "com.amazonaws.rds#DBClusterSnapshotAttributesResult" + } + } + }, + "com.amazonaws.rds#ModifyDBInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBInstanceMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#AuthorizationNotFoundFault" + }, + { + "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#CertificateNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBUpgradeDependencyFailureFault" + }, + { + "target": "com.amazonaws.rds#DomainNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies settings for a DB instance. \n You can change one or more database configuration parameters by specifying these parameters and the new values in the request.\n To learn what modifications you can make to your DB instance,\n call DescribeValidDBInstanceModifications\n before you call ModifyDBInstance.

" + } + }, + "com.amazonaws.rds#ModifyDBInstanceMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance identifier. This value is stored as a lowercase string.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The new amount of storage in gibibytes (GiB) to allocate for the DB instance.

\n

For MariaDB, MySQL, Oracle, and PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.

\n

For the valid values for allocated storage for each engine,\n see CreateDBInstance.

" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all\n Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the \n Amazon RDS User Guide or \n Aurora\n DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and \n DB instance class support for RDS Custom for SQL Server.

\n

If you modify the DB instance class, an outage occurs during the change. The change is\n applied during the next maintenance window, unless you specify\n ApplyImmediately in your request.

\n

Default: Uses existing setting

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new DB subnet group for the DB instance.\n You can use this parameter to move your DB instance to a different VPC.\n \n \n If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC.\n For more information, see \n Working with a DB instance in a VPC \n in the Amazon RDS User Guide.

\n

Changing the subnet group causes an outage during the change. \n The change is applied during the next maintenance window,\n unless you enable ApplyImmediately.

\n

This parameter doesn't apply to RDS Custom.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" + } + }, + "DBSecurityGroups": { + "target": "com.amazonaws.rds#DBSecurityGroupNameList", + "traits": { + "smithy.api#documentation": "

A list of DB security groups to authorize on this DB instance. Changing this setting doesn't \n result in an outage and the change is asynchronously applied as soon as possible.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n " + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to authorize on this DB instance. This change is \n asynchronously applied as soon as possible.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster. For more information, see ModifyDBCluster.

\n

Constraints:

\n " + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, \n regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.

\n

If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage\n and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in \n Modifying a DB Instance in the \n Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to \n determine when the changes are applied.

" + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new password for the master user. The password can include any printable ASCII \n character except \"/\", \"\"\", or \"@\".

\n

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. The password for the master user is managed by the DB cluster. For\n more information, see ModifyDBCluster.

\n

Default: Uses existing setting

\n

Constraints: Can't be specified if ManageMasterUserPassword is turned on.

\n

\n MariaDB\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Microsoft SQL Server\n

\n

Constraints: Must contain from 8 to 128 characters.

\n

\n MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Oracle\n

\n

Constraints: Must contain from 8 to 30 characters.

\n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

\n \n

Amazon RDS API operations never return the password, \n so this action provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.

\n " + } + }, + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group to apply to the DB instance.

\n

Changing this setting doesn't result in an outage. The parameter group name itself is changed\n immediately, but the actual parameter changes are not applied until you reboot the\n instance without failover. In this case, the DB instance isn't rebooted automatically, and the\n parameter changes aren't applied during the next maintenance window. However, if you modify \n dynamic parameters in the newly associated DB parameter group, these changes are applied \n immediately without a reboot.

\n

This setting doesn't apply to RDS Custom.

\n

Default: Uses existing setting

\n

Constraints: The DB parameter group must be in the same DB parameter group family as the DB instance.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

\n \n

Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.

\n \n

These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled\n for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously\n applied as soon as possible.

\n

\n Amazon Aurora\n

\n

Not applicable. The retention period for automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.

\n

Default: Uses existing setting

\n

Constraints:

\n " + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n as determined by the BackupRetentionPeriod parameter. \n Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.\n

\n

\n Amazon Aurora\n

\n

Not applicable. The daily time range for creating automated backups is managed by\n the DB cluster. For more information, see ModifyDBCluster.

\n

Constraints:

\n " + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The weekly time range (in UTC) during which system maintenance can occur, which\n might result in an outage. Changing this parameter doesn't result in an outage, except\n in the following situation, and the change is asynchronously applied as soon as\n possible. If there are pending actions that cause a reboot, and the maintenance window\n is changed to include the current time, then changing this parameter will cause a reboot\n of the DB instance. If moving this window to the current time, there must be at least 30\n minutes between the current time and end of the window to ensure pending changes are\n applied.

\n

For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.\n

\n

Default: Uses existing setting

\n

Format: ddd:hh24:mi-ddd:hh24:mi

\n

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

\n

Constraints: Must be at least 30 minutes

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result \n in an outage. The change is applied during the next maintenance window unless the ApplyImmediately \n parameter is enabled for this request.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.

\n

For major version upgrades, if a nondefault DB parameter group is currently in use, a\n new DB parameter group in the DB parameter group family for the new engine version must\n be specified. The new DB parameter group can be the default for that DB parameter group\n family.

\n

If you specify only a major version, Amazon RDS will update the DB instance to the \n default minor version if the current minor version is lower.\n For information about valid engine versions, see CreateDBInstance, \n or call DescribeDBEngineVersions.

\n

In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the \n PATCH_DB_FAILURE lifecycle.

" + } + }, + "AllowMajorVersionUpgrade": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't \n result in an outage and the change is asynchronously applied as soon as possible.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints: Major version upgrades must be allowed when specifying a value \n for the EngineVersion parameter that is a different major version than the DB instance's current version.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether minor version upgrades are applied automatically to the DB instance \n during the maintenance window. An outage occurs when all the following conditions are met:

\n \n

If any of the preceding conditions isn't met, RDS applies the change as soon as possible and\n doesn't cause an outage.

\n

For an RDS Custom DB instance, set AutoMinorVersionUpgrade \n to false. Otherwise, the operation returns an error.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The license model for the DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

Valid values: license-included | bring-your-own-license | \n general-public-license\n

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The new Provisioned IOPS (I/O operations per second) value for the RDS instance.

\n

Changing this setting doesn't result in an outage and\n the change is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n If you are migrating from Provisioned IOPS to standard storage, set this value to 0. \n The DB instance will require a reboot for the change in storage type to take effect.

\n

If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.

\n

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

\n

Default: Uses existing setting

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value that indicates the DB instance should be associated with the specified option group.

\n

Changing this parameter doesn't result in an outage, with one exception. If the parameter change results \n in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which \n new connections are rejected but existing connections aren't interrupted.

\n

The change is applied during the next maintenance window unless the ApplyImmediately parameter \n is enabled for this request.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group, and that option group can't be removed from a DB instance after \n it is associated with a DB instance.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "NewDBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance \n identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur \n during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n \n

Example: mydbinstance\n

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

If you specify Provisioned IOPS (io1), \n you must also include a value for the Iops parameter.

\n

If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" + } + }, + "TdeCredentialArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "TdeCredentialPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the CA certificate identifier to use for the DB instanceā€™s server certificate.

\n

This setting doesn't apply to RDS Custom.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Active Directory directory ID to move the DB instance to. \n Specify none to remove the instance from its current domain.\n You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

\n

\n Amazon Aurora\n

\n

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see ModifyDBCluster.

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected \n for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0, which is the default.

\n

If MonitoringRoleArn is specified, set MonitoringInterval to a value other than 0.

\n

This setting doesn't apply to RDS Custom.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

" + } + }, + "DBPortNumber": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

The value of the DBPortNumber parameter must not match any of the port values \n specified for options in the option group for the DB instance.

\n

If you change the DBPortNumber value, your database restarts regardless of \n the value of the ApplyImmediately parameter.

\n

This setting doesn't apply to RDS Custom.

\n

\n MySQL\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

\n

\n MariaDB\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

\n

\n PostgreSQL\n

\n

Default: 5432\n

\n

Valid values: 1150-65535\n

\n

Type: Integer

\n

\n Oracle\n

\n

Default: 1521\n

\n

Valid values: 1150-65535\n

\n

\n SQL Server\n

\n

Default: 1433\n

\n

Valid values: 1150-65535 except 1234, 1434,\n 3260, 3343, 3389, 47001, and\n 49152-49156.

\n

\n Amazon Aurora\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

\n PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a \n public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.

\n

Changes to the PubliclyAccessible parameter are applied immediately regardless\n of the value of the ApplyImmediately parameter.

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn \n value.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "PromotionTier": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

\n

This setting doesn't apply to RDS Custom.

\n

Default: 1

\n

Valid Values: 0 - 15

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB\n cluster.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the DB instance.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "CloudwatchLogsExportConfiguration": { + "target": "com.amazonaws.rds#CloudwatchLogsExportConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a \n specific DB instance.

\n

A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance \n immediately. Therefore, the ApplyImmediately parameter has no effect.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "UseDefaultProcessorFeatures": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" + } + }, + "MaxAllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "CertificateRotationRestart": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance is restarted when you rotate your \n SSL/TLS certificate.

\n

By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate \n is not updated until the DB instance is restarted.

\n \n

Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

\n \n

If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your \n DB engine to rotate your SSL/TLS certificate:

\n \n

This setting doesn't apply to RDS Custom.

" + } + }, + "ReplicaMode": { + "target": "com.amazonaws.rds#ReplicaMode", + "traits": { + "smithy.api#documentation": "

A value that sets the open mode of a replica database to either mounted or read-only.

\n \n

Currently, this parameter is only supported for Oracle DB instances.

\n \n

Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for \n mounted replicas is cross-Region disaster recovery. The primary database doesn't use \n Active Data Guard to transmit information to the mounted replica. Because it doesn't \n accept user connections, a mounted replica can't serve a read-only workload. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "EnableCustomerOwnedIp": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + } + }, + "AwsBackupRecoveryPointArn": { + "target": "com.amazonaws.rds#AwsBackupRecoveryPointArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "AutomationMode": { + "target": "com.amazonaws.rds#AutomationMode", + "traits": { + "smithy.api#documentation": "

The automation mode of the RDS Custom DB instance: full or all paused. \n If full, the DB instance automates monitoring and instance recovery. If \n all paused, the instance pauses automation for the duration set by \n ResumeFullAutomationModeMinutes.

" + } + }, + "ResumeFullAutomationModeMinutes": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes \n full automation. The minimum value is 60 (default). The maximum value is 1,440.

" + } + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting applies only to the gp3 storage type.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + } + }, + "ManageMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn \n on this management. In this case, you can't specify MasterUserPassword.

\n

If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the \n master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. \n In this case, RDS deletes the secret and uses the new password for the master user specified by \n MasterUserPassword.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

\n " + } + }, + "RotateMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to rotate the secret managed by Amazon Web Services Secrets Manager for the \n master user password.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster. The secret value contains the updated password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

\n " + } + }, + "MasterUserSecretKmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if both of the following conditions are met:

\n \n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#ModifyDBInstanceResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + } + }, + "com.amazonaws.rds#ModifyDBParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBParameterGroupNameMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the parameters of a DB parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, and \n ApplyMethod. A maximum of 20 parameters can be modified in a single request.

\n \n

After you modify a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the modify action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.

\n " + } + }, + "com.amazonaws.rds#ModifyDBParameterGroupMessage": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.rds#ParametersList", + "traits": { + "smithy.api#documentation": "

An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and \n application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.

\n

Valid Values (for the application method): immediate | pending-reboot\n

\n

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic \n and static parameters.

\n

When the application method is immediate, changes to dynamic parameters are applied immediately to the DB instances associated with \n the parameter group.

\n

When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover \n to the DB instances associated with the parameter group.

\n \n

You can't use pending-reboot with dynamic parameters on RDS for SQL Server DB instances. Use immediate.

\n \n

For more information on modifying DB parameters, see Working \n with DB parameter groups in the Amazon RDS User Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#ModifyDBProxy": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBProxyRequest" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBProxyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Changes the settings for an existing DB proxy.

" + } + }, + "com.amazonaws.rds#ModifyDBProxyEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBProxyEndpointRequest" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBProxyEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyEndpointAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBProxyEndpointNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyEndpointStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Changes the settings for an existing DB proxy endpoint.

" + } + }, + "com.amazonaws.rds#ModifyDBProxyEndpointRequest": { + "type": "structure", + "members": { + "DBProxyEndpointName": { + "target": "com.amazonaws.rds#DBProxyEndpointName", + "traits": { + "smithy.api#documentation": "

The name of the DB proxy sociated with the DB proxy endpoint that you want to modify.

", + "smithy.api#required": {} + } + }, + "NewDBProxyEndpointName": { + "target": "com.amazonaws.rds#DBProxyEndpointName", + "traits": { + "smithy.api#documentation": "

The new identifier for the DBProxyEndpoint. An identifier must\n begin with a letter and must contain only ASCII letters, digits, and hyphens; it\n can't end with a hyphen or contain two consecutive hyphens.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint\n uses a different VPC than the original proxy, you also specify a different\n set of security group IDs than for the original proxy.

" + } + } + } + }, + "com.amazonaws.rds#ModifyDBProxyEndpointResponse": { + "type": "structure", + "members": { + "DBProxyEndpoint": { + "target": "com.amazonaws.rds#DBProxyEndpoint", + "traits": { + "smithy.api#documentation": "

The DBProxyEndpoint object representing the new settings for the DB proxy endpoint.

" + } + } + } + }, + "com.amazonaws.rds#ModifyDBProxyRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the DBProxy to modify.

", + "smithy.api#required": {} + } + }, + "NewDBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new identifier for the DBProxy. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

" + } + }, + "Auth": { + "target": "com.amazonaws.rds#UserAuthConfigList", + "traits": { + "smithy.api#documentation": "

The new authentication settings for the DBProxy.

" + } + }, + "RequireTLS": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Whether Transport Layer Security (TLS) encryption is required for connections to the proxy.\n By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn't\n use TLS.

" + } + }, + "IdleClientTimeout": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this\n value higher or lower than the connection timeout limit for the associated database.

" + } + }, + "DebugLogging": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The new list of security groups for the DBProxy.

" + } + } + } + }, + "com.amazonaws.rds#ModifyDBProxyResponse": { + "type": "structure", + "members": { + "DBProxy": { + "target": "com.amazonaws.rds#DBProxy", + "traits": { + "smithy.api#documentation": "

The DBProxy object representing the new settings for the proxy.

" + } + } + } + }, + "com.amazonaws.rds#ModifyDBProxyTargetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBProxyTargetGroupRequest" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBProxyTargetGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the properties of a DBProxyTargetGroup.

" + } + }, + "com.amazonaws.rds#ModifyDBProxyTargetGroupRequest": { + "type": "structure", + "members": { + "TargetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the target group to modify.

", + "smithy.api#required": {} + } + }, + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the proxy.

", + "smithy.api#required": {} + } + }, + "ConnectionPoolConfig": { + "target": "com.amazonaws.rds#ConnectionPoolConfiguration", + "traits": { + "smithy.api#documentation": "

The settings that determine the size and behavior of the connection pool for the target group.

" + } + }, + "NewName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new name for the modified DBProxyTarget. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

" + } + } + } + }, + "com.amazonaws.rds#ModifyDBProxyTargetGroupResponse": { + "type": "structure", + "members": { + "DBProxyTargetGroup": { + "target": "com.amazonaws.rds#DBProxyTargetGroup", + "traits": { + "smithy.api#documentation": "

The settings of the modified DBProxyTarget.

" + } + } + } + }, + "com.amazonaws.rds#ModifyDBSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted\n or unencrypted, but not shared or public.\n \n

\n

Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command\n doesn't apply to RDS Custom.

" + } + }, + "com.amazonaws.rds#ModifyDBSnapshotAttribute": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBSnapshotAttributeMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBSnapshotAttributeResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#SharedSnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

\n

To share a manual DB snapshot with other Amazon Web Services accounts, specify restore\n as the AttributeName and use the ValuesToAdd parameter to add\n a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot.\n Uses the value all to make the manual DB snapshot public, which means it\n can be copied or restored by all Amazon Web Services accounts.

\n \n

Don't add the all value for any manual DB snapshots that\n contain private information that you don't want available to all Amazon Web Services\n accounts.

\n \n

If the manual DB snapshot is encrypted, it can be shared, but only by specifying a\n list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You\n can't use all as a value for that parameter in this case.

\n

To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or\n whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as\n values for the restore attribute.

" + } + }, + "com.amazonaws.rds#ModifyDBSnapshotAttributeMessage": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the DB snapshot to modify the attributes for.

", + "smithy.api#required": {} + } + }, + "AttributeName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB snapshot attribute to modify.

\n

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, \n set this value to restore.

\n \n

To view the list of attributes available to modify, use the\n DescribeDBSnapshotAttributes API operation.

\n ", + "smithy.api#required": {} + } + }, + "ValuesToAdd": { + "target": "com.amazonaws.rds#AttributeValueList", + "traits": { + "smithy.api#documentation": "

A list of DB snapshot attributes to add to the attribute specified by AttributeName.

\n

To authorize other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account\n IDs, or all to make the manual DB snapshot restorable by \n any Amazon Web Services account. Do not add the all value for any\n manual DB snapshots that contain private information that you don't want available\n to all Amazon Web Services accounts.

" + } + }, + "ValuesToRemove": { + "target": "com.amazonaws.rds#AttributeValueList", + "traits": { + "smithy.api#documentation": "

A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

\n

To remove authorization for other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include \n one or more Amazon Web Services account\n identifiers, or all to remove authorization for any Amazon Web Services account to copy or\n restore the DB snapshot. If you specify all, an Amazon Web Services account whose\n account ID is explicitly added to the restore attribute\n can still copy or restore the manual DB snapshot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#ModifyDBSnapshotAttributeResult": { + "type": "structure", + "members": { + "DBSnapshotAttributesResult": { + "target": "com.amazonaws.rds#DBSnapshotAttributesResult" + } + } + }, + "com.amazonaws.rds#ModifyDBSnapshotMessage": { + "type": "structure", + "members": { + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DB snapshot to modify.

", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The engine version to upgrade the DB snapshot to.

\n

The following are the database engines and engine versions that are available when you upgrade a DB snapshot.

\n

\n MySQL\n

\n \n

\n Oracle\n

\n \n

\n PostgreSQL\n

\n

For the list of engine versions that are available for upgrading a DB snapshot, see \n \n Upgrading the PostgreSQL DB Engine for Amazon RDS.

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The option group to identify with the upgraded DB snapshot.

\n

You can specify this parameter when you upgrade an Oracle DB snapshot.\n The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance.\n For more information, see \n Option group considerations in the Amazon RDS User Guide.\n

" + } + } + } + }, + "com.amazonaws.rds#ModifyDBSnapshotResult": { + "type": "structure", + "members": { + "DBSnapshot": { + "target": "com.amazonaws.rds#DBSnapshot" + } + } + }, + "com.amazonaws.rds#ModifyDBSubnetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyDBSubnetGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyDBSubnetGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#SubnetAlreadyInUse" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

" + } + }, + "com.amazonaws.rds#ModifyDBSubnetGroupMessage": { + "type": "structure", + "members": { + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name for the DB subnet group. This value is stored as a lowercase string.\n You can't modify the default subnet group.

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mydbsubnetgroup\n

", + "smithy.api#required": {} + } + }, + "DBSubnetGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description for the DB subnet group.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.rds#SubnetIdentifierList", + "traits": { + "smithy.api#documentation": "

The EC2 subnet IDs for the DB subnet group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#ModifyDBSubnetGroupResult": { + "type": "structure", + "members": { + "DBSubnetGroup": { + "target": "com.amazonaws.rds#DBSubnetGroup" + } + } + }, + "com.amazonaws.rds#ModifyEventSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyEventSubscriptionMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyEventSubscriptionResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#EventSubscriptionQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#SNSInvalidTopicFault" + }, + { + "target": "com.amazonaws.rds#SNSNoAuthorizationFault" + }, + { + "target": "com.amazonaws.rds#SNSTopicArnNotFoundFault" + }, + { + "target": "com.amazonaws.rds#SubscriptionCategoryNotFoundFault" + }, + { + "target": "com.amazonaws.rds#SubscriptionNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change \n source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

\n

You can see a list of the event categories for a given source type (SourceType) \n in Events in the Amazon RDS User Guide \n or by using the DescribeEventCategories operation.

" + } + }, + "com.amazonaws.rds#ModifyEventSubscriptionMessage": { + "type": "structure", + "members": { + "SubscriptionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the RDS event notification subscription.

", + "smithy.api#required": {} + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

" + } + }, + "SourceType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.

\n

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n

" + } + }, + "EventCategories": { + "target": "com.amazonaws.rds#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

A list of event categories for a source type (SourceType) that you want to subscribe to. \n You can see a list of the categories for a given source type \n in Events in the Amazon RDS User Guide \n or by using the DescribeEventCategories operation.

" + } + }, + "Enabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to activate the subscription.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#ModifyEventSubscriptionResult": { + "type": "structure", + "members": { + "EventSubscription": { + "target": "com.amazonaws.rds#EventSubscription" + } + } + }, + "com.amazonaws.rds#ModifyGlobalCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyGlobalClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyGlobalClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration\n parameters by specifying these parameters and the new values in the request. For more information on\n Amazon Aurora, see What is Amazon Aurora? in the\n Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters.

\n " + } + }, + "com.amazonaws.rds#ModifyGlobalClusterMessage": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive.

\n

Constraints:

\n " + } + }, + "NewGlobalClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The new cluster identifier for the global database cluster when modifying a global database cluster.\n This value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster2\n

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates if the global database cluster has deletion protection enabled. The global database cluster\n can't be deleted when deletion protection is enabled.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine to which you want to upgrade. \n Changing this parameter results in an outage. The change is applied during\n the next maintenance window unless ApplyImmediately is enabled.

\n

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n

\n

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n

\n

To list all of the available engine versions for aurora-postgresql, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n

" + } + }, + "AllowMajorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether major version upgrades are allowed.

\n

Constraints: You must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\n cluster's current version.

\n

If you upgrade the major version of a global database, the cluster and DB instance parameter\n groups are set to the default parameter groups for the new version. Apply any custom parameter\n groups after completing the upgrade.

" + } + } + } + }, + "com.amazonaws.rds#ModifyGlobalClusterResult": { + "type": "structure", + "members": { + "GlobalCluster": { + "target": "com.amazonaws.rds#GlobalCluster" + } + } + }, + "com.amazonaws.rds#ModifyOptionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyOptionGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#ModifyOptionGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#InvalidOptionGroupStateFault" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies an existing option group.

" + } + }, + "com.amazonaws.rds#ModifyOptionGroupMessage": { + "type": "structure", + "members": { + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group to be modified.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

", + "smithy.api#required": {} + } + }, + "OptionsToInclude": { + "target": "com.amazonaws.rds#OptionConfigurationList", + "traits": { + "smithy.api#documentation": "

Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.

" + } + }, + "OptionsToRemove": { + "target": "com.amazonaws.rds#OptionNamesList", + "traits": { + "smithy.api#documentation": "

Options in this list are removed from the option group.

" + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#ModifyOptionGroupResult": { + "type": "structure", + "members": { + "OptionGroup": { + "target": "com.amazonaws.rds#OptionGroup" + } + } + }, + "com.amazonaws.rds#NetworkTypeNotSupported": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "NetworkTypeNotSupported", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The network type is invalid for the DB instance. Valid nework type values are IPV4 and DUAL.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#Option": { + "type": "structure", + "members": { + "OptionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option.

" + } + }, + "OptionDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description of the option.

" + } + }, + "Persistent": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicate if this option is persistent.

" + } + }, + "Permanent": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicate if this option is permanent.

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

If required, the port configured for this option to use.

" + } + }, + "OptionVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the option.

" + } + }, + "OptionSettings": { + "target": "com.amazonaws.rds#OptionSettingConfigurationList", + "traits": { + "smithy.api#documentation": "

The option settings for this option.

" + } + }, + "DBSecurityGroupMemberships": { + "target": "com.amazonaws.rds#DBSecurityGroupMembershipList", + "traits": { + "smithy.api#documentation": "

If the option requires access to a port, then this DB security group allows access to the port.

" + } + }, + "VpcSecurityGroupMemberships": { + "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", + "traits": { + "smithy.api#documentation": "

If the option requires access to a port, then this VPC security group allows access to the port.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Option details.

" + } + }, + "com.amazonaws.rds#OptionConfiguration": { + "type": "structure", + "members": { + "OptionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The configuration of options to include in a group.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The optional port for the option.

" + } + }, + "OptionVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version for the option.

" + } + }, + "DBSecurityGroupMemberships": { + "target": "com.amazonaws.rds#DBSecurityGroupNameList", + "traits": { + "smithy.api#documentation": "

A list of DBSecurityGroupMembership name strings used for this option.

" + } + }, + "VpcSecurityGroupMemberships": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of VpcSecurityGroupMembership name strings used for this option.

" + } + }, + "OptionSettings": { + "target": "com.amazonaws.rds#OptionSettingsList", + "traits": { + "smithy.api#documentation": "

The option settings to include in an option group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of all available options

" + } + }, + "com.amazonaws.rds#OptionConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OptionConfiguration", + "traits": { + "smithy.api#xmlName": "OptionConfiguration" + } + } + }, + "com.amazonaws.rds#OptionGroup": { + "type": "structure", + "members": { + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the option group.

" + } + }, + "OptionGroupDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides a description of the option group.

" + } + }, + "EngineName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Indicates the name of the engine that this option group can be applied to.

" + } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Indicates the major engine version associated with this option group.

" + } + }, + "Options": { + "target": "com.amazonaws.rds#OptionsList", + "traits": { + "smithy.api#documentation": "

Indicates what options are available in the option group.

" + } + }, + "AllowsVpcAndNonVpcInstanceMemberships": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether this option group can be applied to both VPC \n and non-VPC instances. The value true indicates the option group \n can be applied to both VPC and non-VPC instances.

" + } + }, + "VpcId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank.\n If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, \n then this option group can be applied to both VPC and non-VPC instances.\n If this field contains a value, then this option group can only be \n applied to instances that are in the VPC indicated by this field.

" + } + }, + "OptionGroupArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) for the option group.

" + } + }, + "SourceOptionGroup": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the option group from which this option group is copied.

" + } + }, + "SourceAccountId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon Web Services account ID for the option group from which this option group is copied.

" + } + }, + "CopyTimestamp": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

Indicates when the option group was copied.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#OptionGroupAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "OptionGroupAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The option group you are trying to create already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#OptionGroupMembership": { + "type": "structure", + "members": { + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group that the instance belongs to.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the DB instance's option group membership. Valid values are: \n in-sync, \n pending-apply, \n pending-removal, \n pending-maintenance-apply, \n pending-maintenance-removal, \n applying, \n removing, \n and failed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information on the option groups the DB instance is a member of.

" + } + }, + "com.amazonaws.rds#OptionGroupMembershipList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OptionGroupMembership", + "traits": { + "smithy.api#xmlName": "OptionGroupMembership" + } + } + }, + "com.amazonaws.rds#OptionGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "OptionGroupNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified option group could not be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#OptionGroupOption": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description of the option.

" + } + }, + "EngineName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the engine that this option can be applied to.

" + } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Indicates the major engine version that the option is available for.

" + } + }, + "MinimumRequiredMinorEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The minimum required engine version for the option to be applied.

" + } + }, + "PortRequired": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether the option requires a port.

" + } + }, + "DefaultPort": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

If the option requires a port, specifies the default port for the option.

" + } + }, + "OptionsDependedOn": { + "target": "com.amazonaws.rds#OptionsDependedOn", + "traits": { + "smithy.api#documentation": "

The options that are prerequisites for this option.

" + } + }, + "OptionsConflictsWith": { + "target": "com.amazonaws.rds#OptionsConflictsWith", + "traits": { + "smithy.api#documentation": "

The options that conflict with this option.

" + } + }, + "Persistent": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.

" + } + }, + "Permanent": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.

" + } + }, + "RequiresAutoMinorEngineVersionUpgrade": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

If true, you must enable the Auto Minor Version Upgrade setting for your DB instance \n before you can use this option.\n You can enable Auto Minor Version Upgrade when you first create your DB instance,\n or by modifying your DB instance later.

" + } + }, + "VpcOnly": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

If true, you can only use this option with a DB instance that is in a VPC.

" + } + }, + "SupportsOptionVersionDowngrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

If true, you can change the option to an earlier version of the option. \n This only applies to options that have different versions available.

" + } + }, + "OptionGroupOptionSettings": { + "target": "com.amazonaws.rds#OptionGroupOptionSettingsList", + "traits": { + "smithy.api#documentation": "

The option settings that are available (and the default value) for each option in an option group.

" + } + }, + "OptionGroupOptionVersions": { + "target": "com.amazonaws.rds#OptionGroupOptionVersionsList", + "traits": { + "smithy.api#documentation": "

The versions that are available for the option.

" + } + }, + "CopyableCrossAccount": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the option can be copied across Amazon Web Services accounts.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Available option.

" + } + }, + "com.amazonaws.rds#OptionGroupOptionSetting": { + "type": "structure", + "members": { + "SettingName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group option.

" + } + }, + "SettingDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description of the option group option.

" + } + }, + "DefaultValue": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The default value for the option group option.

" + } + }, + "ApplyType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB engine specific parameter type for the option group option.

" + } + }, + "AllowedValues": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Indicates the acceptable values for the option group option.

" + } + }, + "IsModifiable": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Boolean value where true indicates that this option group option can be changed from the default value.

" + } + }, + "IsRequired": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Boolean value where true indicates that a value must be specified for this option setting of the option group option.

" + } + }, + "MinimumEngineVersionPerAllowedValue": { + "target": "com.amazonaws.rds#MinimumEngineVersionPerAllowedValueList", + "traits": { + "smithy.api#documentation": "

The minimum DB engine version required for the corresponding allowed value for this option setting.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.

" + } + }, + "com.amazonaws.rds#OptionGroupOptionSettingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OptionGroupOptionSetting", + "traits": { + "smithy.api#xmlName": "OptionGroupOptionSetting" + } + } + }, + "com.amazonaws.rds#OptionGroupOptionVersionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OptionVersion", + "traits": { + "smithy.api#xmlName": "OptionVersion" + } + } + }, + "com.amazonaws.rds#OptionGroupOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OptionGroupOption", + "traits": { + "smithy.api#xmlName": "OptionGroupOption" + } + }, + "traits": { + "smithy.api#documentation": "

List of available option group options.

" + } + }, + "com.amazonaws.rds#OptionGroupOptionsMessage": { + "type": "structure", + "members": { + "OptionGroupOptions": { + "target": "com.amazonaws.rds#OptionGroupOptionsList" + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#OptionGroupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "OptionGroupQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The quota of 20 option groups was exceeded for this Amazon Web Services account.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#OptionGroups": { + "type": "structure", + "members": { + "OptionGroupsList": { + "target": "com.amazonaws.rds#OptionGroupsList", + "traits": { + "smithy.api#documentation": "

List of option groups.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

List of option groups.

" + } + }, + "com.amazonaws.rds#OptionGroupsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OptionGroup", + "traits": { + "smithy.api#xmlName": "OptionGroup" + } + } + }, + "com.amazonaws.rds#OptionNamesList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } + }, + "com.amazonaws.rds#OptionSetting": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option that has settings that you can set.

" + } + }, + "Value": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The current value of the option setting.

" + } + }, + "DefaultValue": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The default value of the option setting.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description of the option setting.

" + } + }, + "ApplyType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB engine specific parameter type.

" + } + }, + "DataType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The data type of the option setting.

" + } + }, + "AllowedValues": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The allowed values of the option setting.

" + } + }, + "IsModifiable": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that, when true, indicates the option setting can be modified from the default.

" + } + }, + "IsCollection": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates if the option setting is part of a collection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.

" + } + }, + "com.amazonaws.rds#OptionSettingConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OptionSetting", + "traits": { + "smithy.api#xmlName": "OptionSetting" + } + } + }, + "com.amazonaws.rds#OptionSettingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OptionSetting", + "traits": { + "smithy.api#xmlName": "OptionSetting" + } + } + }, + "com.amazonaws.rds#OptionVersion": { + "type": "structure", + "members": { + "Version": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the option.

" + } + }, + "IsDefault": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

True if the version is the default version of the option, and otherwise false.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The version for an option. Option group option versions are returned by \n the DescribeOptionGroupOptions action.

" + } + }, + "com.amazonaws.rds#OptionsConflictsWith": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "OptionConflictName" + } + } + }, + "com.amazonaws.rds#OptionsDependedOn": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "OptionName" + } + } + }, + "com.amazonaws.rds#OptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Option", + "traits": { + "smithy.api#xmlName": "Option" + } + } + }, + "com.amazonaws.rds#OrderableDBInstanceOption": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The engine type of a DB instance.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The engine version of a DB instance.

" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance class for a DB instance.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The license model for a DB instance.

" + } + }, + "AvailabilityZoneGroup": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone group for a DB instance.

" + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZoneList", + "traits": { + "smithy.api#documentation": "

A list of Availability Zones for a DB instance.

" + } + }, + "MultiAZCapable": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a DB instance is Multi-AZ capable.

" + } + }, + "ReadReplicaCapable": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a DB instance can have a read replica.

" + } + }, + "Vpc": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a DB instance is in a VPC.

" + } + }, + "SupportsStorageEncryption": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a DB instance supports encrypted storage.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Indicates the storage type for a DB instance.

" + } + }, + "SupportsIops": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a DB instance supports provisioned IOPS.

" + } + }, + "SupportsEnhancedMonitoring": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

" + } + }, + "SupportsIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a DB instance supports IAM database authentication.

" + } + }, + "SupportsPerformanceInsights": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

True if a DB instance supports Performance Insights, otherwise false.

" + } + }, + "MinStorageSize": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Minimum storage size for a DB instance.

" + } + }, + "MaxStorageSize": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Maximum storage size for a DB instance.

" + } + }, + "MinIopsPerDbInstance": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Minimum total provisioned IOPS for a DB instance.

" + } + }, + "MaxIopsPerDbInstance": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Maximum total provisioned IOPS for a DB instance.

" + } + }, + "MinIopsPerGib": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

Minimum provisioned IOPS per GiB for a DB instance.

" + } + }, + "MaxIopsPerGib": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

Maximum provisioned IOPS per GiB for a DB instance.

" + } + }, + "AvailableProcessorFeatures": { + "target": "com.amazonaws.rds#AvailableProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

A list of the available processor features for the DB instance class of a DB instance.

" + } + }, + "SupportedEngineModes": { + "target": "com.amazonaws.rds#EngineModeList", + "traits": { + "smithy.api#documentation": "

A list of the supported DB engine modes.

" + } + }, + "SupportsStorageAutoscaling": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.

" + } + }, + "SupportsKerberosAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Whether a DB instance supports Kerberos Authentication.

" + } + }, + "OutpostCapable": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether a DB instance supports RDS on Outposts.

\n

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n

" + } + }, + "SupportedActivityStreamModes": { + "target": "com.amazonaws.rds#ActivityStreamModeList", + "traits": { + "smithy.api#documentation": "

The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value [sync,\n async]. Aurora MySQL and RDS for Oracle return [async] only. If Database Activity Streams \n isn't supported, the return value is an empty list.

" + } + }, + "SupportsGlobalDatabases": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.

" + } + }, + "SupportsClusters": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether DB instances can be configured as a Multi-AZ DB cluster.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + } + }, + "SupportedNetworkTypes": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The network types supported by the DB instance (IPV4 or DUAL).

\n

A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + } + }, + "SupportsStorageThroughput": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a DB instance supports storage throughput.

" + } + }, + "MinStorageThroughputPerDbInstance": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Minimum storage throughput for a DB instance.

" + } + }, + "MaxStorageThroughputPerDbInstance": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Maximum storage throughput for a DB instance.

" + } + }, + "MinStorageThroughputPerIops": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

Minimum storage throughput to provisioned IOPS ratio for a DB instance.

" + } + }, + "MaxStorageThroughputPerIops": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

Maximum storage throughput to provisioned IOPS ratio for a DB instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains a list of available options for a DB instance.

\n

This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

" + } }, - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" + "com.amazonaws.rds#OrderableDBInstanceOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#OrderableDBInstanceOption", + "traits": { + "smithy.api#xmlName": "OrderableDBInstanceOption" + } + } + }, + "com.amazonaws.rds#OrderableDBInstanceOptionsMessage": { + "type": "structure", + "members": { + "OrderableDBInstanceOptions": { + "target": "com.amazonaws.rds#OrderableDBInstanceOptionsList", + "traits": { + "smithy.api#documentation": "

An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous \n OrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

" + } }, - { - "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" + "com.amazonaws.rds#Outpost": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A data type that represents an Outpost.

\n

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n

" + } }, - { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + "com.amazonaws.rds#Parameter": { + "type": "structure", + "members": { + "ParameterName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the parameter.

" + } + }, + "ParameterValue": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the value of the parameter.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Provides a description of the parameter.

" + } + }, + "Source": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Indicates the source of the parameter value.

" + } + }, + "ApplyType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the engine specific parameters type.

" + } + }, + "DataType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the valid data type for the parameter.

" + } + }, + "AllowedValues": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the valid range of values for the parameter.

" + } + }, + "IsModifiable": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether (true) or not (false) the parameter can be modified.\n Some parameters have security or operational implications\n that prevent them from being changed.

" + } + }, + "MinimumEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The earliest engine version to which the parameter can apply.

" + } + }, + "ApplyMethod": { + "target": "com.amazonaws.rds#ApplyMethod", + "traits": { + "smithy.api#documentation": "

Indicates when to apply parameter updates.

" + } + }, + "SupportedEngineModes": { + "target": "com.amazonaws.rds#EngineModeList", + "traits": { + "smithy.api#documentation": "

The valid DB engine modes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a request parameter in the\n ModifyDBParameterGroup and ResetDBParameterGroup actions.

\n

This data type is used as a response element in the \n DescribeEngineDefaultParameters and DescribeDBParameters actions.

" + } }, - { - "target": "com.amazonaws.rds#DomainNotFoundFault" + "com.amazonaws.rds#ParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Parameter", + "traits": { + "smithy.api#xmlName": "Parameter" + } + } }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + "com.amazonaws.rds#PendingCloudwatchLogsExports": { + "type": "structure", + "members": { + "LogTypesToEnable": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

" + } + }, + "LogTypesToDisable": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.

" + } }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + "com.amazonaws.rds#PendingMaintenanceAction": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of pending maintenance action that is available for the resource. \n Valid actions are system-update, db-upgrade, hardware-maintenance, \n and ca-certificate-rotation.

" + } + }, + "AutoAppliedAfterDate": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date of the maintenance window when the action is applied.\n The maintenance action is applied to the resource during\n its first maintenance window after this date.

" + } + }, + "ForcedApplyDate": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date when the maintenance action is automatically applied.

\n

On this date, the maintenance action is applied to the resource as soon as possible, \n regardless of the maintenance window for the resource. There might be a delay of \n one or more days from this date before the maintenance action is applied.

" + } + }, + "OptInStatus": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Indicates the type of opt-in request that has been received for the resource.

" + } + }, + "CurrentApplyDate": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The effective date when the pending maintenance action is applied \n to the resource. This date takes into account opt-in requests received from\n the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate,\n and the ForcedApplyDate. This value is blank if an \n opt-in request has not been received and nothing has been specified as\n AutoAppliedAfterDate or ForcedApplyDate.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A description providing more detail about the maintenance action.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a pending maintenance action for a resource.

" + } }, - { - "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" + "com.amazonaws.rds#PendingMaintenanceActionDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#PendingMaintenanceAction", + "traits": { + "smithy.api#xmlName": "PendingMaintenanceAction" + } + } }, - { - "target": "com.amazonaws.rds#InvalidDBSubnetGroupStateFault" + "com.amazonaws.rds#PendingMaintenanceActions": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#ResourcePendingMaintenanceActions", + "traits": { + "smithy.api#xmlName": "ResourcePendingMaintenanceActions" + } + } }, - { - "target": "com.amazonaws.rds#InvalidSubnet" + "com.amazonaws.rds#PendingMaintenanceActionsMessage": { + "type": "structure", + "members": { + "PendingMaintenanceActions": { + "target": "com.amazonaws.rds#PendingMaintenanceActions", + "traits": { + "smithy.api#documentation": "

A list of the pending maintenance actions for the resource.

" + } + }, + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribePendingMaintenanceActions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to a number of records specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Data returned from the DescribePendingMaintenanceActions action.

" + } }, - { - "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + "com.amazonaws.rds#PendingModifiedValues": { + "type": "structure", + "members": { + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the compute and memory capacity class for the DB instance.

" + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The allocated storage size for the DB instance specified in gibibytes (GiB).

" + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The master credentials for the DB instance.

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port for the DB instance.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automated backups are retained.

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine version.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The license model for the DB instance.

\n

Valid values: license-included | bring-your-own-license | \n general-public-license\n

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The Provisioned IOPS value for the DB instance.

" + } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database identifier for the DB instance.

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The storage type of the DB instance.

" + } + }, + "CACertificateIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the CA certificate for the DB instance.

\n

For more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB subnet group for the DB instance.

" + } + }, + "PendingCloudwatchLogsExports": { + "target": "com.amazonaws.rds#PendingCloudwatchLogsExports" + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class\n of the DB instance.

" + } + }, + "IAMDatabaseAuthenticationEnabled": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" + } + }, + "AutomationMode": { + "target": "com.amazonaws.rds#AutomationMode", + "traits": { + "smithy.api#documentation": "

The automation mode of the RDS Custom DB instance: full or all-paused. \n If full, the DB instance automates monitoring and instance recovery. If \n all-paused, the instance pauses automation for the duration set by \n --resume-full-automation-mode-minutes.

" + } + }, + "ResumeFullAutomationModeTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. \n The minimum value is 60 (default). The maximum value is 1,440.

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The storage throughput of the DB instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the ModifyDBInstance operation and \n contains changes that will be applied during the next maintenance window.

" + } }, - { - "target": "com.amazonaws.rds#StorageQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Modify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB cluster. \n You can change one or more settings by specifying these parameters and the new values in the\n request.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

" - } - }, - "com.amazonaws.rds#ModifyDBClusterEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyDBClusterEndpointMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBClusterEndpoint" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterEndpointNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterEndpointStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

\n \n

This action only applies to Aurora DB clusters.

\n " - } - }, - "com.amazonaws.rds#ModifyDBClusterEndpointMessage": { - "type": "structure", - "members": { - "DBClusterEndpointIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the endpoint to modify. This parameter is stored as a lowercase string.

", - "smithy.api#required": {} - } - }, - "EndpointType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The type of the endpoint. One of: READER, WRITER, ANY.

" - } - }, - "StaticMembers": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

List of DB instance identifiers that are part of the custom endpoint group.

" - } - }, - "ExcludedMembers": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

List of DB instance identifiers that aren't part of the custom endpoint group.\n All other eligible instances are reachable through the custom endpoint.\n Only relevant if the list of static members is empty.

" - } - } - } - }, - "com.amazonaws.rds#ModifyDBClusterMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

\n

Constraints: This identifier must match the identifier of an existing DB\n cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", - "smithy.api#required": {} - } - }, - "NewDBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster2\n

\n

Valid for: Aurora DB clusters only

" - } - }, - "ApplyImmediately": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether the modifications in this request and\n any pending modifications are asynchronously applied\n as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the DB cluster. \n If this parameter is disabled, changes to the\n DB cluster are applied during the next maintenance window.

\n

The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, \n MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately \n parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, \n and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are\n applied immediately, regardless of the value of the ApplyImmediately parameter.

\n

By default, this parameter is disabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days for which automated backups are retained. Specify a minimum value of 1.

\n

Default: 1

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group to use for the DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of VPC security groups that the DB cluster will belong to.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port number on which the DB cluster accepts connections.

\n

Constraints: Value must be 1150-65535\n

\n

Default: The same port as the original DB cluster.

\n

Valid for: Aurora DB clusters only

" - } - }, - "MasterUserPassword": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The new password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A value that indicates that the DB cluster should be associated with the specified option group.

\n

DB clusters are associated with a default option group that can't be modified.

" - } - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" - } - }, - "BacktrackWindow": { - "target": "com.amazonaws.rds#LongOptional", - "traits": { - "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n

Default: 0

\n

Constraints:

\n \n

Valid for: Aurora MySQL DB clusters only

" - } - }, - "CloudwatchLogsExportConfiguration": { - "target": "com.amazonaws.rds#CloudwatchLogsExportConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. The values\n in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version number of the database engine to which you want to upgrade. \n Changing this parameter results in an outage. The change is applied during\n the next maintenance window unless ApplyImmediately is enabled.

\n

To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "AllowMajorVersionUpgrade": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether major version upgrades are allowed.

\n

Constraints: You must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\n cluster's current version.

\n

Valid for: Aurora DB clusters only

" - } - }, - "DBInstanceParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to apply to all instances of the DB cluster.

\n \n

When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB\n cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than \n during the next maintenance window.

\n \n

Default: The existing name setting

\n

Constraints:

\n \n

Valid for: Aurora DB clusters only

" - } - }, - "Domain": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Active Directory directory ID to move the DB cluster to. \n Specify none to remove the cluster from its current domain.\n The domain must be created prior to this operation.

\n

For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" - } - }, - "DomainIAMRoleName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

Valid for: Aurora DB clusters only

" - } - }, - "ScalingConfiguration": { - "target": "com.amazonaws.rds#ScalingConfiguration", - "traits": { - "smithy.api#documentation": "

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

\n

Valid for: Aurora DB clusters only

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "EnableHttpEndpoint": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint \n is disabled.

\n

When enabled, the HTTP endpoint provides a connectionless web service API for running\n SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database\n from inside the RDS console with the query editor.

\n

For more information, see Using the Data API for Aurora Serverless v1 in the \n Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. \n The default is not to copy them.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "EnableGlobalWriteForwarding": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an\n Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that\n are secondary clusters in an Aurora global database.

\n

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter\n enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to\n this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is\n demoted by the FailoverGlobalCluster API operation, but it does nothing until then.

\n

Valid for: Aurora DB clusters only

" - } - }, - "DBClusterInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes and availability for your engine, see \n DB Instance Class in the Amazon RDS User Guide.

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

\n

Type: Integer

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB cluster.

\n

Valid values: io1\n

\n

When specified, a value for the Iops parameter is required.

\n

Default: io1\n

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated \n for each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, see \n Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. \n By default, minor engine upgrades are applied automatically.

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "MonitoringInterval": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. \n To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.

\n

If MonitoringRoleArn is specified, also set MonitoringInterval\n to a value other than 0.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "MonitoringRoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An\n example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "EnablePerformanceInsights": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to turn on Performance Insights for the DB cluster.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "PerformanceInsightsKMSKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "PerformanceInsightsRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "ServerlessV2ScalingConfiguration": { - "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" - } - }, - "ManageMasterUserPassword": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn \n on this management. In this case, you can't specify MasterUserPassword.

\n

If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the \n master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. \n In this case, RDS deletes the secret and uses the new password for the master user specified by \n MasterUserPassword.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "RotateMasterUserPassword": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to rotate the secret managed by Amazon Web Services Secrets Manager for the \n master user password.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster. The secret value contains the updated password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "MasterUserSecretKmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if both of the following conditions are met:

\n \n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#ModifyDBClusterParameterGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyDBClusterParameterGroupMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBClusterParameterGroupNameMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, \n and ApplyMethod. A maximum of 20\n parameters can be modified in a single request.

\n \n

After you create a DB cluster parameter group, you should wait at least 5 minutes\n before creating your first DB cluster that uses that DB cluster parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB cluster. This is especially important for parameters \n that are critical when creating the default database for a DB cluster, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBClusterParameters operation to verify \n that your DB cluster parameter group has been created or modified.

\n

If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora\n applies the update immediately. The cluster restart might interrupt your workload. In that case,\n your application must reopen any connections and retry any transactions that were active\n when the parameter changes took effect.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" - } - }, - "com.amazonaws.rds#ModifyDBClusterParameterGroupMessage": { - "type": "structure", - "members": { - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group to modify.

", - "smithy.api#required": {} - } - }, - "Parameters": { - "target": "com.amazonaws.rds#ParametersList", - "traits": { - "smithy.api#documentation": "

A list of parameters in the DB cluster parameter group to modify.

\n

Valid Values (for the application method): immediate | pending-reboot\n

\n \n

You can use the immediate value with dynamic parameters only. You can use the \n pending-reboot value for both dynamic and static parameters.

\n

When the application method is immediate, changes to dynamic parameters are applied immediately \n to the DB clusters associated with the parameter group. When the application method is pending-reboot, \n changes to dynamic and static parameters are applied after a reboot without failover to the DB clusters associated with the \n parameter group.

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#ModifyDBClusterResult": { - "type": "structure", - "members": { - "DBCluster": { - "target": "com.amazonaws.rds#DBCluster" - } - } - }, - "com.amazonaws.rds#ModifyDBClusterSnapshotAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeMessage" - }, - "output": { - "target": "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" - }, - { - "target": "com.amazonaws.rds#SharedSnapshotQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

\n

To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify\n restore as the AttributeName and use the\n ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are\n authorized to restore the manual DB cluster snapshot. Use the value all to\n make the manual DB cluster snapshot public, which means that it can be copied or\n restored by all Amazon Web Services accounts.

\n \n

Don't add the all value for any manual DB cluster snapshots\n that contain private information that you don't want available to all Amazon Web Services\n accounts.

\n \n

If a manual DB cluster snapshot is encrypted, it can be shared, but only by\n specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd\n parameter. You can't use all as a value for that parameter in this\n case.

\n

To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster\n snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are\n returned as values for the restore attribute.

" - } - }, - "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeMessage": { - "type": "structure", - "members": { - "DBClusterSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the DB cluster snapshot to modify the attributes for.

", - "smithy.api#required": {} - } - }, - "AttributeName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster snapshot attribute to modify.

\n

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, \n set this value to restore.

\n \n

To view the list of attributes available to modify, use the\n DescribeDBClusterSnapshotAttributes API operation.

\n ", - "smithy.api#required": {} - } - }, - "ValuesToAdd": { - "target": "com.amazonaws.rds#AttributeValueList", - "traits": { - "smithy.api#documentation": "

A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.

\n

To authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account\n IDs, or all to make the manual DB cluster snapshot restorable by \n any Amazon Web Services account. Do not add the all value for any\n manual DB cluster snapshots that contain private information that you don't want available\n to all Amazon Web Services accounts.

" - } - }, - "ValuesToRemove": { - "target": "com.amazonaws.rds#AttributeValueList", - "traits": { - "smithy.api#documentation": "

A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.

\n

To remove authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include\n one or more Amazon Web Services account\n identifiers, or all to remove authorization for any Amazon Web Services account to copy or\n restore the DB cluster snapshot. If you specify all, an Amazon Web Services account whose account ID is\n explicitly added to the restore attribute\n can still copy or restore a manual DB cluster snapshot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#ModifyDBClusterSnapshotAttributeResult": { - "type": "structure", - "members": { - "DBClusterSnapshotAttributesResult": { - "target": "com.amazonaws.rds#DBClusterSnapshotAttributesResult" - } - } - }, - "com.amazonaws.rds#ModifyDBInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyDBInstanceMessage" - }, - "output": { - "target": "com.amazonaws.rds#ModifyDBInstanceResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#AuthorizationNotFoundFault" + "com.amazonaws.rds#PointInTimeRestoreNotEnabledFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "PointInTimeRestoreNotEnabled", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

\n SourceDBInstanceIdentifier\n refers to a DB instance with\n BackupRetentionPeriod equal to 0.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#ProcessorFeature": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the processor feature. Valid names are coreCount and threadsPerCore.

" + } + }, + "Value": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The value of a processor feature name.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the processor features of a DB instance class.

\n

To specify the number of CPU cores, use the coreCount feature name \n for the Name parameter. To specify the number of threads per core, use the\n threadsPerCore feature name for the Name parameter.

\n

You can set the processor features of the DB instance class for a DB instance when you\n call one of the following actions:

\n \n

You can view the valid processor values for a particular instance class by calling the\n DescribeOrderableDBInstanceOptions action and specifying the\n instance class for the DBInstanceClass parameter.

\n

In addition, you can use the following actions for DB instance class processor information:

\n \n

If you call DescribeDBInstances, ProcessorFeature returns\n non-null values only if the following conditions are met:

\n \n

For more information, see Configuring the\n Processor of the DB Instance Class in the Amazon RDS User Guide.\n \n

" + } + }, + "com.amazonaws.rds#ProcessorFeatureList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#ProcessorFeature", + "traits": { + "smithy.api#xmlName": "ProcessorFeature" + } + } + }, + "com.amazonaws.rds#PromoteReadReplica": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#PromoteReadReplicaMessage" + }, + "output": { + "target": "com.amazonaws.rds#PromoteReadReplicaResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Promotes a read replica DB instance to a standalone DB instance.

\n \n \n " + } + }, + "com.amazonaws.rds#PromoteReadReplicaDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#PromoteReadReplicaDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#PromoteReadReplicaDBClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Promotes a read replica DB cluster to a standalone DB cluster.

" + } + }, + "com.amazonaws.rds#PromoteReadReplicaDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DB cluster read replica to promote. This parameter isn't\n case-sensitive.

\n

Constraints:

\n \n

Example: my-cluster-replica1\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#PromoteReadReplicaDBClusterResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + } + }, + "com.amazonaws.rds#PromoteReadReplicaMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance identifier. This value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mydbinstance\n

", + "smithy.api#required": {} + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

\n

Default: 1

\n

Constraints:

\n " + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.\n

\n

Constraints:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#PromoteReadReplicaResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + } + }, + "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ProvisionedIopsNotAvailableInAZFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Provisioned IOPS not available in the specified Availability Zone.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#PurchaseReservedDBInstancesOffering": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingMessage" + }, + "output": { + "target": "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#ReservedDBInstanceAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#ReservedDBInstanceQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#ReservedDBInstancesOfferingNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Purchases a reserved DB instance offering.

" + } + }, + "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingMessage": { + "type": "structure", + "members": { + "ReservedDBInstancesOfferingId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ID of the Reserved DB instance offering to purchase.

\n

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

", + "smithy.api#required": {} + } + }, + "ReservedDBInstanceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Customer-specified identifier to track this reservation.

\n

Example: myreservationID

" + } + }, + "DBInstanceCount": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of instances to reserve.

\n

Default: 1\n

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingResult": { + "type": "structure", + "members": { + "ReservedDBInstance": { + "target": "com.amazonaws.rds#ReservedDBInstance" + } + } + }, + "com.amazonaws.rds#Range": { + "type": "structure", + "members": { + "From": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The minimum value in the range.

" + } + }, + "To": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum value in the range.

" + } + }, + "Step": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The step value for the range.\n For example, if you have a range of 5,000 to 10,000,\n with a step value of 1,000,\n the valid values start at 5,000 and step up by 1,000.\n Even though 7,500 is within the range,\n it isn't a valid value for the range.\n The valid values are 5,000, 6,000, 7,000, 8,000...

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A range of integer values.

" + } + }, + "com.amazonaws.rds#RangeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Range", + "traits": { + "smithy.api#xmlName": "Range" + } + } }, - { - "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" + "com.amazonaws.rds#ReadReplicaDBClusterIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "ReadReplicaDBClusterIdentifier" + } + } }, - { - "target": "com.amazonaws.rds#CertificateNotFoundFault" + "com.amazonaws.rds#ReadReplicaDBInstanceIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "ReadReplicaDBInstanceIdentifier" + } + } }, - { - "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" + "com.amazonaws.rds#ReadReplicaIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "ReadReplicaIdentifier" + } + } }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + "com.amazonaws.rds#ReadersArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } }, - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + "com.amazonaws.rds#RebootDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RebootDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#RebootDBClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

You might need to reboot your DB cluster, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB cluster parameter group associated with the DB cluster, \n reboot the DB cluster for the changes to take effect.

\n

Rebooting a DB cluster restarts the database engine service. Rebooting a DB \n cluster results in a momentary outage, during which the DB cluster status is set to rebooting.

\n

Use this operation only for a non-Aurora Multi-AZ DB cluster.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the \n Amazon RDS User Guide.\n

" + } }, - { - "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + "com.amazonaws.rds#RebootDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.rds#DBUpgradeDependencyFailureFault" + "com.amazonaws.rds#RebootDBClusterResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + } }, - { - "target": "com.amazonaws.rds#DomainNotFoundFault" + "com.amazonaws.rds#RebootDBInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RebootDBInstanceMessage" + }, + "output": { + "target": "com.amazonaws.rds#RebootDBInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

You might need to reboot your DB instance, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB parameter group associated with the DB instance, \n you must reboot the instance for the changes to take effect.

\n

Rebooting a DB instance restarts the database engine service. \n Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

\n

For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.\n

\n

This command doesn't apply to RDS Custom.

\n

If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.

" + } }, - { - "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" + "com.amazonaws.rds#RebootDBInstanceMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "ForceFailover": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the reboot is conducted through a Multi-AZ failover.

\n

Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + "com.amazonaws.rds#RebootDBInstanceResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + } }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + "com.amazonaws.rds#RecurringCharge": { + "type": "structure", + "members": { + "RecurringChargeAmount": { + "target": "com.amazonaws.rds#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of the recurring charge.

" + } + }, + "RecurringChargeFrequency": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The frequency of the recurring charge.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the \n DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.

" + } }, - { - "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" + "com.amazonaws.rds#RecurringChargeList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#RecurringCharge", + "traits": { + "smithy.api#xmlName": "RecurringCharge" + } + } }, - { - "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + "com.amazonaws.rds#RegisterDBProxyTargets": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RegisterDBProxyTargetsRequest" + }, + "output": { + "target": "com.amazonaws.rds#RegisterDBProxyTargetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetAlreadyRegisteredFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InsufficientAvailableIPsInSubnetFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBProxyStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.

" + } }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + "com.amazonaws.rds#RegisterDBProxyTargetsRequest": { + "type": "structure", + "members": { + "DBProxyName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DBProxy that is associated with the DBProxyTargetGroup.

", + "smithy.api#required": {} + } + }, + "TargetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the DBProxyTargetGroup.

" + } + }, + "DBInstanceIdentifiers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

One or more DB instance identifiers.

" + } + }, + "DBClusterIdentifiers": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

One or more DB cluster identifiers.

" + } + } + } }, - { - "target": "com.amazonaws.rds#NetworkTypeNotSupported" + "com.amazonaws.rds#RegisterDBProxyTargetsResponse": { + "type": "structure", + "members": { + "DBProxyTargets": { + "target": "com.amazonaws.rds#TargetList", + "traits": { + "smithy.api#documentation": "

One or more DBProxyTarget objects that are created when you register targets with a target group.

" + } + } + } }, - { - "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + "com.amazonaws.rds#RemoveFromGlobalCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RemoveFromGlobalClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#RemoveFromGlobalClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a\n standalone cluster with read-write capability instead of being read-only and receiving data from a\n primary cluster in a different Region.

\n \n

This action only applies to Aurora DB clusters.

\n " + } }, - { - "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" + "com.amazonaws.rds#RemoveFromGlobalClusterMessage": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The cluster identifier to detach from the Aurora global database cluster.

" + } + }, + "DbClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.

" + } + } + } }, - { - "target": "com.amazonaws.rds#StorageQuotaExceededFault" + "com.amazonaws.rds#RemoveFromGlobalClusterResult": { + "type": "structure", + "members": { + "GlobalCluster": { + "target": "com.amazonaws.rds#GlobalCluster" + } + } }, - { - "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies settings for a DB instance. \n You can change one or more database configuration parameters by specifying these parameters and the new values in the request.\n To learn what modifications you can make to your DB instance,\n call DescribeValidDBInstanceModifications\n before you call ModifyDBInstance.

" - } - }, - "com.amazonaws.rds#ModifyDBInstanceMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB instance identifier. This value is stored as a lowercase string.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The new amount of storage in gibibytes (GiB) to allocate for the DB instance.

\n

For MariaDB, MySQL, Oracle, and PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.

\n

For the valid values for allocated storage for each engine,\n see CreateDBInstance.

" - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The new compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all\n Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the \n Amazon RDS User Guide or \n Aurora\n DB instance classes in the Amazon Aurora User Guide. For RDS Custom, see DB instance class support for RDS Custom for Oracle and \n DB instance class support for RDS Custom for SQL Server.

\n

If you modify the DB instance class, an outage occurs during the change. The change is\n applied during the next maintenance window, unless you specify\n ApplyImmediately in your request.

\n

Default: Uses existing setting

" - } - }, - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The new DB subnet group for the DB instance.\n You can use this parameter to move your DB instance to a different VPC.\n \n \n If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC.\n For more information, see \n Working with a DB instance in a VPC \n in the Amazon RDS User Guide.

\n

Changing the subnet group causes an outage during the change. \n The change is applied during the next maintenance window,\n unless you enable ApplyImmediately.

\n

This parameter doesn't apply to RDS Custom.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" - } - }, - "DBSecurityGroups": { - "target": "com.amazonaws.rds#DBSecurityGroupNameList", - "traits": { - "smithy.api#documentation": "

A list of DB security groups to authorize on this DB instance. Changing this setting doesn't \n result in an outage and the change is asynchronously applied as soon as possible.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n " - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of Amazon EC2 VPC security groups to authorize on this DB instance. This change is \n asynchronously applied as soon as possible.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster. For more information, see ModifyDBCluster.

\n

Constraints:

\n " - } - }, - "ApplyImmediately": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, \n regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.

\n

If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage\n and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in \n Modifying a DB Instance in the \n Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to \n determine when the changes are applied.

" - } - }, - "MasterUserPassword": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The new password for the master user. The password can include any printable ASCII \n character except \"/\", \"\"\", or \"@\".

\n

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.

\n

This setting doesn't apply to RDS Custom.

\n

\n Amazon Aurora\n

\n

Not applicable. The password for the master user is managed by the DB cluster. For\n more information, see ModifyDBCluster.

\n

Default: Uses existing setting

\n

Constraints: Can't be specified if ManageMasterUserPassword is turned on.

\n

\n MariaDB\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Microsoft SQL Server\n

\n

Constraints: Must contain from 8 to 128 characters.

\n

\n MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Oracle\n

\n

Constraints: Must contain from 8 to 30 characters.

\n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

\n \n

Amazon RDS API operations never return the password, \n so this action provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.

\n " - } - }, - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to apply to the DB instance.

\n

Changing this setting doesn't result in an outage. The parameter group name itself is changed\n immediately, but the actual parameter changes are not applied until you reboot the\n instance without failover. In this case, the DB instance isn't rebooted automatically, and the\n parameter changes aren't applied during the next maintenance window. However, if you modify \n dynamic parameters in the newly associated DB parameter group, these changes are applied \n immediately without a reboot.

\n

This setting doesn't apply to RDS Custom.

\n

Default: Uses existing setting

\n

Constraints: The DB parameter group must be in the same DB parameter group family as the DB instance.

" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

\n \n

Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.

\n \n

These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled\n for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously\n applied as soon as possible.

\n

\n Amazon Aurora\n

\n

Not applicable. The retention period for automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.

\n

Default: Uses existing setting

\n

Constraints:

\n " - } - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n as determined by the BackupRetentionPeriod parameter. \n Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.\n

\n

\n Amazon Aurora\n

\n

Not applicable. The daily time range for creating automated backups is managed by\n the DB cluster. For more information, see ModifyDBCluster.

\n

Constraints:

\n " - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The weekly time range (in UTC) during which system maintenance can occur, which\n might result in an outage. Changing this parameter doesn't result in an outage, except\n in the following situation, and the change is asynchronously applied as soon as\n possible. If there are pending actions that cause a reboot, and the maintenance window\n is changed to include the current time, then changing this parameter will cause a reboot\n of the DB instance. If moving this window to the current time, there must be at least 30\n minutes between the current time and end of the window to ensure pending changes are\n applied.

\n

For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.\n

\n

Default: Uses existing setting

\n

Format: ddd:hh24:mi-ddd:hh24:mi

\n

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

\n

Constraints: Must be at least 30 minutes

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result \n in an outage. The change is applied during the next maintenance window unless the ApplyImmediately \n parameter is enabled for this request.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.

\n

For major version upgrades, if a nondefault DB parameter group is currently in use, a\n new DB parameter group in the DB parameter group family for the new engine version must\n be specified. The new DB parameter group can be the default for that DB parameter group\n family.

\n

If you specify only a major version, Amazon RDS will update the DB instance to the \n default minor version if the current minor version is lower.\n For information about valid engine versions, see CreateDBInstance, \n or call DescribeDBEngineVersions.

\n

In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the \n PATCH_DB_FAILURE lifecycle.

" - } - }, - "AllowMajorVersionUpgrade": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't \n result in an outage and the change is asynchronously applied as soon as possible.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints: Major version upgrades must be allowed when specifying a value \n for the EngineVersion parameter that is a different major version than the DB instance's current version.

" - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether minor version upgrades are applied automatically to the DB instance \n during the maintenance window. An outage occurs when all the following conditions are met:

\n \n

If any of the preceding conditions isn't met, RDS applies the change as soon as possible and\n doesn't cause an outage.

\n

For an RDS Custom DB instance, set AutoMinorVersionUpgrade \n to false. Otherwise, the operation returns an error.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The license model for the DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

Valid values: license-included | bring-your-own-license | \n general-public-license\n

" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The new Provisioned IOPS (I/O operations per second) value for the RDS instance.

\n

Changing this setting doesn't result in an outage and\n the change is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n If you are migrating from Provisioned IOPS to standard storage, set this value to 0. \n The DB instance will require a reboot for the change in storage type to take effect.

\n

If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.

\n

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

\n

Default: Uses existing setting

" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A value that indicates the DB instance should be associated with the specified option group.

\n

Changing this parameter doesn't result in an outage, with one exception. If the parameter change results \n in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which \n new connections are rejected but existing connections aren't interrupted.

\n

The change is applied during the next maintenance window unless the ApplyImmediately parameter \n is enabled for this request.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group, and that option group can't be removed from a DB instance after \n it is associated with a DB instance.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "NewDBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance \n identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur \n during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n \n

Example: mydbinstance\n

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

If you specify Provisioned IOPS (io1), \n you must also include a value for the Iops parameter.

\n

If you choose to migrate your DB instance from using standard storage to using\n Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process\n can take time. The duration of the migration depends on several factors such as database\n load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS\n provisioned (if any), and the number of prior scale storage operations. Typical\n migration times are under 24 hours, but the process can take up to several days in some\n cases. During the migration, the DB instance is available for use, but might experience\n performance degradation. While the migration takes place, nightly backups for the\n instance are suspended. No other Amazon RDS operations can take place for the instance,\n including modifying the instance, rebooting the instance, deleting the instance,\n creating a read replica for the instance, and creating a DB snapshot of the instance.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" - } - }, - "TdeCredentialArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "TdeCredentialPassword": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "CACertificateIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the certificate to associate with the DB instance.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "Domain": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Active Directory directory ID to move the DB instance to. \n Specify none to remove the instance from its current domain.\n You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

\n

\n Amazon Aurora\n

\n

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this\n value for an Aurora DB instance has no effect on the DB cluster setting. For more\n information, see ModifyDBCluster.

" - } - }, - "MonitoringInterval": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected \n for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0, which is the default.

\n

If MonitoringRoleArn is specified, set MonitoringInterval to a value other than 0.

\n

This setting doesn't apply to RDS Custom.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60\n

" - } - }, - "DBPortNumber": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

The value of the DBPortNumber parameter must not match any of the port values \n specified for options in the option group for the DB instance.

\n

If you change the DBPortNumber value, your database restarts regardless of \n the value of the ApplyImmediately parameter.

\n

This setting doesn't apply to RDS Custom.

\n

\n MySQL\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

\n

\n MariaDB\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

\n

\n PostgreSQL\n

\n

Default: 5432\n

\n

Valid values: 1150-65535\n

\n

Type: Integer

\n

\n Oracle\n

\n

Default: 1521\n

\n

Valid values: 1150-65535\n

\n

\n SQL Server\n

\n

Default: 1433\n

\n

Valid values: 1150-65535 except 1234, 1434,\n 3260, 3343, 3389, 47001, and\n 49152-49156.

\n

\n Amazon Aurora\n

\n

Default: 3306\n

\n

Valid values: 1150-65535\n

" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

\n PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a \n public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.

\n

Changes to the PubliclyAccessible parameter are applied immediately regardless\n of the value of the ApplyImmediately parameter.

" - } - }, - "MonitoringRoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn \n value.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "DomainIAMRoleName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the IAM role to use when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "PromotionTier": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

\n

This setting doesn't apply to RDS Custom.

\n

Default: 1

\n

Valid Values: 0 - 15

" - } - }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB\n cluster.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "EnablePerformanceInsights": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the DB instance.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "PerformanceInsightsKMSKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "PerformanceInsightsRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "CloudwatchLogsExportConfiguration": { - "target": "com.amazonaws.rds#CloudwatchLogsExportConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a \n specific DB instance.

\n

A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance \n immediately. Therefore, the ApplyImmediately parameter has no effect.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "ProcessorFeatures": { - "target": "com.amazonaws.rds#ProcessorFeatureList", - "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "UseDefaultProcessorFeatures": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" - } - }, - "MaxAllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "CertificateRotationRestart": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is restarted when you rotate your \n SSL/TLS certificate.

\n

By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate \n is not updated until the DB instance is restarted.

\n \n

Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

\n \n

If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your \n DB engine to rotate your SSL/TLS certificate:

\n \n

This setting doesn't apply to RDS Custom.

" - } - }, - "ReplicaMode": { - "target": "com.amazonaws.rds#ReplicaMode", - "traits": { - "smithy.api#documentation": "

A value that sets the open mode of a replica database to either mounted or read-only.

\n \n

Currently, this parameter is only supported for Oracle DB instances.

\n \n

Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for \n mounted replicas is cross-Region disaster recovery. The primary database doesn't use \n Active Data Guard to transmit information to the mounted replica. Because it doesn't \n accept user connections, a mounted replica can't serve a read-only workload. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "EnableCustomerOwnedIp": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" - } - }, - "AwsBackupRecoveryPointArn": { - "target": "com.amazonaws.rds#AwsBackupRecoveryPointArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "AutomationMode": { - "target": "com.amazonaws.rds#AutomationMode", - "traits": { - "smithy.api#documentation": "

The automation mode of the RDS Custom DB instance: full or all paused. \n If full, the DB instance automates monitoring and instance recovery. If \n all paused, the instance pauses automation for the duration set by \n ResumeFullAutomationModeMinutes.

" - } - }, - "ResumeFullAutomationModeMinutes": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes \n full automation. The minimum value is 60 (default). The maximum value is 1,440.

" - } - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" - } - }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting applies only to the gp3 storage type.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" - } - }, - "ManageMasterUserPassword": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn \n on this management. In this case, you can't specify MasterUserPassword.

\n

If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the \n master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. \n In this case, RDS deletes the secret and uses the new password for the master user specified by \n MasterUserPassword.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

\n " - } - }, - "RotateMasterUserPassword": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to rotate the secret managed by Amazon Web Services Secrets Manager for the \n master user password.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster. The secret value contains the updated password.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

\n " - } - }, - "MasterUserSecretKmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if both of the following conditions are met:

\n \n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#ModifyDBInstanceResult": { - "type": "structure", - "members": { - "DBInstance": { - "target": "com.amazonaws.rds#DBInstance" - } - } - }, - "com.amazonaws.rds#ModifyDBParameterGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyDBParameterGroupMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBParameterGroupNameMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies the parameters of a DB parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, and \n ApplyMethod. A maximum of 20 parameters can be modified in a single request.

\n \n

After you modify a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the modify action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.

\n " - } - }, - "com.amazonaws.rds#ModifyDBParameterGroupMessage": { - "type": "structure", - "members": { - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "Parameters": { - "target": "com.amazonaws.rds#ParametersList", - "traits": { - "smithy.api#documentation": "

An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and \n application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.

\n

Valid Values (for the application method): immediate | pending-reboot\n

\n

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic \n and static parameters.

\n

When the application method is immediate, changes to dynamic parameters are applied immediately to the DB instances associated with \n the parameter group.

\n

When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover \n to the DB instances associated with the parameter group.

\n \n

You can't use pending-reboot with dynamic parameters on RDS for SQL Server DB instances. Use immediate.

\n \n

For more information on modifying DB parameters, see Working \n with DB parameter groups in the Amazon RDS User Guide.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#ModifyDBProxy": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyDBProxyRequest" - }, - "output": { - "target": "com.amazonaws.rds#ModifyDBProxyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBProxyAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBProxyNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBProxyStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Changes the settings for an existing DB proxy.

" - } - }, - "com.amazonaws.rds#ModifyDBProxyEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyDBProxyEndpointRequest" - }, - "output": { - "target": "com.amazonaws.rds#ModifyDBProxyEndpointResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBProxyEndpointAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#DBProxyEndpointNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBProxyEndpointStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBProxyStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Changes the settings for an existing DB proxy endpoint.

" - } - }, - "com.amazonaws.rds#ModifyDBProxyEndpointRequest": { - "type": "structure", - "members": { - "DBProxyEndpointName": { - "target": "com.amazonaws.rds#DBProxyEndpointName", - "traits": { - "smithy.api#documentation": "

The name of the DB proxy sociated with the DB proxy endpoint that you want to modify.

", - "smithy.api#required": {} - } - }, - "NewDBProxyEndpointName": { - "target": "com.amazonaws.rds#DBProxyEndpointName", - "traits": { - "smithy.api#documentation": "

The new identifier for the DBProxyEndpoint. An identifier must\n begin with a letter and must contain only ASCII letters, digits, and hyphens; it\n can't end with a hyphen or contain two consecutive hyphens.

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint\n uses a different VPC than the original proxy, you also specify a different\n set of security group IDs than for the original proxy.

" - } - } - } - }, - "com.amazonaws.rds#ModifyDBProxyEndpointResponse": { - "type": "structure", - "members": { - "DBProxyEndpoint": { - "target": "com.amazonaws.rds#DBProxyEndpoint", - "traits": { - "smithy.api#documentation": "

The DBProxyEndpoint object representing the new settings for the DB proxy endpoint.

" - } - } - } - }, - "com.amazonaws.rds#ModifyDBProxyRequest": { - "type": "structure", - "members": { - "DBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the DBProxy to modify.

", - "smithy.api#required": {} - } - }, - "NewDBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The new identifier for the DBProxy. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

" - } - }, - "Auth": { - "target": "com.amazonaws.rds#UserAuthConfigList", - "traits": { - "smithy.api#documentation": "

The new authentication settings for the DBProxy.

" - } - }, - "RequireTLS": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Whether Transport Layer Security (TLS) encryption is required for connections to the proxy.\n By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn't\n use TLS.

" - } - }, - "IdleClientTimeout": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this\n value higher or lower than the connection timeout limit for the associated database.

" - } - }, - "DebugLogging": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Whether the proxy includes detailed information about SQL statements in its logs.\n This information helps you to debug issues involving SQL behavior or the performance\n and scalability of the proxy connections. The debug information includes the text of\n SQL statements that you submit through the proxy. Thus, only enable this setting\n when needed for debugging, and only when you have security measures in place to\n safeguard any sensitive information that appears in the logs.

" - } - }, - "RoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The new list of security groups for the DBProxy.

" - } - } - } - }, - "com.amazonaws.rds#ModifyDBProxyResponse": { - "type": "structure", - "members": { - "DBProxy": { - "target": "com.amazonaws.rds#DBProxy", - "traits": { - "smithy.api#documentation": "

The DBProxy object representing the new settings for the proxy.

" - } - } - } - }, - "com.amazonaws.rds#ModifyDBProxyTargetGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyDBProxyTargetGroupRequest" - }, - "output": { - "target": "com.amazonaws.rds#ModifyDBProxyTargetGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBProxyNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBProxyStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies the properties of a DBProxyTargetGroup.

" - } - }, - "com.amazonaws.rds#ModifyDBProxyTargetGroupRequest": { - "type": "structure", - "members": { - "TargetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the target group to modify.

", - "smithy.api#required": {} - } - }, - "DBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the proxy.

", - "smithy.api#required": {} - } - }, - "ConnectionPoolConfig": { - "target": "com.amazonaws.rds#ConnectionPoolConfiguration", - "traits": { - "smithy.api#documentation": "

The settings that determine the size and behavior of the connection pool for the target group.

" - } - }, - "NewName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The new name for the modified DBProxyTarget. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

" - } - } - } - }, - "com.amazonaws.rds#ModifyDBProxyTargetGroupResponse": { - "type": "structure", - "members": { - "DBProxyTargetGroup": { - "target": "com.amazonaws.rds#DBProxyTargetGroup", - "traits": { - "smithy.api#documentation": "

The settings of the modified DBProxyTarget.

" - } - } - } - }, - "com.amazonaws.rds#ModifyDBSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyDBSnapshotMessage" - }, - "output": { - "target": "com.amazonaws.rds#ModifyDBSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted\n or unencrypted, but not shared or public.\n \n

\n

Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command\n doesn't apply to RDS Custom.

" - } - }, - "com.amazonaws.rds#ModifyDBSnapshotAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyDBSnapshotAttributeMessage" - }, - "output": { - "target": "com.amazonaws.rds#ModifyDBSnapshotAttributeResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" - }, - { - "target": "com.amazonaws.rds#SharedSnapshotQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

\n

To share a manual DB snapshot with other Amazon Web Services accounts, specify restore\n as the AttributeName and use the ValuesToAdd parameter to add\n a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot.\n Uses the value all to make the manual DB snapshot public, which means it\n can be copied or restored by all Amazon Web Services accounts.

\n \n

Don't add the all value for any manual DB snapshots that\n contain private information that you don't want available to all Amazon Web Services\n accounts.

\n \n

If the manual DB snapshot is encrypted, it can be shared, but only by specifying a\n list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You\n can't use all as a value for that parameter in this case.

\n

To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or\n whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as\n values for the restore attribute.

" - } - }, - "com.amazonaws.rds#ModifyDBSnapshotAttributeMessage": { - "type": "structure", - "members": { - "DBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the DB snapshot to modify the attributes for.

", - "smithy.api#required": {} - } - }, - "AttributeName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB snapshot attribute to modify.

\n

To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, \n set this value to restore.

\n \n

To view the list of attributes available to modify, use the\n DescribeDBSnapshotAttributes API operation.

\n ", - "smithy.api#required": {} - } - }, - "ValuesToAdd": { - "target": "com.amazonaws.rds#AttributeValueList", - "traits": { - "smithy.api#documentation": "

A list of DB snapshot attributes to add to the attribute specified by AttributeName.

\n

To authorize other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account\n IDs, or all to make the manual DB snapshot restorable by \n any Amazon Web Services account. Do not add the all value for any\n manual DB snapshots that contain private information that you don't want available\n to all Amazon Web Services accounts.

" - } - }, - "ValuesToRemove": { - "target": "com.amazonaws.rds#AttributeValueList", - "traits": { - "smithy.api#documentation": "

A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

\n

To remove authorization for other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include \n one or more Amazon Web Services account\n identifiers, or all to remove authorization for any Amazon Web Services account to copy or\n restore the DB snapshot. If you specify all, an Amazon Web Services account whose\n account ID is explicitly added to the restore attribute\n can still copy or restore the manual DB snapshot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#ModifyDBSnapshotAttributeResult": { - "type": "structure", - "members": { - "DBSnapshotAttributesResult": { - "target": "com.amazonaws.rds#DBSnapshotAttributesResult" - } - } - }, - "com.amazonaws.rds#ModifyDBSnapshotMessage": { - "type": "structure", - "members": { - "DBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DB snapshot to modify.

", - "smithy.api#required": {} - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The engine version to upgrade the DB snapshot to.

\n

The following are the database engines and engine versions that are available when you upgrade a DB snapshot.

\n

\n MySQL\n

\n \n

\n Oracle\n

\n \n

\n PostgreSQL\n

\n

For the list of engine versions that are available for upgrading a DB snapshot, see \n \n Upgrading the PostgreSQL DB Engine for Amazon RDS.

" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The option group to identify with the upgraded DB snapshot.

\n

You can specify this parameter when you upgrade an Oracle DB snapshot.\n The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance.\n For more information, see \n Option group considerations in the Amazon RDS User Guide.\n

" - } - } - } - }, - "com.amazonaws.rds#ModifyDBSnapshotResult": { - "type": "structure", - "members": { - "DBSnapshot": { - "target": "com.amazonaws.rds#DBSnapshot" - } - } - }, - "com.amazonaws.rds#ModifyDBSubnetGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyDBSubnetGroupMessage" - }, - "output": { - "target": "com.amazonaws.rds#ModifyDBSubnetGroupResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" - }, - { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSubnetQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#InvalidSubnet" - }, - { - "target": "com.amazonaws.rds#SubnetAlreadyInUse" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

" - } - }, - "com.amazonaws.rds#ModifyDBSubnetGroupMessage": { - "type": "structure", - "members": { - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name for the DB subnet group. This value is stored as a lowercase string.\n You can't modify the default subnet group.

\n

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

\n

Example: mydbsubnetgroup\n

", - "smithy.api#required": {} - } - }, - "DBSubnetGroupDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description for the DB subnet group.

" - } - }, - "SubnetIds": { - "target": "com.amazonaws.rds#SubnetIdentifierList", - "traits": { - "smithy.api#documentation": "

The EC2 subnet IDs for the DB subnet group.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#ModifyDBSubnetGroupResult": { - "type": "structure", - "members": { - "DBSubnetGroup": { - "target": "com.amazonaws.rds#DBSubnetGroup" - } - } - }, - "com.amazonaws.rds#ModifyEventSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyEventSubscriptionMessage" - }, - "output": { - "target": "com.amazonaws.rds#ModifyEventSubscriptionResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#EventSubscriptionQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#SNSInvalidTopicFault" - }, - { - "target": "com.amazonaws.rds#SNSNoAuthorizationFault" - }, - { - "target": "com.amazonaws.rds#SNSTopicArnNotFoundFault" - }, - { - "target": "com.amazonaws.rds#SubscriptionCategoryNotFoundFault" - }, - { - "target": "com.amazonaws.rds#SubscriptionNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change \n source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

\n

You can see a list of the event categories for a given source type (SourceType) \n in Events in the Amazon RDS User Guide \n or by using the DescribeEventCategories operation.

" - } - }, - "com.amazonaws.rds#ModifyEventSubscriptionMessage": { - "type": "structure", - "members": { - "SubscriptionName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the RDS event notification subscription.

", - "smithy.api#required": {} - } - }, - "SnsTopicArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

" - } - }, - "SourceType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.

\n

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy\n

" - } - }, - "EventCategories": { - "target": "com.amazonaws.rds#EventCategoriesList", - "traits": { - "smithy.api#documentation": "

A list of event categories for a source type (SourceType) that you want to subscribe to. \n You can see a list of the categories for a given source type \n in Events in the Amazon RDS User Guide \n or by using the DescribeEventCategories operation.

" - } - }, - "Enabled": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to activate the subscription.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#ModifyEventSubscriptionResult": { - "type": "structure", - "members": { - "EventSubscription": { - "target": "com.amazonaws.rds#EventSubscription" - } - } - }, - "com.amazonaws.rds#ModifyGlobalCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyGlobalClusterMessage" - }, - "output": { - "target": "com.amazonaws.rds#ModifyGlobalClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration\n parameters by specifying these parameters and the new values in the request. For more information on\n Amazon Aurora, see What is Amazon Aurora? in the\n Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters.

\n " - } - }, - "com.amazonaws.rds#ModifyGlobalClusterMessage": { - "type": "structure", - "members": { - "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive.

\n

Constraints:

\n " - } - }, - "NewGlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The new cluster identifier for the global database cluster when modifying a global database cluster.\n This value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: my-cluster2\n

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Indicates if the global database cluster has deletion protection enabled. The global database cluster\n can't be deleted when deletion protection is enabled.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version number of the database engine to which you want to upgrade. \n Changing this parameter results in an outage. The change is applied during\n the next maintenance window unless ApplyImmediately is enabled.

\n

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n

\n

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n

\n

To list all of the available engine versions for aurora-postgresql, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n

" - } - }, - "AllowMajorVersionUpgrade": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether major version upgrades are allowed.

\n

Constraints: You must allow major version upgrades when specifying a value for the\n EngineVersion parameter that is a different major version than the DB\n cluster's current version.

\n

If you upgrade the major version of a global database, the cluster and DB instance parameter\n groups are set to the default parameter groups for the new version. Apply any custom parameter\n groups after completing the upgrade.

" - } - } - } - }, - "com.amazonaws.rds#ModifyGlobalClusterResult": { - "type": "structure", - "members": { - "GlobalCluster": { - "target": "com.amazonaws.rds#GlobalCluster" - } - } - }, - "com.amazonaws.rds#ModifyOptionGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ModifyOptionGroupMessage" - }, - "output": { - "target": "com.amazonaws.rds#ModifyOptionGroupResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#InvalidOptionGroupStateFault" - }, - { - "target": "com.amazonaws.rds#OptionGroupNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies an existing option group.

" - } - }, - "com.amazonaws.rds#ModifyOptionGroupMessage": { - "type": "structure", - "members": { - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the option group to be modified.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

", - "smithy.api#required": {} - } - }, - "OptionsToInclude": { - "target": "com.amazonaws.rds#OptionConfigurationList", - "traits": { - "smithy.api#documentation": "

Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.

" - } - }, - "OptionsToRemove": { - "target": "com.amazonaws.rds#OptionNamesList", - "traits": { - "smithy.api#documentation": "

Options in this list are removed from the option group.

" - } - }, - "ApplyImmediately": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#ModifyOptionGroupResult": { - "type": "structure", - "members": { - "OptionGroup": { - "target": "com.amazonaws.rds#OptionGroup" - } - } - }, - "com.amazonaws.rds#NetworkTypeNotSupported": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "NetworkTypeNotSupported", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The network type is invalid for the DB instance. Valid nework type values are IPV4 and DUAL.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#Option": { - "type": "structure", - "members": { - "OptionName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the option.

" - } - }, - "OptionDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description of the option.

" - } - }, - "Persistent": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicate if this option is persistent.

" - } - }, - "Permanent": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicate if this option is permanent.

" - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

If required, the port configured for this option to use.

" - } - }, - "OptionVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version of the option.

" - } - }, - "OptionSettings": { - "target": "com.amazonaws.rds#OptionSettingConfigurationList", - "traits": { - "smithy.api#documentation": "

The option settings for this option.

" - } - }, - "DBSecurityGroupMemberships": { - "target": "com.amazonaws.rds#DBSecurityGroupMembershipList", - "traits": { - "smithy.api#documentation": "

If the option requires access to a port, then this DB security group allows access to the port.

" - } - }, - "VpcSecurityGroupMemberships": { - "target": "com.amazonaws.rds#VpcSecurityGroupMembershipList", - "traits": { - "smithy.api#documentation": "

If the option requires access to a port, then this VPC security group allows access to the port.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Option details.

" - } - }, - "com.amazonaws.rds#OptionConfiguration": { - "type": "structure", - "members": { - "OptionName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The configuration of options to include in a group.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The optional port for the option.

" - } - }, - "OptionVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version for the option.

" - } - }, - "DBSecurityGroupMemberships": { - "target": "com.amazonaws.rds#DBSecurityGroupNameList", - "traits": { - "smithy.api#documentation": "

A list of DBSecurityGroupMembership name strings used for this option.

" - } - }, - "VpcSecurityGroupMemberships": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of VpcSecurityGroupMembership name strings used for this option.

" - } - }, - "OptionSettings": { - "target": "com.amazonaws.rds#OptionSettingsList", - "traits": { - "smithy.api#documentation": "

The option settings to include in an option group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A list of all available options

" - } - }, - "com.amazonaws.rds#OptionConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#OptionConfiguration", - "traits": { - "smithy.api#xmlName": "OptionConfiguration" - } - } - }, - "com.amazonaws.rds#OptionGroup": { - "type": "structure", - "members": { - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the option group.

" - } - }, - "OptionGroupDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides a description of the option group.

" - } - }, - "EngineName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Indicates the name of the engine that this option group can be applied to.

" - } - }, - "MajorEngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Indicates the major engine version associated with this option group.

" - } - }, - "Options": { - "target": "com.amazonaws.rds#OptionsList", - "traits": { - "smithy.api#documentation": "

Indicates what options are available in the option group.

" - } - }, - "AllowsVpcAndNonVpcInstanceMemberships": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether this option group can be applied to both VPC \n and non-VPC instances. The value true indicates the option group \n can be applied to both VPC and non-VPC instances.

" - } - }, - "VpcId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank.\n If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, \n then this option group can be applied to both VPC and non-VPC instances.\n If this field contains a value, then this option group can only be \n applied to instances that are in the VPC indicated by this field.

" - } - }, - "OptionGroupArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) for the option group.

" - } - }, - "SourceOptionGroup": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the option group from which this option group is copied.

" - } - }, - "SourceAccountId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the Amazon Web Services account ID for the option group from which this option group is copied.

" - } - }, - "CopyTimestamp": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

Indicates when the option group was copied.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#OptionGroupAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "OptionGroupAlreadyExistsFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The option group you are trying to create already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#OptionGroupMembership": { - "type": "structure", - "members": { - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the option group that the instance belongs to.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The status of the DB instance's option group membership. Valid values are: \n in-sync, \n pending-apply, \n pending-removal, \n pending-maintenance-apply, \n pending-maintenance-removal, \n applying, \n removing, \n and failed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information on the option groups the DB instance is a member of.

" - } - }, - "com.amazonaws.rds#OptionGroupMembershipList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#OptionGroupMembership", - "traits": { - "smithy.api#xmlName": "OptionGroupMembership" - } - } - }, - "com.amazonaws.rds#OptionGroupNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "OptionGroupNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The specified option group could not be found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#OptionGroupOption": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the option.

" - } - }, - "Description": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description of the option.

" - } - }, - "EngineName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the engine that this option can be applied to.

" - } - }, - "MajorEngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Indicates the major engine version that the option is available for.

" - } - }, - "MinimumRequiredMinorEngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The minimum required engine version for the option to be applied.

" - } - }, - "PortRequired": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether the option requires a port.

" - } - }, - "DefaultPort": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

If the option requires a port, specifies the default port for the option.

" - } - }, - "OptionsDependedOn": { - "target": "com.amazonaws.rds#OptionsDependedOn", - "traits": { - "smithy.api#documentation": "

The options that are prerequisites for this option.

" - } - }, - "OptionsConflictsWith": { - "target": "com.amazonaws.rds#OptionsConflictsWith", - "traits": { - "smithy.api#documentation": "

The options that conflict with this option.

" - } - }, - "Persistent": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.

" - } - }, - "Permanent": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.

" - } - }, - "RequiresAutoMinorEngineVersionUpgrade": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

If true, you must enable the Auto Minor Version Upgrade setting for your DB instance \n before you can use this option.\n You can enable Auto Minor Version Upgrade when you first create your DB instance,\n or by modifying your DB instance later.

" - } - }, - "VpcOnly": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

If true, you can only use this option with a DB instance that is in a VPC.

" - } - }, - "SupportsOptionVersionDowngrade": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

If true, you can change the option to an earlier version of the option. \n This only applies to options that have different versions available.

" - } - }, - "OptionGroupOptionSettings": { - "target": "com.amazonaws.rds#OptionGroupOptionSettingsList", - "traits": { - "smithy.api#documentation": "

The option settings that are available (and the default value) for each option in an option group.

" - } - }, - "OptionGroupOptionVersions": { - "target": "com.amazonaws.rds#OptionGroupOptionVersionsList", - "traits": { - "smithy.api#documentation": "

The versions that are available for the option.

" - } - }, - "CopyableCrossAccount": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether the option can be copied across Amazon Web Services accounts.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Available option.

" - } - }, - "com.amazonaws.rds#OptionGroupOptionSetting": { - "type": "structure", - "members": { - "SettingName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the option group option.

" - } - }, - "SettingDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description of the option group option.

" - } - }, - "DefaultValue": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The default value for the option group option.

" - } - }, - "ApplyType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB engine specific parameter type for the option group option.

" - } - }, - "AllowedValues": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Indicates the acceptable values for the option group option.

" - } - }, - "IsModifiable": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Boolean value where true indicates that this option group option can be changed from the default value.

" - } - }, - "IsRequired": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Boolean value where true indicates that a value must be specified for this option setting of the option group option.

" - } - }, - "MinimumEngineVersionPerAllowedValue": { - "target": "com.amazonaws.rds#MinimumEngineVersionPerAllowedValueList", - "traits": { - "smithy.api#documentation": "

The minimum DB engine version required for the corresponding allowed value for this option setting.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.

" - } - }, - "com.amazonaws.rds#OptionGroupOptionSettingsList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#OptionGroupOptionSetting", - "traits": { - "smithy.api#xmlName": "OptionGroupOptionSetting" - } - } - }, - "com.amazonaws.rds#OptionGroupOptionVersionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#OptionVersion", - "traits": { - "smithy.api#xmlName": "OptionVersion" - } - } - }, - "com.amazonaws.rds#OptionGroupOptionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#OptionGroupOption", - "traits": { - "smithy.api#xmlName": "OptionGroupOption" - } - }, - "traits": { - "smithy.api#documentation": "

List of available option group options.

" - } - }, - "com.amazonaws.rds#OptionGroupOptionsMessage": { - "type": "structure", - "members": { - "OptionGroupOptions": { - "target": "com.amazonaws.rds#OptionGroupOptionsList" - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#OptionGroupQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "OptionGroupQuotaExceededFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The quota of 20 option groups was exceeded for this Amazon Web Services account.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#OptionGroups": { - "type": "structure", - "members": { - "OptionGroupsList": { - "target": "com.amazonaws.rds#OptionGroupsList", - "traits": { - "smithy.api#documentation": "

List of option groups.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

List of option groups.

" - } - }, - "com.amazonaws.rds#OptionGroupsList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#OptionGroup", - "traits": { - "smithy.api#xmlName": "OptionGroup" - } - } - }, - "com.amazonaws.rds#OptionNamesList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String" - } - }, - "com.amazonaws.rds#OptionSetting": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the option that has settings that you can set.

" - } - }, - "Value": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The current value of the option setting.

" - } - }, - "DefaultValue": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The default value of the option setting.

" - } - }, - "Description": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description of the option setting.

" - } - }, - "ApplyType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB engine specific parameter type.

" - } - }, - "DataType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The data type of the option setting.

" - } - }, - "AllowedValues": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The allowed values of the option setting.

" - } - }, - "IsModifiable": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that, when true, indicates the option setting can be modified from the default.

" - } - }, - "IsCollection": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates if the option setting is part of a collection.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.

" - } - }, - "com.amazonaws.rds#OptionSettingConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#OptionSetting", - "traits": { - "smithy.api#xmlName": "OptionSetting" - } - } - }, - "com.amazonaws.rds#OptionSettingsList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#OptionSetting", - "traits": { - "smithy.api#xmlName": "OptionSetting" - } - } - }, - "com.amazonaws.rds#OptionVersion": { - "type": "structure", - "members": { - "Version": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version of the option.

" - } - }, - "IsDefault": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

True if the version is the default version of the option, and otherwise false.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The version for an option. Option group option versions are returned by \n the DescribeOptionGroupOptions action.

" - } - }, - "com.amazonaws.rds#OptionsConflictsWith": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#xmlName": "OptionConflictName" - } - } - }, - "com.amazonaws.rds#OptionsDependedOn": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#xmlName": "OptionName" - } - } - }, - "com.amazonaws.rds#OptionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#Option", - "traits": { - "smithy.api#xmlName": "Option" - } - } - }, - "com.amazonaws.rds#OrderableDBInstanceOption": { - "type": "structure", - "members": { - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The engine type of a DB instance.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The engine version of a DB instance.

" - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB instance class for a DB instance.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The license model for a DB instance.

" - } - }, - "AvailabilityZoneGroup": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Availability Zone group for a DB instance.

" - } - }, - "AvailabilityZones": { - "target": "com.amazonaws.rds#AvailabilityZoneList", - "traits": { - "smithy.api#documentation": "

A list of Availability Zones for a DB instance.

" - } - }, - "MultiAZCapable": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a DB instance is Multi-AZ capable.

" - } - }, - "ReadReplicaCapable": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a DB instance can have a read replica.

" - } - }, - "Vpc": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a DB instance is in a VPC.

" - } - }, - "SupportsStorageEncryption": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a DB instance supports encrypted storage.

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Indicates the storage type for a DB instance.

" - } - }, - "SupportsIops": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a DB instance supports provisioned IOPS.

" - } - }, - "SupportsEnhancedMonitoring": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

" - } - }, - "SupportsIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a DB instance supports IAM database authentication.

" - } - }, - "SupportsPerformanceInsights": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

True if a DB instance supports Performance Insights, otherwise false.

" - } - }, - "MinStorageSize": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Minimum storage size for a DB instance.

" - } - }, - "MaxStorageSize": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Maximum storage size for a DB instance.

" - } - }, - "MinIopsPerDbInstance": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Minimum total provisioned IOPS for a DB instance.

" - } - }, - "MaxIopsPerDbInstance": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Maximum total provisioned IOPS for a DB instance.

" - } - }, - "MinIopsPerGib": { - "target": "com.amazonaws.rds#DoubleOptional", - "traits": { - "smithy.api#documentation": "

Minimum provisioned IOPS per GiB for a DB instance.

" - } - }, - "MaxIopsPerGib": { - "target": "com.amazonaws.rds#DoubleOptional", - "traits": { - "smithy.api#documentation": "

Maximum provisioned IOPS per GiB for a DB instance.

" - } - }, - "AvailableProcessorFeatures": { - "target": "com.amazonaws.rds#AvailableProcessorFeatureList", - "traits": { - "smithy.api#documentation": "

A list of the available processor features for the DB instance class of a DB instance.

" - } - }, - "SupportedEngineModes": { - "target": "com.amazonaws.rds#EngineModeList", - "traits": { - "smithy.api#documentation": "

A list of the supported DB engine modes.

" - } - }, - "SupportsStorageAutoscaling": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.

" - } - }, - "SupportsKerberosAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Whether a DB instance supports Kerberos Authentication.

" - } - }, - "OutpostCapable": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether a DB instance supports RDS on Outposts.

\n

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n

" - } - }, - "SupportedActivityStreamModes": { - "target": "com.amazonaws.rds#ActivityStreamModeList", - "traits": { - "smithy.api#documentation": "

The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value [sync,\n async]. Aurora MySQL and RDS for Oracle return [async] only. If Database Activity Streams \n isn't supported, the return value is an empty list.

" - } - }, - "SupportsGlobalDatabases": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.

" - } - }, - "SupportsClusters": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether DB instances can be configured as a Multi-AZ DB cluster.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" - } - }, - "SupportedNetworkTypes": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The network types supported by the DB instance (IPV4 or DUAL).

\n

A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" - } - }, - "SupportsStorageThroughput": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a DB instance supports storage throughput.

" - } - }, - "MinStorageThroughputPerDbInstance": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Minimum storage throughput for a DB instance.

" - } - }, - "MaxStorageThroughputPerDbInstance": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Maximum storage throughput for a DB instance.

" - } - }, - "MinStorageThroughputPerIops": { - "target": "com.amazonaws.rds#DoubleOptional", - "traits": { - "smithy.api#documentation": "

Minimum storage throughput to provisioned IOPS ratio for a DB instance.

" - } - }, - "MaxStorageThroughputPerIops": { - "target": "com.amazonaws.rds#DoubleOptional", - "traits": { - "smithy.api#documentation": "

Maximum storage throughput to provisioned IOPS ratio for a DB instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains a list of available options for a DB instance.

\n

This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

" - } - }, - "com.amazonaws.rds#OrderableDBInstanceOptionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#OrderableDBInstanceOption", - "traits": { - "smithy.api#xmlName": "OrderableDBInstanceOption" - } - } - }, - "com.amazonaws.rds#OrderableDBInstanceOptionsMessage": { - "type": "structure", - "members": { - "OrderableDBInstanceOptions": { - "target": "com.amazonaws.rds#OrderableDBInstanceOptionsList", - "traits": { - "smithy.api#documentation": "

An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous \n OrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

" - } - }, - "com.amazonaws.rds#Outpost": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A data type that represents an Outpost.

\n

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n

" - } - }, - "com.amazonaws.rds#Parameter": { - "type": "structure", - "members": { - "ParameterName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the name of the parameter.

" - } - }, - "ParameterValue": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the value of the parameter.

" - } - }, - "Description": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Provides a description of the parameter.

" - } - }, - "Source": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Indicates the source of the parameter value.

" - } - }, - "ApplyType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the engine specific parameters type.

" - } - }, - "DataType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the valid data type for the parameter.

" - } - }, - "AllowedValues": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the valid range of values for the parameter.

" - } - }, - "IsModifiable": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether (true) or not (false) the parameter can be modified.\n Some parameters have security or operational implications\n that prevent them from being changed.

" - } - }, - "MinimumEngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The earliest engine version to which the parameter can apply.

" - } - }, - "ApplyMethod": { - "target": "com.amazonaws.rds#ApplyMethod", - "traits": { - "smithy.api#documentation": "

Indicates when to apply parameter updates.

" - } - }, - "SupportedEngineModes": { - "target": "com.amazonaws.rds#EngineModeList", - "traits": { - "smithy.api#documentation": "

The valid DB engine modes.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a request parameter in the\n ModifyDBParameterGroup and ResetDBParameterGroup actions.

\n

This data type is used as a response element in the \n DescribeEngineDefaultParameters and DescribeDBParameters actions.

" - } - }, - "com.amazonaws.rds#ParametersList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#Parameter", - "traits": { - "smithy.api#xmlName": "Parameter" - } - } - }, - "com.amazonaws.rds#PendingCloudwatchLogsExports": { - "type": "structure", - "members": { - "LogTypesToEnable": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

" - } - }, - "LogTypesToDisable": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.

" - } - }, - "com.amazonaws.rds#PendingMaintenanceAction": { - "type": "structure", - "members": { - "Action": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The type of pending maintenance action that is available for the resource. \n Valid actions are system-update, db-upgrade, hardware-maintenance, \n and ca-certificate-rotation.

" - } - }, - "AutoAppliedAfterDate": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The date of the maintenance window when the action is applied.\n The maintenance action is applied to the resource during\n its first maintenance window after this date.

" - } - }, - "ForcedApplyDate": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The date when the maintenance action is automatically applied.

\n

On this date, the maintenance action is applied to the resource as soon as possible, \n regardless of the maintenance window for the resource. There might be a delay of \n one or more days from this date before the maintenance action is applied.

" - } - }, - "OptInStatus": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Indicates the type of opt-in request that has been received for the resource.

" - } - }, - "CurrentApplyDate": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The effective date when the pending maintenance action is applied \n to the resource. This date takes into account opt-in requests received from\n the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate,\n and the ForcedApplyDate. This value is blank if an \n opt-in request has not been received and nothing has been specified as\n AutoAppliedAfterDate or ForcedApplyDate.

" - } - }, - "Description": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A description providing more detail about the maintenance action.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about a pending maintenance action for a resource.

" - } - }, - "com.amazonaws.rds#PendingMaintenanceActionDetails": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#PendingMaintenanceAction", - "traits": { - "smithy.api#xmlName": "PendingMaintenanceAction" - } - } - }, - "com.amazonaws.rds#PendingMaintenanceActions": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#ResourcePendingMaintenanceActions", - "traits": { - "smithy.api#xmlName": "ResourcePendingMaintenanceActions" - } - } - }, - "com.amazonaws.rds#PendingMaintenanceActionsMessage": { - "type": "structure", - "members": { - "PendingMaintenanceActions": { - "target": "com.amazonaws.rds#PendingMaintenanceActions", - "traits": { - "smithy.api#documentation": "

A list of the pending maintenance actions for the resource.

" - } - }, - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribePendingMaintenanceActions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to a number of records specified by MaxRecords.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Data returned from the DescribePendingMaintenanceActions action.

" - } - }, - "com.amazonaws.rds#PendingModifiedValues": { - "type": "structure", - "members": { - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the compute and memory capacity class for the DB instance.

" - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The allocated storage size for the DB instance specified in gibibytes (GiB).

" - } - }, - "MasterUserPassword": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The master credentials for the DB instance.

" - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port for the DB instance.

" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days for which automated backups are retained.

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database engine version.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The license model for the DB instance.

\n

Valid values: license-included | bring-your-own-license | \n general-public-license\n

" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The Provisioned IOPS value for the DB instance.

" - } - }, - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database identifier for the DB instance.

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The storage type of the DB instance.

" - } - }, - "CACertificateIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the CA certificate for the DB instance.

" - } - }, - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB subnet group for the DB instance.

" - } - }, - "PendingCloudwatchLogsExports": { - "target": "com.amazonaws.rds#PendingCloudwatchLogsExports" - }, - "ProcessorFeatures": { - "target": "com.amazonaws.rds#ProcessorFeatureList", - "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class\n of the DB instance.

" - } - }, - "IAMDatabaseAuthenticationEnabled": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" - } - }, - "AutomationMode": { - "target": "com.amazonaws.rds#AutomationMode", - "traits": { - "smithy.api#documentation": "

The automation mode of the RDS Custom DB instance: full or all-paused. \n If full, the DB instance automates monitoring and instance recovery. If \n all-paused, the instance pauses automation for the duration set by \n --resume-full-automation-mode-minutes.

" - } - }, - "ResumeFullAutomationModeTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. \n The minimum value is 60 (default). The maximum value is 1,440.

" - } - }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The storage throughput of the DB instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the ModifyDBInstance operation and \n contains changes that will be applied during the next maintenance window.

" - } - }, - "com.amazonaws.rds#PointInTimeRestoreNotEnabledFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "PointInTimeRestoreNotEnabled", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

\n SourceDBInstanceIdentifier\n refers to a DB instance with\n BackupRetentionPeriod equal to 0.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#ProcessorFeature": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the processor feature. Valid names are coreCount and threadsPerCore.

" - } - }, - "Value": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The value of a processor feature name.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the processor features of a DB instance class.

\n

To specify the number of CPU cores, use the coreCount feature name \n for the Name parameter. To specify the number of threads per core, use the\n threadsPerCore feature name for the Name parameter.

\n

You can set the processor features of the DB instance class for a DB instance when you\n call one of the following actions:

\n \n

You can view the valid processor values for a particular instance class by calling the\n DescribeOrderableDBInstanceOptions action and specifying the\n instance class for the DBInstanceClass parameter.

\n

In addition, you can use the following actions for DB instance class processor information:

\n \n

If you call DescribeDBInstances, ProcessorFeature returns\n non-null values only if the following conditions are met:

\n \n

For more information, see Configuring the\n Processor of the DB Instance Class in the Amazon RDS User Guide.\n \n

" - } - }, - "com.amazonaws.rds#ProcessorFeatureList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#ProcessorFeature", - "traits": { - "smithy.api#xmlName": "ProcessorFeature" - } - } - }, - "com.amazonaws.rds#PromoteReadReplica": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#PromoteReadReplicaMessage" - }, - "output": { - "target": "com.amazonaws.rds#PromoteReadReplicaResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Promotes a read replica DB instance to a standalone DB instance.

\n \n \n " - } - }, - "com.amazonaws.rds#PromoteReadReplicaDBCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#PromoteReadReplicaDBClusterMessage" - }, - "output": { - "target": "com.amazonaws.rds#PromoteReadReplicaDBClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Promotes a read replica DB cluster to a standalone DB cluster.

" - } - }, - "com.amazonaws.rds#PromoteReadReplicaDBClusterMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DB cluster read replica to promote. This parameter isn't\n case-sensitive.

\n

Constraints:

\n \n

Example: my-cluster-replica1\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#PromoteReadReplicaDBClusterResult": { - "type": "structure", - "members": { - "DBCluster": { - "target": "com.amazonaws.rds#DBCluster" - } - } - }, - "com.amazonaws.rds#PromoteReadReplicaMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB instance identifier. This value is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mydbinstance\n

", - "smithy.api#required": {} - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

\n

Default: 1

\n

Constraints:

\n " - } - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.\n

\n

Constraints:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#PromoteReadReplicaResult": { - "type": "structure", - "members": { - "DBInstance": { - "target": "com.amazonaws.rds#DBInstance" - } - } - }, - "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ProvisionedIopsNotAvailableInAZFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

Provisioned IOPS not available in the specified Availability Zone.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#PurchaseReservedDBInstancesOffering": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingMessage" - }, - "output": { - "target": "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#ReservedDBInstanceAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#ReservedDBInstanceQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#ReservedDBInstancesOfferingNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Purchases a reserved DB instance offering.

" - } - }, - "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingMessage": { - "type": "structure", - "members": { - "ReservedDBInstancesOfferingId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ID of the Reserved DB instance offering to purchase.

\n

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

", - "smithy.api#required": {} - } - }, - "ReservedDBInstanceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Customer-specified identifier to track this reservation.

\n

Example: myreservationID

" - } - }, - "DBInstanceCount": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of instances to reserve.

\n

Default: 1\n

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#PurchaseReservedDBInstancesOfferingResult": { - "type": "structure", - "members": { - "ReservedDBInstance": { - "target": "com.amazonaws.rds#ReservedDBInstance" - } - } - }, - "com.amazonaws.rds#Range": { - "type": "structure", - "members": { - "From": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum value in the range.

" - } - }, - "To": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum value in the range.

" - } - }, - "Step": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The step value for the range.\n For example, if you have a range of 5,000 to 10,000,\n with a step value of 1,000,\n the valid values start at 5,000 and step up by 1,000.\n Even though 7,500 is within the range,\n it isn't a valid value for the range.\n The valid values are 5,000, 6,000, 7,000, 8,000...

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A range of integer values.

" - } - }, - "com.amazonaws.rds#RangeList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#Range", - "traits": { - "smithy.api#xmlName": "Range" - } - } - }, - "com.amazonaws.rds#ReadReplicaDBClusterIdentifierList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#xmlName": "ReadReplicaDBClusterIdentifier" - } - } - }, - "com.amazonaws.rds#ReadReplicaDBInstanceIdentifierList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#xmlName": "ReadReplicaDBInstanceIdentifier" - } - } - }, - "com.amazonaws.rds#ReadReplicaIdentifierList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#xmlName": "ReadReplicaIdentifier" - } - } - }, - "com.amazonaws.rds#ReadersArnList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String" - } - }, - "com.amazonaws.rds#RebootDBCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#RebootDBClusterMessage" - }, - "output": { - "target": "com.amazonaws.rds#RebootDBClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

You might need to reboot your DB cluster, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB cluster parameter group associated with the DB cluster, \n reboot the DB cluster for the changes to take effect.

\n

Rebooting a DB cluster restarts the database engine service. Rebooting a DB \n cluster results in a momentary outage, during which the DB cluster status is set to rebooting.

\n

Use this operation only for a non-Aurora Multi-AZ DB cluster.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the \n Amazon RDS User Guide.\n

" - } - }, - "com.amazonaws.rds#RebootDBClusterMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.rds#RebootDBClusterResult": { - "type": "structure", - "members": { - "DBCluster": { - "target": "com.amazonaws.rds#DBCluster" - } - } - }, - "com.amazonaws.rds#RebootDBInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#RebootDBInstanceMessage" - }, - "output": { - "target": "com.amazonaws.rds#RebootDBInstanceResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

You might need to reboot your DB instance, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB parameter group associated with the DB instance, \n you must reboot the instance for the changes to take effect.

\n

Rebooting a DB instance restarts the database engine service. \n Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

\n

For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.\n

\n

This command doesn't apply to RDS Custom.

\n

If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.

" - } - }, - "com.amazonaws.rds#RebootDBInstanceMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB instance identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "ForceFailover": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the reboot is conducted through a Multi-AZ failover.

\n

Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#RebootDBInstanceResult": { - "type": "structure", - "members": { - "DBInstance": { - "target": "com.amazonaws.rds#DBInstance" - } - } - }, - "com.amazonaws.rds#RecurringCharge": { - "type": "structure", - "members": { - "RecurringChargeAmount": { - "target": "com.amazonaws.rds#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of the recurring charge.

" - } - }, - "RecurringChargeFrequency": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The frequency of the recurring charge.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the \n DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.

" - } - }, - "com.amazonaws.rds#RecurringChargeList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#RecurringCharge", - "traits": { - "smithy.api#xmlName": "RecurringCharge" - } - } - }, - "com.amazonaws.rds#RegisterDBProxyTargets": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#RegisterDBProxyTargetsRequest" - }, - "output": { - "target": "com.amazonaws.rds#RegisterDBProxyTargetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" + "com.amazonaws.rds#RemoveRoleFromDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RemoveRoleFromDBClusterMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterRoleNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a\n DB cluster.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + } }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + "com.amazonaws.rds#RemoveRoleFromDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster to disassociate the IAM role from.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example\n arn:aws:iam::123456789012:role/AuroraAccessRole.

", + "smithy.api#required": {} + } + }, + "FeatureName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the feature for the DB cluster that the IAM role is to be disassociated from.\n For information about supported feature names, see DBEngineVersion.

" + } + } + } }, - { - "target": "com.amazonaws.rds#DBProxyNotFoundFault" + "com.amazonaws.rds#RemoveRoleFromDBInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RemoveRoleFromDBInstanceMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceRoleNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.

" + } }, - { - "target": "com.amazonaws.rds#DBProxyTargetAlreadyRegisteredFault" + "com.amazonaws.rds#RemoveRoleFromDBInstanceMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB instance to disassociate the IAM role from.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance,\n for example, arn:aws:iam::123456789012:role/AccessRole.

", + "smithy.api#required": {} + } + }, + "FeatureName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the feature for the DB instance that the IAM role is to be disassociated from.\n For information about supported feature names, see DBEngineVersion.

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" + "com.amazonaws.rds#RemoveSourceIdentifierFromSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RemoveSourceIdentifierFromSubscriptionMessage" + }, + "output": { + "target": "com.amazonaws.rds#RemoveSourceIdentifierFromSubscriptionResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#SourceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#SubscriptionNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a source identifier from an existing RDS event notification subscription.

" + } }, - { - "target": "com.amazonaws.rds#InsufficientAvailableIPsInSubnetFault" + "com.amazonaws.rds#RemoveSourceIdentifierFromSubscriptionMessage": { + "type": "structure", + "members": { + "SubscriptionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the RDS event notification subscription you want to remove a source identifier from.

", + "smithy.api#required": {} + } + }, + "SourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The source identifier to be removed from the subscription, such as the DB instance identifier \n for a DB instance or the name of a security group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + "com.amazonaws.rds#RemoveSourceIdentifierFromSubscriptionResult": { + "type": "structure", + "members": { + "EventSubscription": { + "target": "com.amazonaws.rds#EventSubscription" + } + } }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + "com.amazonaws.rds#RemoveTagsFromResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RemoveTagsFromResourceMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Removes metadata tags from an Amazon RDS resource.

\n

For an overview on tagging an Amazon RDS resource, \n see Tagging Amazon RDS Resources \n in the Amazon RDS User Guide.\n

" + } }, - { - "target": "com.amazonaws.rds#InvalidDBProxyStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.

" - } - }, - "com.amazonaws.rds#RegisterDBProxyTargetsRequest": { - "type": "structure", - "members": { - "DBProxyName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DBProxy that is associated with the DBProxyTargetGroup.

", - "smithy.api#required": {} - } - }, - "TargetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the DBProxyTargetGroup.

" - } - }, - "DBInstanceIdentifiers": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

One or more DB instance identifiers.

" - } - }, - "DBClusterIdentifiers": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

One or more DB cluster identifiers.

" - } - } - } - }, - "com.amazonaws.rds#RegisterDBProxyTargetsResponse": { - "type": "structure", - "members": { - "DBProxyTargets": { - "target": "com.amazonaws.rds#TargetList", - "traits": { - "smithy.api#documentation": "

One or more DBProxyTarget objects that are created when you register targets with a target group.

" - } - } - } - }, - "com.amazonaws.rds#RemoveFromGlobalCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#RemoveFromGlobalClusterMessage" - }, - "output": { - "target": "com.amazonaws.rds#RemoveFromGlobalClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#GlobalClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidGlobalClusterStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a\n standalone cluster with read-write capability instead of being read-only and receiving data from a\n primary cluster in a different Region.

\n \n

This action only applies to Aurora DB clusters.

\n " - } - }, - "com.amazonaws.rds#RemoveFromGlobalClusterMessage": { - "type": "structure", - "members": { - "GlobalClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The cluster identifier to detach from the Aurora global database cluster.

" - } - }, - "DbClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.

" - } - } - } - }, - "com.amazonaws.rds#RemoveFromGlobalClusterResult": { - "type": "structure", - "members": { - "GlobalCluster": { - "target": "com.amazonaws.rds#GlobalCluster" - } - } - }, - "com.amazonaws.rds#RemoveRoleFromDBCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#RemoveRoleFromDBClusterMessage" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterRoleNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a\n DB cluster.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" - } - }, - "com.amazonaws.rds#RemoveRoleFromDBClusterMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster to disassociate the IAM role from.

", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example\n arn:aws:iam::123456789012:role/AuroraAccessRole.

", - "smithy.api#required": {} - } - }, - "FeatureName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the feature for the DB cluster that the IAM role is to be disassociated from.\n For information about supported feature names, see DBEngineVersion.

" - } - } - } - }, - "com.amazonaws.rds#RemoveRoleFromDBInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#RemoveRoleFromDBInstanceMessage" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceRoleNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.

" - } - }, - "com.amazonaws.rds#RemoveRoleFromDBInstanceMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB instance to disassociate the IAM role from.

", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance,\n for example, arn:aws:iam::123456789012:role/AccessRole.

", - "smithy.api#required": {} - } - }, - "FeatureName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the feature for the DB instance that the IAM role is to be disassociated from.\n For information about supported feature names, see DBEngineVersion.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.rds#RemoveSourceIdentifierFromSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#RemoveSourceIdentifierFromSubscriptionMessage" - }, - "output": { - "target": "com.amazonaws.rds#RemoveSourceIdentifierFromSubscriptionResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#SourceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#SubscriptionNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Removes a source identifier from an existing RDS event notification subscription.

" - } - }, - "com.amazonaws.rds#RemoveSourceIdentifierFromSubscriptionMessage": { - "type": "structure", - "members": { - "SubscriptionName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the RDS event notification subscription you want to remove a source identifier from.

", - "smithy.api#required": {} - } - }, - "SourceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The source identifier to be removed from the subscription, such as the DB instance identifier \n for a DB instance or the name of a security group.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#RemoveSourceIdentifierFromSubscriptionResult": { - "type": "structure", - "members": { - "EventSubscription": { - "target": "com.amazonaws.rds#EventSubscription" - } - } - }, - "com.amazonaws.rds#RemoveTagsFromResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#RemoveTagsFromResourceMessage" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBProxyTargetGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Removes metadata tags from an Amazon RDS resource.

\n

For an overview on tagging an Amazon RDS resource, \n see Tagging Amazon RDS Resources \n in the Amazon RDS User Guide.\n

" - } - }, - "com.amazonaws.rds#RemoveTagsFromResourceMessage": { - "type": "structure", - "members": { - "ResourceName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.\n

", - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.rds#KeyList", - "traits": { - "smithy.api#documentation": "

The tag key (name) of the tag to be removed.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#ReplicaMode": { - "type": "enum", - "members": { - "OPEN_READ_ONLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "open-read-only" - } - }, - "MOUNTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "mounted" - } - } - } - }, - "com.amazonaws.rds#ReservedDBInstance": { - "type": "structure", - "members": { - "ReservedDBInstanceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The unique identifier for the reservation.

" - } - }, - "ReservedDBInstancesOfferingId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The offering identifier.

" - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB instance class for the reserved DB instance.

" - } - }, - "StartTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The time the reservation started.

" - } - }, - "Duration": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The duration of the reservation in seconds.

" - } - }, - "FixedPrice": { - "target": "com.amazonaws.rds#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The fixed price charged for this reserved DB instance.

" - } - }, - "UsagePrice": { - "target": "com.amazonaws.rds#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The hourly price charged for this reserved DB instance.

" - } - }, - "CurrencyCode": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The currency code for the reserved DB instance.

" - } - }, - "DBInstanceCount": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of reserved DB instances.

" - } - }, - "ProductDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The description of the reserved DB instance.

" - } - }, - "OfferingType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The offering type of this reserved DB instance.

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates if the reservation applies to Multi-AZ deployments.

" - } - }, - "State": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The state of the reserved DB instance.

" - } - }, - "RecurringCharges": { - "target": "com.amazonaws.rds#RecurringChargeList", - "traits": { - "smithy.api#documentation": "

The recurring price charged to run this reserved DB instance.

" - } - }, - "ReservedDBInstanceArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the reserved DB instance.

" - } - }, - "LeaseId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The unique identifier for the lease associated with the reserved DB instance.

\n \n

Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the \n DescribeReservedDBInstances and \n PurchaseReservedDBInstancesOffering actions.

" - } - }, - "com.amazonaws.rds#ReservedDBInstanceAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ReservedDBInstanceAlreadyExists", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

User already has a reservation with the given identifier.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#ReservedDBInstanceList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#ReservedDBInstance", - "traits": { - "smithy.api#xmlName": "ReservedDBInstance" - } - } - }, - "com.amazonaws.rds#ReservedDBInstanceMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "ReservedDBInstances": { - "target": "com.amazonaws.rds#ReservedDBInstanceList", - "traits": { - "smithy.api#documentation": "

A list of reserved DB instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeReservedDBInstances action.

" - } - }, - "com.amazonaws.rds#ReservedDBInstanceNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ReservedDBInstanceNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The specified reserved DB Instance not found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#ReservedDBInstanceQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ReservedDBInstanceQuotaExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

Request would exceed the user's DB Instance quota.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#ReservedDBInstancesOffering": { - "type": "structure", - "members": { - "ReservedDBInstancesOfferingId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The offering identifier.

" - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB instance class for the reserved DB instance.

" - } - }, - "Duration": { - "target": "com.amazonaws.rds#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The duration of the offering in seconds.

" - } - }, - "FixedPrice": { - "target": "com.amazonaws.rds#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The fixed price charged for this offering.

" - } - }, - "UsagePrice": { - "target": "com.amazonaws.rds#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The hourly price charged for this offering.

" - } - }, - "CurrencyCode": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The currency code for the reserved DB instance offering.

" - } - }, - "ProductDescription": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database engine used by the offering.

" - } - }, - "OfferingType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The offering type.

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates if the offering applies to Multi-AZ deployments.

" - } - }, - "RecurringCharges": { - "target": "com.amazonaws.rds#RecurringChargeList", - "traits": { - "smithy.api#documentation": "

The recurring price charged to run this reserved DB instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.

" - } - }, - "com.amazonaws.rds#ReservedDBInstancesOfferingList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#ReservedDBInstancesOffering", - "traits": { - "smithy.api#xmlName": "ReservedDBInstancesOffering" - } - } - }, - "com.amazonaws.rds#ReservedDBInstancesOfferingMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "ReservedDBInstancesOfferings": { - "target": "com.amazonaws.rds#ReservedDBInstancesOfferingList", - "traits": { - "smithy.api#documentation": "

A list of reserved DB instance offerings.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.

" - } - }, - "com.amazonaws.rds#ReservedDBInstancesOfferingNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ReservedDBInstancesOfferingNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

Specified offering does not exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#ResetDBClusterParameterGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ResetDBClusterParameterGroupMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBClusterParameterGroupNameMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies the parameters of a DB cluster parameter group to the default value. To\n reset specific parameters submit a list of the following: ParameterName \n and ApplyMethod. To reset the\n entire DB cluster parameter group, specify the DBClusterParameterGroupName \n and ResetAllParameters parameters.

\n

When resetting the entire group, dynamic parameters are updated immediately and static parameters\n are set to pending-reboot to take effect on the next DB instance restart \n or RebootDBInstance request. You must call RebootDBInstance for every\n DB instance in your DB cluster that you want the updated static parameter to apply to.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" - } - }, - "com.amazonaws.rds#ResetDBClusterParameterGroupMessage": { - "type": "structure", - "members": { - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group to reset.

", - "smithy.api#required": {} - } - }, - "ResetAllParameters": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to reset all parameters in the DB cluster parameter group \n to their default values. You can't use this parameter if there \n is a list of parameter names specified for the Parameters parameter.

" - } - }, - "Parameters": { - "target": "com.amazonaws.rds#ParametersList", - "traits": { - "smithy.api#documentation": "

A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this\n parameter if the ResetAllParameters parameter is enabled.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#ResetDBParameterGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ResetDBParameterGroupMessage" - }, - "output": { - "target": "com.amazonaws.rds#DBParameterGroupNameMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies the parameters of a DB parameter group to the engine/system default value.\n To reset specific parameters, provide a list of the following:\n ParameterName and ApplyMethod. To reset the entire DB\n parameter group, specify the DBParameterGroup name and\n ResetAllParameters parameters. When resetting the entire group, dynamic\n parameters are updated immediately and static parameters are set to\n pending-reboot to take effect on the next DB instance restart or\n RebootDBInstance request.

" - } - }, - "com.amazonaws.rds#ResetDBParameterGroupMessage": { - "type": "structure", - "members": { - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "ResetAllParameters": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to reset all parameters in the DB parameter group to default values. \n By default, all parameters in the DB parameter group are reset to default values.

" - } - }, - "Parameters": { - "target": "com.amazonaws.rds#ParametersList", - "traits": { - "smithy.api#documentation": "

To reset the entire DB parameter group, specify the DBParameterGroup\n name and ResetAllParameters parameters. To reset specific parameters,\n provide a list of the following: ParameterName and\n ApplyMethod. A maximum of 20 parameters can be modified in a single\n request.

\n

\n MySQL\n

\n

Valid Values (for Apply method): immediate | pending-reboot\n

\n

You can use the immediate value with dynamic parameters only. You can use \n the pending-reboot value for both dynamic and static parameters, and changes \n are applied when DB instance reboots.

\n

\n MariaDB\n

\n

Valid Values (for Apply method): immediate | pending-reboot\n

\n

You can use the immediate value with dynamic parameters only. You can use \n the pending-reboot value for both dynamic and static parameters, and changes \n are applied when DB instance reboots.

\n

\n Oracle\n

\n

Valid Values (for Apply method): pending-reboot\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#ResourceNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ResourceNotFoundFault", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The specified resource ID was not found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#ResourcePendingMaintenanceActions": { - "type": "structure", - "members": { - "ResourceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN of the resource that has pending maintenance actions.

" - } - }, - "PendingMaintenanceActionDetails": { - "target": "com.amazonaws.rds#PendingMaintenanceActionDetails", - "traits": { - "smithy.api#documentation": "

A list that provides details about the pending maintenance actions for the resource.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the pending maintenance actions for a resource.

" - } - }, - "com.amazonaws.rds#RestoreDBClusterFromS3": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#RestoreDBClusterFromS3Message" - }, - "output": { - "target": "com.amazonaws.rds#RestoreDBClusterFromS3Result" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" + "com.amazonaws.rds#RemoveTagsFromResourceMessage": { + "type": "structure", + "members": { + "ResourceName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, \n see \n Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.\n

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.rds#KeyList", + "traits": { + "smithy.api#documentation": "

The tag key (name) of the tag to be removed.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } + }, + "com.amazonaws.rds#ReplicaMode": { + "type": "enum", + "members": { + "OPEN_READ_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "open-read-only" + } + }, + "MOUNTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mounted" + } + } + } + }, + "com.amazonaws.rds#ReservedDBInstance": { + "type": "structure", + "members": { + "ReservedDBInstanceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The unique identifier for the reservation.

" + } + }, + "ReservedDBInstancesOfferingId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The offering identifier.

" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance class for the reserved DB instance.

" + } + }, + "StartTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time the reservation started.

" + } + }, + "Duration": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The duration of the reservation in seconds.

" + } + }, + "FixedPrice": { + "target": "com.amazonaws.rds#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The fixed price charged for this reserved DB instance.

" + } + }, + "UsagePrice": { + "target": "com.amazonaws.rds#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The hourly price charged for this reserved DB instance.

" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The currency code for the reserved DB instance.

" + } + }, + "DBInstanceCount": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of reserved DB instances.

" + } + }, + "ProductDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The description of the reserved DB instance.

" + } + }, + "OfferingType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The offering type of this reserved DB instance.

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates if the reservation applies to Multi-AZ deployments.

" + } + }, + "State": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The state of the reserved DB instance.

" + } + }, + "RecurringCharges": { + "target": "com.amazonaws.rds#RecurringChargeList", + "traits": { + "smithy.api#documentation": "

The recurring price charged to run this reserved DB instance.

" + } + }, + "ReservedDBInstanceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the reserved DB instance.

" + } + }, + "LeaseId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The unique identifier for the lease associated with the reserved DB instance.

\n \n

Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the \n DescribeReservedDBInstances and \n PurchaseReservedDBInstancesOffering actions.

" + } + }, + "com.amazonaws.rds#ReservedDBInstanceAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedDBInstanceAlreadyExists", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

User already has a reservation with the given identifier.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#ReservedDBInstanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#ReservedDBInstance", + "traits": { + "smithy.api#xmlName": "ReservedDBInstance" + } + } + }, + "com.amazonaws.rds#ReservedDBInstanceMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "ReservedDBInstances": { + "target": "com.amazonaws.rds#ReservedDBInstanceList", + "traits": { + "smithy.api#documentation": "

A list of reserved DB instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeReservedDBInstances action.

" + } + }, + "com.amazonaws.rds#ReservedDBInstanceNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedDBInstanceNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified reserved DB Instance not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#ReservedDBInstanceQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedDBInstanceQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Request would exceed the user's DB Instance quota.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#ReservedDBInstancesOffering": { + "type": "structure", + "members": { + "ReservedDBInstancesOfferingId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The offering identifier.

" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance class for the reserved DB instance.

" + } + }, + "Duration": { + "target": "com.amazonaws.rds#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The duration of the offering in seconds.

" + } + }, + "FixedPrice": { + "target": "com.amazonaws.rds#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The fixed price charged for this offering.

" + } + }, + "UsagePrice": { + "target": "com.amazonaws.rds#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The hourly price charged for this offering.

" + } + }, + "CurrencyCode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The currency code for the reserved DB instance offering.

" + } + }, + "ProductDescription": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine used by the offering.

" + } + }, + "OfferingType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The offering type.

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates if the offering applies to Multi-AZ deployments.

" + } + }, + "RecurringCharges": { + "target": "com.amazonaws.rds#RecurringChargeList", + "traits": { + "smithy.api#documentation": "

The recurring price charged to run this reserved DB instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.

" + } }, - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" + "com.amazonaws.rds#ReservedDBInstancesOfferingList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#ReservedDBInstancesOffering", + "traits": { + "smithy.api#xmlName": "ReservedDBInstancesOffering" + } + } }, - { - "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" + "com.amazonaws.rds#ReservedDBInstancesOfferingMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "ReservedDBInstancesOfferings": { + "target": "com.amazonaws.rds#ReservedDBInstancesOfferingList", + "traits": { + "smithy.api#documentation": "

A list of reserved DB instance offerings.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.

" + } }, - { - "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" + "com.amazonaws.rds#ReservedDBInstancesOfferingNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ReservedDBInstancesOfferingNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

Specified offering does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } }, - { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + "com.amazonaws.rds#ResetDBClusterParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ResetDBClusterParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBClusterParameterGroupNameMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the parameters of a DB cluster parameter group to the default value. To\n reset specific parameters submit a list of the following: ParameterName \n and ApplyMethod. To reset the\n entire DB cluster parameter group, specify the DBClusterParameterGroupName \n and ResetAllParameters parameters.

\n

When resetting the entire group, dynamic parameters are updated immediately and static parameters\n are set to pending-reboot to take effect on the next DB instance restart \n or RebootDBInstance request. You must call RebootDBInstance for every\n DB instance in your DB cluster that you want the updated static parameter to apply to.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + } }, - { - "target": "com.amazonaws.rds#DomainNotFoundFault" + "com.amazonaws.rds#ResetDBClusterParameterGroupMessage": { + "type": "structure", + "members": { + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group to reset.

", + "smithy.api#required": {} + } + }, + "ResetAllParameters": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether to reset all parameters in the DB cluster parameter group \n to their default values. You can't use this parameter if there \n is a list of parameter names specified for the Parameters parameter.

" + } + }, + "Parameters": { + "target": "com.amazonaws.rds#ParametersList", + "traits": { + "smithy.api#documentation": "

A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this\n parameter if the ResetAllParameters parameter is enabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } }, - { - "target": "com.amazonaws.rds#InsufficientStorageClusterCapacityFault" + "com.amazonaws.rds#ResetDBParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ResetDBParameterGroupMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBParameterGroupNameMessage" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBParameterGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the parameters of a DB parameter group to the engine/system default value.\n To reset specific parameters, provide a list of the following:\n ParameterName and ApplyMethod. To reset the entire DB\n parameter group, specify the DBParameterGroup name and\n ResetAllParameters parameters. When resetting the entire group, dynamic\n parameters are updated immediately and static parameters are set to\n pending-reboot to take effect on the next DB instance restart or\n RebootDBInstance request.

" + } }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + "com.amazonaws.rds#ResetDBParameterGroupMessage": { + "type": "structure", + "members": { + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "ResetAllParameters": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether to reset all parameters in the DB parameter group to default values. \n By default, all parameters in the DB parameter group are reset to default values.

" + } + }, + "Parameters": { + "target": "com.amazonaws.rds#ParametersList", + "traits": { + "smithy.api#documentation": "

To reset the entire DB parameter group, specify the DBParameterGroup\n name and ResetAllParameters parameters. To reset specific parameters,\n provide a list of the following: ParameterName and\n ApplyMethod. A maximum of 20 parameters can be modified in a single\n request.

\n

\n MySQL\n

\n

Valid Values (for Apply method): immediate | pending-reboot\n

\n

You can use the immediate value with dynamic parameters only. You can use \n the pending-reboot value for both dynamic and static parameters, and changes \n are applied when DB instance reboots.

\n

\n MariaDB\n

\n

Valid Values (for Apply method): immediate | pending-reboot\n

\n

You can use the immediate value with dynamic parameters only. You can use \n the pending-reboot value for both dynamic and static parameters, and changes \n are applied when DB instance reboots.

\n

\n Oracle\n

\n

Valid Values (for Apply method): pending-reboot\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } }, - { - "target": "com.amazonaws.rds#InvalidDBSubnetGroupStateFault" + "com.amazonaws.rds#ResourceNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified resource ID was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } }, - { - "target": "com.amazonaws.rds#InvalidS3BucketFault" + "com.amazonaws.rds#ResourcePendingMaintenanceActions": { + "type": "structure", + "members": { + "ResourceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN of the resource that has pending maintenance actions.

" + } + }, + "PendingMaintenanceActionDetails": { + "target": "com.amazonaws.rds#PendingMaintenanceActionDetails", + "traits": { + "smithy.api#documentation": "

A list that provides details about the pending maintenance actions for the resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the pending maintenance actions for a resource.

" + } }, - { - "target": "com.amazonaws.rds#InvalidSubnet" + "com.amazonaws.rds#RestoreDBClusterFromS3": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RestoreDBClusterFromS3Message" + }, + "output": { + "target": "com.amazonaws.rds#RestoreDBClusterFromS3Result" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DomainNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InsufficientStorageClusterCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSubnetGroupStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidS3BucketFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.\n Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be\n created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the\n Amazon Aurora User Guide.

\n \n

This action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromS3 action has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters. The source DB engine must be\n MySQL.

\n " + } }, - { - "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + "com.amazonaws.rds#RestoreDBClusterFromS3Message": { + "type": "structure", + "members": { + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZones", + "traits": { + "smithy.api#documentation": "

A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.

\n

Default: 1

\n

Constraints:

\n " + } + }, + "CharacterSetName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database name for the restored DB cluster.

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.

\n

Constraints:

\n \n

Example: my-cluster1\n

", + "smithy.api#required": {} + } + }, + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group to associate\n with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used.

\n

Constraints:

\n " + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with the restored DB cluster.

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A DB subnet group to associate with the restored DB cluster.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database engine to be used for this DB cluster.

\n

Valid Values: aurora (for MySQL 5.6-compatible Aurora) and aurora-mysql \n (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine to use.

\n

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.mysql_aurora.2.07.1,\n 8.0.mysql_aurora.3.02.0\n

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the instances in the restored DB cluster accept connections.

\n

Default: 3306\n

" + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the master user for the restored DB cluster.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints:

\n " + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value that indicates that the restored DB cluster should be associated with the specified option group.

\n

Permanent options can't be removed from an option group. An option group can't be removed from a \n DB cluster once it is associated with a DB cluster.

" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.

\n

Constraints:

\n " + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the restored DB cluster is encrypted.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If the StorageEncrypted parameter is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS will use your default KMS key. There is a \n default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

" + } + }, + "SourceEngine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the database engine that was backed up to create the files stored in the\n Amazon S3 bucket.

\n

Valid values: mysql\n

", + "smithy.api#required": {} + } + }, + "SourceEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the database that the backup files were created from.

\n

MySQL versions 5.5, 5.6, and 5.7 are supported.

\n

Example: 5.6.40, 5.7.28\n

", + "smithy.api#required": {} + } + }, + "S3BucketName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

", + "smithy.api#required": {} + } + }, + "S3Prefix": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster.\n If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is\n created by using all of the files in the Amazon S3 bucket.

" + } + }, + "S3IngestionRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes\n Amazon RDS to access the Amazon S3 bucket on your behalf.

", + "smithy.api#required": {} + } + }, + "BacktrackWindow": { + "target": "com.amazonaws.rds#LongOptional", + "traits": { + "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n \n

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

\n \n

Default: 0

\n

Constraints:

\n " + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.

\n

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

" + } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

" + } + }, + "ManageMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Constraints:

\n " + } + }, + "MasterUserSecretKmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" + } + } + } }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + "com.amazonaws.rds#RestoreDBClusterFromS3Result": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + } }, - { - "target": "com.amazonaws.rds#StorageQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.\n Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be\n created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the\n Amazon Aurora User Guide.

\n \n

This action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromS3 action has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters. The source DB engine must be\n MySQL.

\n " - } - }, - "com.amazonaws.rds#RestoreDBClusterFromS3Message": { - "type": "structure", - "members": { - "AvailabilityZones": { - "target": "com.amazonaws.rds#AvailabilityZones", - "traits": { - "smithy.api#documentation": "

A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.

\n

Default: 1

\n

Constraints:

\n " - } - }, - "CharacterSetName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

" - } - }, - "DatabaseName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database name for the restored DB cluster.

" - } - }, - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.

\n

Constraints:

\n \n

Example: my-cluster1\n

", - "smithy.api#required": {} - } - }, - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group to associate\n with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used.

\n

Constraints:

\n " - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with the restored DB cluster.

" - } - }, - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A DB subnet group to associate with the restored DB cluster.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the database engine to be used for this DB cluster.

\n

Valid Values: aurora (for MySQL 5.6-compatible Aurora) and aurora-mysql \n (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

", - "smithy.api#required": {} - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.

\n

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.mysql_aurora.2.07.1,\n 8.0.mysql_aurora.3.02.0\n

" - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port number on which the instances in the restored DB cluster accept connections.

\n

Default: 3306\n

" - } - }, - "MasterUsername": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the master user for the restored DB cluster.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "MasterUserPassword": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints:

\n " - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A value that indicates that the restored DB cluster should be associated with the specified option group.

\n

Permanent options can't be removed from an option group. An option group can't be removed from a \n DB cluster once it is associated with a DB cluster.

" - } - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The daily time range during which automated backups are created\n if automated backups are enabled\n using the BackupRetentionPeriod parameter.

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region. \n To view the time blocks available, see \n \n Backup window in the Amazon Aurora User Guide.

\n

Constraints:

\n " - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

The default is a 30-minute window selected at random from an\n 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

\n

Constraints: Minimum 30-minute window.

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - }, - "StorageEncrypted": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the restored DB cluster is encrypted.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If the StorageEncrypted parameter is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS will use your default KMS key. There is a \n default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.

" - } - }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

" - } - }, - "SourceEngine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the database engine that was backed up to create the files stored in the\n Amazon S3 bucket.

\n

Valid values: mysql\n

", - "smithy.api#required": {} - } - }, - "SourceEngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version of the database that the backup files were created from.

\n

MySQL versions 5.5, 5.6, and 5.7 are supported.

\n

Example: 5.6.40, 5.7.28\n

", - "smithy.api#required": {} - } - }, - "S3BucketName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

", - "smithy.api#required": {} - } - }, - "S3Prefix": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster.\n If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is\n created by using all of the files in the Amazon S3 bucket.

" - } - }, - "S3IngestionRoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes\n Amazon RDS to access the Amazon S3 bucket on your behalf.

", - "smithy.api#required": {} - } - }, - "BacktrackWindow": { - "target": "com.amazonaws.rds#LongOptional", - "traits": { - "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n \n

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

\n \n

Default: 0

\n

Constraints:

\n " - } - }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

" - } - }, - "Domain": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.

\n

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.

" - } - }, - "DomainIAMRoleName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

" - } - }, - "ServerlessV2ScalingConfiguration": { - "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

" - } - }, - "ManageMasterUserPassword": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager \n in the Amazon Aurora User Guide.\n

\n

Constraints:

\n " - } - }, - "MasterUserSecretKmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" - } - } - } - }, - "com.amazonaws.rds#RestoreDBClusterFromS3Result": { - "type": "structure", - "members": { - "DBCluster": { - "target": "com.amazonaws.rds#DBCluster" - } - } - }, - "com.amazonaws.rds#RestoreDBClusterFromSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#RestoreDBClusterFromSnapshotMessage" - }, - "output": { - "target": "com.amazonaws.rds#RestoreDBClusterFromSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" + "com.amazonaws.rds#RestoreDBClusterFromSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RestoreDBClusterFromSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#RestoreDBClusterFromSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DomainNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InsufficientDBClusterCapacityFault" + }, + { + "target": "com.amazonaws.rds#InsufficientStorageClusterCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidRestoreFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

\n

The target DB cluster is created from the source snapshot with a default\n configuration. If you don't specify a security group, the new DB cluster is\n associated with the default security group.

\n \n

This action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromSnapshot action has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + } }, - { - "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" + "com.amazonaws.rds#RestoreDBClusterFromSnapshotMessage": { + "type": "structure", + "members": { + "AvailabilityZones": { + "target": "com.amazonaws.rds#AvailabilityZones", + "traits": { + "smithy.api#documentation": "

Provides the list of Availability Zones (AZs) where instances in the restored DB\n cluster can be created.

\n

Valid for: Aurora DB clusters only

" + } + }, + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.\n This parameter isn't case-sensitive.

\n

Constraints:

\n \n

Example: my-snapshot-id\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", + "smithy.api#required": {} + } + }, + "SnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the DB snapshot or DB cluster snapshot to restore from.

\n

You can use either the name or the Amazon Resource Name (ARN) to specify a DB\n cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", + "smithy.api#required": {} + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine to use for the new DB cluster.

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the database engine to use for the new DB cluster.

\n

To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

See MySQL on Amazon RDS Versions in the \n Amazon Aurora User Guide.

\n

\n Aurora PostgreSQL\n

\n

See Amazon Aurora PostgreSQL releases and engine versions in the \n Amazon Aurora User Guide.

\n

\n MySQL\n

\n

See MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n

\n

\n PostgreSQL\n

\n

See Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the new DB cluster accepts connections.

\n

Constraints: This value must be 1150-65535\n

\n

Default: The same port as the original DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB subnet group to use for the new DB cluster.

\n

Constraints: If supplied, must match the name of an existing DB subnet group.

\n

Example: mydbsubnetgroup\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database name for the restored DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group to use for the restored DB cluster.

\n

DB clusters are associated with a default option group that can't be modified.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of VPC security groups that the new DB cluster will belong to.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

The tags to be assigned to the restored DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB\n snapshot or DB cluster snapshot.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

When you don't specify a value for the KmsKeyId parameter, then the\n following occurs:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + } + }, + "BacktrackWindow": { + "target": "com.amazonaws.rds#LongOptional", + "traits": { + "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n \n

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

\n \n

Default: 0

\n

Constraints:

\n \n

Valid for: Aurora DB clusters only

" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.\n The values in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "EngineMode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB engine mode of the DB cluster, either provisioned, serverless,\n parallelquery, global, or multimaster.

\n

For more information, see \n CreateDBCluster.

\n

Valid for: Aurora DB clusters only

" + } + }, + "ScalingConfiguration": { + "target": "com.amazonaws.rds#ScalingConfiguration", + "traits": { + "smithy.api#documentation": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

\n

Valid for: Aurora DB clusters only

" + } + }, + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group to associate with this DB cluster. If this\n argument is omitted, the default DB cluster parameter group for the specified engine is\n used.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

Valid for: Aurora DB clusters only

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

Valid for: Aurora DB clusters only

" + } + }, + "DBClusterInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes, and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.

\n

Valid values: io1\n

\n

When specified, a value for the Iops parameter is required.

\n

Default: io1\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for \n each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, \n see Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } }, - { - "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" + "com.amazonaws.rds#RestoreDBClusterFromSnapshotResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + } }, - { - "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + "com.amazonaws.rds#RestoreDBClusterToPointInTime": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RestoreDBClusterToPointInTimeMessage" + }, + "output": { + "target": "com.amazonaws.rds#RestoreDBClusterToPointInTimeResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DomainNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InsufficientDBClusterCapacityFault" + }, + { + "target": "com.amazonaws.rds#InsufficientStorageClusterCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidRestoreFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Restores a DB cluster to an arbitrary point in time. Users can restore to any point\n in time before LatestRestorableTime for up to\n BackupRetentionPeriod days. The target DB cluster is created from the\n source DB cluster with the same configuration as the original DB cluster, except that\n the new DB cluster is created with the default DB security group.

\n \n

For Aurora, this action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterToPointInTime action has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + } }, - { - "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + "com.amazonaws.rds#RestoreDBClusterToPointInTimeMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the new DB cluster to be created.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", + "smithy.api#required": {} + } + }, + "RestoreType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The type of restore to be performed. You can specify one of the following values:

\n \n

Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

\n

If you don't specify a RestoreType value, then the new DB cluster is\n restored as a full copy of the source DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "SourceDBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the source DB cluster from which to restore.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", + "smithy.api#required": {} + } + }, + "RestoreToTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time to restore the DB cluster to.

\n

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

\n

Constraints:

\n \n

Example: 2015-03-07T23:45:00Z\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "UseLatestRestorableTime": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether to restore the DB cluster to the latest \n restorable backup time. By default, the DB cluster isn't restored to the latest \n restorable backup time.

\n

Constraints: Can't be specified if RestoreToTime parameter is provided.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the new DB cluster accepts connections.

\n

Constraints: A value from 1150-65535.

\n

Default: The default port for the engine.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB subnet group name to use for the new DB cluster.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group for the new DB cluster.

\n

DB clusters are associated with a default option group that can't be modified.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of VPC security groups that the new DB cluster belongs to.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the\n KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key\n identified by the KmsKeyId parameter.

\n

If you don't specify a value for the KmsKeyId parameter, then the following occurs:

\n \n

If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request\n is rejected.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + } + }, + "BacktrackWindow": { + "target": "com.amazonaws.rds#LongOptional", + "traits": { + "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n

Default: 0

\n

Constraints:

\n \n

Valid for: Aurora MySQL DB clusters only

" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "DBClusterParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB cluster parameter group to associate with this DB cluster. \n If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.

\n

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

Valid for: Aurora DB clusters only

" + } + }, + "ScalingConfiguration": { + "target": "com.amazonaws.rds#ScalingConfiguration", + "traits": { + "smithy.api#documentation": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

\n

Valid for: Aurora DB clusters only

" + } + }, + "EngineMode": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The engine mode of the new cluster. Specify provisioned or serverless,\n depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone\n from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone\n that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or\n an encrypted provisioned cluster.

\n

Valid for: Aurora DB clusters only

" + } + }, + "DBClusterInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster,\n for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines.

\n

For the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.\n

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.

\n

Valid values: io1\n

\n

When specified, a value for the Iops parameter is required.

\n

Default: io1\n

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves\n to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

Valid for: Multi-AZ DB clusters only

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for \n each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, \n see Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

\n

Valid for: Multi-AZ DB clusters only

" + } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } }, - { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + "com.amazonaws.rds#RestoreDBClusterToPointInTimeResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + } }, - { - "target": "com.amazonaws.rds#DomainNotFoundFault" + "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotMessage" + }, + "output": { + "target": "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#AuthorizationNotFoundFault" + }, + { + "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DomainNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InstanceQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidRestoreFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most\n of the source's original configuration, including the default security group and DB parameter group. By default, the new DB\n instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group\n associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.

\n

If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance\n before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you\n have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as\n the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original\n DB instance with the DB instance created from the snapshot.

\n

If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\n must be the ARN of the shared DB snapshot.

\n \n

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.

\n " + } }, - { - "target": "com.amazonaws.rds#InsufficientDBClusterCapacityFault" + "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.

\n

Constraints:

\n \n

Example: my-snapshot-id\n

", + "smithy.api#required": {} + } + }, + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the DB snapshot to restore from.

\n

Constraints:

\n " + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

\n

Default: The same DBInstanceClass as the original DB instance.

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

Default: The same port as the original DB instance

\n

Constraints: Value must be 1150-65535\n

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone (AZ) where the DB instance will be created.

\n

Default: A random, system-chosen Availability Zone.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

\n

Example: us-east-1a\n

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB subnet group name to use for the new instance.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to RDS Custom.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled \n by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether minor version upgrades are applied automatically to the DB instance \n during the maintenance window.

\n

If you restore an RDS Custom DB instance, you must disable this parameter.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

License model information for the restored DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: Same as source.

\n

Valid values: license-included | bring-your-own-license | general-public-license\n

" + } + }, + "DBName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database name for the restored DB instance.

\n

This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. It also doesn't apply to RDS\n Custom DB instances.

" + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine to use for the new instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

\n

Valid Values:

\n " + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. \n If this parameter isn't specified, the IOPS value is taken from the backup. \n If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. \n The conversion takes additional time, though your DB instance is available for connections before the conversion starts.

\n

The provisioned IOPS value must follow the requirements for your database engine.\n For more information, see \n Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.\n

\n

Constraints: Must be an integer greater than 1000.

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group to be used for the restored DB instance.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option \n group, and that option group can't be removed from a DB instance after it is associated with a DB instance.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" + } + }, + "TdeCredentialArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "TdeCredentialPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB instance.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB instance in.\n The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.

\n

In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you \n specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from\n the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.

\n

For more information, see \n Copying tags to DB instance snapshots in the Amazon RDS User Guide.

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "UseDefaultProcessorFeatures": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance.

\n

If you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup \n for the specified DB engine.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n " + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" + } + }, + "EnableCustomerOwnedIp": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

This setting doesn't apply to RDS Custom.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + } + }, + "CustomIamInstanceProfile": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n \n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" + } + }, + "BackupTarget": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies where automated backups and manual snapshots are stored for the restored DB instance.

\n

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" + } + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + } + }, + "DBClusterSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

\n

Constraints:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } }, - { - "target": "com.amazonaws.rds#InsufficientStorageClusterCapacityFault" + "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + } }, - { - "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" + "com.amazonaws.rds#RestoreDBInstanceFromS3": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RestoreDBInstanceFromS3Message" + }, + "output": { + "target": "com.amazonaws.rds#RestoreDBInstanceFromS3Result" + }, + "errors": [ + { + "target": "com.amazonaws.rds#AuthorizationNotFoundFault" + }, + { + "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InstanceQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidS3BucketFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" + } + ], + "traits": { + "smithy.api#documentation": "

Amazon Relational Database Service (Amazon RDS) \n supports importing MySQL databases by using backup files. \n You can create a backup of your on-premises database, \n store it on Amazon Simple Storage Service (Amazon S3), \n and then restore the backup file onto a new Amazon RDS DB instance running MySQL.\n For more information, see Importing Data into an Amazon RDS MySQL DB Instance \n in the Amazon RDS User Guide.\n

\n

This command doesn't apply to RDS Custom.

" + } }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + "com.amazonaws.rds#RestoreDBInstanceFromS3Message": { + "type": "structure", + "members": { + "DBName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database to create when the DB instance is created.\n Follow the naming rules specified in CreateDBInstance.

" + } + }, + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mydbinstance\n

", + "smithy.api#required": {} + } + }, + "AllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of storage (in gigabytes) to allocate initially for the DB instance.\n Follow the allocation rules specified in CreateDBInstance.

\n \n

Be sure to allocate enough memory for your new DB instance\n so that the restore operation can succeed.\n You can also allocate additional memory for future growth.

\n " + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of the DB instance, \n for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, \n or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.\n

\n

Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.

", + "smithy.api#required": {} + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database engine to be used for this instance.

\n

Valid Values: \n mysql\n

", + "smithy.api#required": {} + } + }, + "MasterUsername": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name for the master user.

\n

Constraints:

\n " + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The password for the master user. \n The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints: Can't be specified if ManageMasterUserPassword is turned on.

\n

\n MariaDB\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Microsoft SQL Server\n

\n

Constraints: Must contain from 8 to 128 characters.

\n

\n MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Oracle\n

\n

Constraints: Must contain from 8 to 30 characters.

\n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

" + } + }, + "DBSecurityGroups": { + "target": "com.amazonaws.rds#DBSecurityGroupNameList", + "traits": { + "smithy.api#documentation": "

A list of DB security groups to associate with this DB instance.

\n

Default: The default DB security group for the database engine.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of VPC security groups to associate with this DB instance.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone that the DB instance is created in. \n For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.\n

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

Example: us-east-1d\n

\n

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A DB subnet group to associate with this DB instance.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" + } + }, + "PreferredMaintenanceWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The time range each week during which system maintenance can occur, \n in Universal Coordinated Time (UTC). \n For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.\n

\n

Constraints:

\n " + } + }, + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance.

\n

If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.

" + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which automated backups are retained. \n Setting this parameter to a positive number enables backups.\n For more information, see CreateDBInstance.

" + } + }, + "PreferredBackupWindow": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The time range each day \n during which automated backups are created \n if automated backups are enabled. \n For more information, see Backup window in the Amazon RDS User Guide.\n

\n

Constraints:

\n " + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

Type: Integer

\n

Valid Values: 1150-65535\n

\n

Default: 3306\n

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment. \n If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine to use.\n Choose the latest minor version of your database engine. \n For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically \n to the DB instance during the maintenance window. By default, minor engine upgrades \n are not applied automatically.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The license model for this DB instance.\n Use general-public-license.

" + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) \n to allocate initially for the DB instance.\n For information about valid IOPS values, \n see Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.\n

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group to associate with this DB instance. \n If this argument is omitted, the default option group for the specified engine is used.

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to associate with this DB instance.\n For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.\n

" + } + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, \n you must also include a value for the Iops parameter.

\n

Default: io1 \n if the Iops parameter is specified; \n otherwise gp2\n

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the new DB instance is encrypted or not.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If the StorageEncrypted parameter is enabled, \n and you do not specify a value for the KmsKeyId parameter, \n then Amazon RDS will use your default KMS key. \n There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

" + } + }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, \n between points when Enhanced Monitoring metrics are collected for the DB instance. \n To disable collecting Enhanced Monitoring metrics, specify 0.

\n

If MonitoringRoleArn is specified, \n then you must also set MonitoringInterval to a value other than 0.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60

\n

Default: 0\n

" + } + }, + "MonitoringRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM role that permits RDS \n to send enhanced monitoring metrics to Amazon CloudWatch Logs. \n For example, arn:aws:iam:123456789012:role/emaccess. \n For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.\n

\n

If MonitoringInterval is set to a value other than 0, \n then you must supply a MonitoringRoleArn value.

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" + } + }, + "SourceEngine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the engine of your source database.

\n

Valid Values: \n mysql\n

", + "smithy.api#required": {} + } + }, + "SourceEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the database that the backup files were created from.

\n

MySQL versions 5.6 and 5.7 are supported.

\n

Example: 5.6.40\n

", + "smithy.api#required": {} + } + }, + "S3BucketName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of your Amazon S3 bucket \n that contains your database backup file.

", + "smithy.api#required": {} + } + }, + "S3Prefix": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The prefix of your Amazon S3 bucket.

" + } + }, + "S3IngestionRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.

", + "smithy.api#required": {} + } + }, + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the DB instance.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

" + } + }, + "PerformanceInsightsKMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

" + } + }, + "UseDefaultProcessorFeatures": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" + } + }, + "MaxAllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

" + } + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + } + }, + "ManageMasterUserPassword": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

\n " + } + }, + "MasterUserSecretKmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" + } + } + } }, - { - "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" + "com.amazonaws.rds#RestoreDBInstanceFromS3Result": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + } }, - { - "target": "com.amazonaws.rds#InvalidRestoreFault" + "com.amazonaws.rds#RestoreDBInstanceToPointInTime": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RestoreDBInstanceToPointInTimeMessage" + }, + "output": { + "target": "com.amazonaws.rds#RestoreDBInstanceToPointInTimeResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#AuthorizationNotFoundFault" + }, + { + "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DomainNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InstanceQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidRestoreFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, + { + "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#PointInTimeRestoreNotEnabledFault" + }, + { + "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" + }, + { + "target": "com.amazonaws.rds#StorageQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" + } + ], + "traits": { + "smithy.api#documentation": "

Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

\n

The target database is created with most of the original configuration, but in a\n system-selected Availability Zone, with the default security group, the default subnet\n group, and the default DB parameter group. By default, the new DB instance is created as\n a single-AZ deployment except when the instance is a SQL Server instance that has an\n option group that is associated with mirroring; in this case, the instance becomes a\n mirrored deployment and not a single-AZ deployment.

\n \n

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.

\n " + } }, - { - "target": "com.amazonaws.rds#InvalidSubnet" + "com.amazonaws.rds#RestoreDBInstanceToPointInTimeMessage": { + "type": "structure", + "members": { + "SourceDBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the source DB instance from which to restore.

\n

Constraints:

\n " + } + }, + "TargetDBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the new DB instance to be created.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "RestoreTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time to restore from.

\n

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

\n

Constraints:

\n \n

Example: 2009-09-07T23:45:00Z\n

" + } + }, + "UseLatestRestorableTime": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance \n isn't restored from the latest backup time.

\n

Constraints: Can't be specified if the RestoreTime parameter is provided.

" + } + }, + "DBInstanceClass": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of the Amazon RDS DB instance, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.

\n

Default: The same DBInstanceClass as the original DB instance.

" + } + }, + "Port": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

Constraints: Value must be 1150-65535\n

\n

Default: The same port as the original DB instance.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone (AZ) where the DB instance will be created.

\n

Default: A random, system-chosen Availability Zone.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

\n

Example: us-east-1a\n

" + } + }, + "DBSubnetGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB subnet group name to use for the new instance.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" + } + }, + "MultiAZ": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to RDS Custom.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a \n Multi-AZ deployment.

" + } + }, + "PubliclyAccessible": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" + } + }, + "AutoMinorVersionUpgrade": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether minor version upgrades are applied automatically to the \n DB instance during the maintenance window.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "LicenseModel": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

License model information for the restored DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: Same as source.

\n

Valid values: license-included | bring-your-own-license | general-public-license\n

" + } + }, + "DBName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database name for the restored DB instance.

\n \n

This parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.

\n " + } + }, + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The database engine to use for the new instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source

\n

Valid Values:

\n " + } + }, + "Iops": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

\n

Constraints: Must be an integer greater than 1000.

\n

\n SQL Server\n

\n

Setting the IOPS value for the SQL Server database engine isn't supported.

" + } + }, + "OptionGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the option group to be used for the restored DB instance.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an \n option group, and that option group can't be removed from a DB instance after it is associated with a DB instance

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "CopyTagsToSnapshot": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.

" + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + }, + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" + } + }, + "TdeCredentialArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "TdeCredentialPassword": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "VpcSecurityGroupIds": { + "target": "com.amazonaws.rds#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB instance.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" + } + }, + "Domain": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB instance in.\n Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

This setting doesn't apply to RDS Custom.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

" + } + }, + "DomainIAMRoleName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "EnableIAMDatabaseAuthentication": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

This setting doesn't apply to RDS Custom.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" + } + }, + "EnableCloudwatchLogsExports": { + "target": "com.amazonaws.rds#LogTypeList", + "traits": { + "smithy.api#documentation": "

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "ProcessorFeatures": { + "target": "com.amazonaws.rds#ProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "UseDefaultProcessorFeatures": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "DBParameterGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance.

\n

If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n " + } + }, + "DeletionProtection": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" + } + }, + "SourceDbiResourceId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The resource ID of the source DB instance from which to restore.

" + } + }, + "MaxAllocatedStorage": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "SourceDBInstanceAutomatedBackupsArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, \n arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

\n

This setting doesn't apply to RDS Custom.

" + } + }, + "EnableCustomerOwnedIp": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

This setting doesn't apply to RDS Custom.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" + } + }, + "CustomIamInstanceProfile": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n \n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" + } + }, + "BackupTarget": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

Specifies where automated backups and manual snapshots are stored for the restored DB instance.

\n

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" + } + }, + "NetworkType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + } + }, + "StorageThroughput": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } }, - { - "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + "com.amazonaws.rds#RestoreDBInstanceToPointInTimeResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + } }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + "com.amazonaws.rds#RestoreWindow": { + "type": "structure", + "members": { + "EarliestTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The earliest time you can restore an instance to.

" + } + }, + "LatestTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The latest time you can restore an instance to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Earliest and latest time an instance can be restored to:

" + } }, - { - "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + "com.amazonaws.rds#RevokeDBSecurityGroupIngress": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#RevokeDBSecurityGroupIngressMessage" + }, + "output": { + "target": "com.amazonaws.rds#RevokeDBSecurityGroupIngressResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#AuthorizationNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required \n parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either \n EC2SecurityGroupName or EC2SecurityGroupId).

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring ā€“ \n Hereā€™s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n " + } }, - { - "target": "com.amazonaws.rds#StorageQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

\n

The target DB cluster is created from the source snapshot with a default\n configuration. If you don't specify a security group, the new DB cluster is\n associated with the default security group.

\n \n

This action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterFromSnapshot action has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" - } - }, - "com.amazonaws.rds#RestoreDBClusterFromSnapshotMessage": { - "type": "structure", - "members": { - "AvailabilityZones": { - "target": "com.amazonaws.rds#AvailabilityZones", - "traits": { - "smithy.api#documentation": "

Provides the list of Availability Zones (AZs) where instances in the restored DB\n cluster can be created.

\n

Valid for: Aurora DB clusters only

" - } - }, - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.\n This parameter isn't case-sensitive.

\n

Constraints:

\n \n

Example: my-snapshot-id\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", - "smithy.api#required": {} - } - }, - "SnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the DB snapshot or DB cluster snapshot to restore from.

\n

You can use either the name or the Amazon Resource Name (ARN) to specify a DB\n cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", - "smithy.api#required": {} - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database engine to use for the new DB cluster.

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", - "smithy.api#required": {} - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version of the database engine to use for the new DB cluster.

\n

To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for MySQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n

\n

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

\n

\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n

\n

\n Aurora MySQL\n

\n

See MySQL on Amazon RDS Versions in the \n Amazon Aurora User Guide.

\n

\n Aurora PostgreSQL\n

\n

See Amazon Aurora PostgreSQL releases and engine versions in the \n Amazon Aurora User Guide.

\n

\n MySQL\n

\n

See MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n

\n

\n PostgreSQL\n

\n

See Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port number on which the new DB cluster accepts connections.

\n

Constraints: This value must be 1150-65535\n

\n

Default: The same port as the original DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB subnet group to use for the new DB cluster.

\n

Constraints: If supplied, must match the name of an existing DB subnet group.

\n

Example: mydbsubnetgroup\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "DatabaseName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database name for the restored DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the option group to use for the restored DB cluster.

\n

DB clusters are associated with a default option group that can't be modified.

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of VPC security groups that the new DB cluster will belong to.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

The tags to be assigned to the restored DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB\n snapshot or DB cluster snapshot.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

When you don't specify a value for the KmsKeyId parameter, then the\n following occurs:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" - } - }, - "BacktrackWindow": { - "target": "com.amazonaws.rds#LongOptional", - "traits": { - "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n \n

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

\n \n

Default: 0

\n

Constraints:

\n \n

Valid for: Aurora DB clusters only

" - } - }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.\n The values in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "EngineMode": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB engine mode of the DB cluster, either provisioned, serverless,\n parallelquery, global, or multimaster.

\n

For more information, see \n CreateDBCluster.

\n

Valid for: Aurora DB clusters only

" - } - }, - "ScalingConfiguration": { - "target": "com.amazonaws.rds#ScalingConfiguration", - "traits": { - "smithy.api#documentation": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

\n

Valid for: Aurora DB clusters only

" - } - }, - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group to associate with this DB cluster. If this\n argument is omitted, the default DB cluster parameter group for the specified engine is\n used.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "Domain": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

Valid for: Aurora DB clusters only

" - } - }, - "DomainIAMRoleName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

Valid for: Aurora DB clusters only

" - } - }, - "DBClusterInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

\n

For the full list of DB instance classes, and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.

\n

Valid values: io1\n

\n

When specified, a value for the Iops parameter is required.

\n

Default: io1\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for \n each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, \n see Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "ServerlessV2ScalingConfiguration": { - "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#RestoreDBClusterFromSnapshotResult": { - "type": "structure", - "members": { - "DBCluster": { - "target": "com.amazonaws.rds#DBCluster" - } - } - }, - "com.amazonaws.rds#RestoreDBClusterToPointInTime": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#RestoreDBClusterToPointInTimeMessage" - }, - "output": { - "target": "com.amazonaws.rds#RestoreDBClusterToPointInTimeResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterAlreadyExistsFault" + "com.amazonaws.rds#RevokeDBSecurityGroupIngressMessage": { + "type": "structure", + "members": { + "DBSecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the DB security group to revoke ingress from.

", + "smithy.api#required": {} + } + }, + "CIDRIP": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The IP range to revoke access from. \n Must be a valid CIDR range. If CIDRIP is specified, \n EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId\n can't be provided.

" + } + }, + "EC2SecurityGroupName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the EC2 security group to revoke access from.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + } + }, + "EC2SecurityGroupId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The id of the EC2 security group to revoke access from.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + } + }, + "EC2SecurityGroupOwnerId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account number of the owner of the EC2 security group\n specified in the EC2SecurityGroupName parameter.\n The Amazon Web Services access key ID isn't an acceptable value.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } }, - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" + "com.amazonaws.rds#RevokeDBSecurityGroupIngressResult": { + "type": "structure", + "members": { + "DBSecurityGroup": { + "target": "com.amazonaws.rds#DBSecurityGroup" + } + } }, - { - "target": "com.amazonaws.rds#DBClusterParameterGroupNotFoundFault" + "com.amazonaws.rds#SNSInvalidTopicFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SNSInvalidTopic", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

SNS has responded that there is a problem with the SNS topic specified.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.rds#DBClusterQuotaExceededFault" + "com.amazonaws.rds#SNSNoAuthorizationFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SNSNoAuthorization", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You do not have permission to publish to the SNS topic ARN.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + "com.amazonaws.rds#SNSTopicArnNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SNSTopicArnNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The SNS topic ARN does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } }, - { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + "com.amazonaws.rds#ScalingConfiguration": { + "type": "structure", + "members": { + "MinCapacity": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

\n

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

\n

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

\n

The minimum capacity must be less than or equal to the maximum capacity.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

\n

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

\n

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

\n

The maximum capacity must be greater than or equal to the minimum capacity.

" + } + }, + "AutoPause": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode.\n A DB cluster can be paused only when it's idle (it has no connections).

\n \n

If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot.\n In this case, the DB cluster is restored when there is a request to connect to it.

\n " + } + }, + "SecondsUntilAutoPause": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

\n

Specify a value between 300 and 86,400 seconds.

" + } + }, + "TimeoutAction": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

\n

\n ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.

\n

\n RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.

\n \n

If you specify ForceApplyCapacityChange, connections that\n prevent Aurora Serverless v1 from finding a scaling point might be dropped.

\n \n

For more information, see \n Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

" + } + }, + "SecondsBeforeTimeout": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point\n to perform seamless scaling before enforcing the timeout action. The default is 300.

\n

Specify a value between 60 and 600 seconds.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the scaling configuration of an Aurora Serverless v1 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v1 in the\n Amazon Aurora User Guide.

" + } }, - { - "target": "com.amazonaws.rds#DomainNotFoundFault" + "com.amazonaws.rds#ScalingConfigurationInfo": { + "type": "structure", + "members": { + "MinCapacity": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

" + } + }, + "AutoPause": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether automatic pause is allowed for the Aurora DB cluster\n in serverless DB engine mode.

\n

When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.

" + } + }, + "SecondsUntilAutoPause": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The remaining amount of time, in seconds, before the Aurora DB cluster in\n serverless mode is paused. A DB cluster can be paused only when\n it's idle (it has no connections).

" + } + }, + "TimeoutAction": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The action that occurs when Aurora times out while attempting to change the capacity of an\n Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or\n RollbackCapacityChange.

\n

\n ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

\n

\n RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.

" + } + }, + "SecondsBeforeTimeout": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of seconds before scaling times out. What happens when an attempted scaling action times out\n is determined by the TimeoutAction setting.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

\n

For more information, see Using Amazon Aurora Serverless v1 in the\n Amazon Aurora User Guide.

" + } }, - { - "target": "com.amazonaws.rds#InsufficientDBClusterCapacityFault" + "com.amazonaws.rds#ServerlessV2ScalingConfiguration": { + "type": "structure", + "members": { + "MinCapacity": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value\n that you can use is 0.5.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value\n that you can use is 128.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v2 in the\n Amazon Aurora User Guide.

" + } }, - { - "target": "com.amazonaws.rds#InsufficientStorageClusterCapacityFault" + "com.amazonaws.rds#ServerlessV2ScalingConfigurationInfo": { + "type": "structure", + "members": { + "MinCapacity": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value\n that you can use is 0.5.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value\n that you can use is 128.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Shows the scaling configuration for an Aurora Serverless v2 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v2 in the\n Amazon Aurora User Guide.

" + } }, - { - "target": "com.amazonaws.rds#InvalidDBClusterSnapshotStateFault" + "com.amazonaws.rds#SharedSnapshotQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SharedSnapshotQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + "com.amazonaws.rds#SnapshotQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB\n snapshots.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" + "com.amazonaws.rds#SourceClusterNotSupportedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SourceClusterNotSupportedFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The source DB cluster isn't supported for a blue/green deployment.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.rds#InvalidRestoreFault" + "com.amazonaws.rds#SourceDatabaseNotSupportedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SourceDatabaseNotSupportedFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The source DB instance isn't supported for a blue/green deployment.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.rds#InvalidSubnet" + "com.amazonaws.rds#SourceIdsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "SourceId" + } + } }, - { - "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + "com.amazonaws.rds#SourceNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SourceNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The requested source could not be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + "com.amazonaws.rds#SourceRegion": { + "type": "structure", + "members": { + "RegionName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the source Amazon Web Services Region.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The endpoint for the source Amazon Web Services Region endpoint.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the source Amazon Web Services Region.

" + } + }, + "SupportsDBInstanceAutomatedBackupsReplication": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains an Amazon Web Services Region name as the result of a successful call to the DescribeSourceRegions action.

" + } }, - { - "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + "com.amazonaws.rds#SourceRegionList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#SourceRegion", + "traits": { + "smithy.api#xmlName": "SourceRegion" + } + } }, - { - "target": "com.amazonaws.rds#StorageQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Restores a DB cluster to an arbitrary point in time. Users can restore to any point\n in time before LatestRestorableTime for up to\n BackupRetentionPeriod days. The target DB cluster is created from the\n source DB cluster with the same configuration as the original DB cluster, except that\n the new DB cluster is created with the default DB security group.

\n \n

For Aurora, this action only restores the DB cluster, not the DB instances for that DB\n cluster. You must invoke the CreateDBInstance action to create DB\n instances for the restored DB cluster, specifying the identifier of the restored DB\n cluster in DBClusterIdentifier. You can create DB instances only after\n the RestoreDBClusterToPointInTime action has completed and the DB\n cluster is available.

\n \n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" - } - }, - "com.amazonaws.rds#RestoreDBClusterToPointInTimeMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the new DB cluster to be created.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", - "smithy.api#required": {} - } - }, - "RestoreType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The type of restore to be performed. You can specify one of the following values:

\n \n

Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

\n

If you don't specify a RestoreType value, then the new DB cluster is\n restored as a full copy of the source DB cluster.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "SourceDBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the source DB cluster from which to restore.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

", - "smithy.api#required": {} - } - }, - "RestoreToTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The date and time to restore the DB cluster to.

\n

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

\n

Constraints:

\n \n

Example: 2015-03-07T23:45:00Z\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "UseLatestRestorableTime": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether to restore the DB cluster to the latest \n restorable backup time. By default, the DB cluster isn't restored to the latest \n restorable backup time.

\n

Constraints: Can't be specified if RestoreToTime parameter is provided.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port number on which the new DB cluster accepts connections.

\n

Constraints: A value from 1150-65535.

\n

Default: The default port for the engine.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB subnet group name to use for the new DB cluster.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the option group for the new DB cluster.

\n

DB clusters are associated with a default option group that can't be modified.

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of VPC security groups that the new DB cluster belongs to.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the\n KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key\n identified by the KmsKeyId parameter.

\n

If you don't specify a value for the KmsKeyId parameter, then the following occurs:

\n \n

If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request\n is rejected.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" - } - }, - "BacktrackWindow": { - "target": "com.amazonaws.rds#LongOptional", - "traits": { - "smithy.api#documentation": "

The target backtrack window, in seconds. To disable backtracking, set this value to\n 0.

\n

Default: 0

\n

Constraints:

\n \n

Valid for: Aurora MySQL DB clusters only

" - } - }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used.

\n

\n RDS for MySQL\n

\n

Possible values are error, general, and slowquery.

\n

\n RDS for PostgreSQL\n

\n

Possible values are postgresql and upgrade.

\n

\n Aurora MySQL\n

\n

Possible values are audit, error, general, and slowquery.

\n

\n Aurora PostgreSQL\n

\n

Possible value is postgresql.

\n

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "DBClusterParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB cluster parameter group to associate with this DB cluster. \n If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

\n

Constraints:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" - } - }, - "Domain": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB cluster in.\n The domain must be created prior to this operation.

\n

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster.\n For more information, see Kerberos Authentication\n in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" - } - }, - "DomainIAMRoleName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

Valid for: Aurora DB clusters only

" - } - }, - "ScalingConfiguration": { - "target": "com.amazonaws.rds#ScalingConfiguration", - "traits": { - "smithy.api#documentation": "

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

\n

Valid for: Aurora DB clusters only

" - } - }, - "EngineMode": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The engine mode of the new cluster. Specify provisioned or serverless,\n depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone\n from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone\n that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or\n an encrypted provisioned cluster.

\n

Valid for: Aurora DB clusters only

" - } - }, - "DBClusterInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster,\n for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines.

\n

For the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.\n

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.

\n

Valid values: io1\n

\n

When specified, a value for the Iops parameter is required.

\n

Default: io1\n

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves\n to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

Valid for: Multi-AZ DB clusters only

" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for \n each DB instance in the Multi-AZ DB cluster.

\n

For information about valid IOPS values, \n see Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

\n

Valid for: Multi-AZ DB clusters only

" - } - }, - "ServerlessV2ScalingConfiguration": { - "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB cluster.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for: Aurora DB clusters only

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#RestoreDBClusterToPointInTimeResult": { - "type": "structure", - "members": { - "DBCluster": { - "target": "com.amazonaws.rds#DBCluster" - } - } - }, - "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshot": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotMessage" - }, - "output": { - "target": "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#AuthorizationNotFoundFault" + "com.amazonaws.rds#SourceRegionMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" + } + }, + "SourceRegions": { + "target": "com.amazonaws.rds#SourceRegionList", + "traits": { + "smithy.api#documentation": "

A list of SourceRegion instances that contains each source Amazon Web Services Region that the\n current Amazon Web Services Region can get a read replica or a DB snapshot from.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeSourceRegions action.

" + } }, - { - "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" + "com.amazonaws.rds#SourceType": { + "type": "enum", + "members": { + "db_instance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-instance" + } + }, + "db_parameter_group": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-parameter-group" + } + }, + "db_security_group": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-security-group" + } + }, + "db_snapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-snapshot" + } + }, + "db_cluster": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-cluster" + } + }, + "db_cluster_snapshot": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-cluster-snapshot" + } + }, + "custom_engine_version": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "custom-engine-version" + } + }, + "db_proxy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db-proxy" + } + }, + "blue_green_deployment": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "blue-green-deployment" + } + } + } }, - { - "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + "com.amazonaws.rds#StartActivityStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StartActivityStreamRequest" + }, + "output": { + "target": "com.amazonaws.rds#StartActivityStreamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a database activity stream to monitor activity on the database.\n For more information, see Database Activity Streams\n in the Amazon Aurora User Guide.

" + } }, - { - "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" + "com.amazonaws.rds#StartActivityStreamRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the DB cluster,\n for example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.

", + "smithy.api#required": {} + } + }, + "Mode": { + "target": "com.amazonaws.rds#ActivityStreamMode", + "traits": { + "smithy.api#documentation": "

Specifies the mode of the database activity stream.\n Database events such as a change or access generate an activity stream event.\n The database session can handle these events either synchronously or asynchronously.

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream.\n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

", + "smithy.api#required": {} + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether or not the database activity stream is to start as soon as possible, \n regardless of the maintenance window for the database.

" + } + }, + "EngineNativeAuditFieldsIncluded": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether the database activity stream includes engine-native audit fields. This option only applies\n to an Oracle DB instance. By default, no engine-native audit fields are included.

" + } + } + } }, - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + "com.amazonaws.rds#StartActivityStreamResponse": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.

" + } + }, + "KinesisStreamName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Kinesis data stream to be used for the database activity stream.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#ActivityStreamStatus", + "traits": { + "smithy.api#documentation": "

The status of the database activity stream.

" + } + }, + "Mode": { + "target": "com.amazonaws.rds#ActivityStreamMode", + "traits": { + "smithy.api#documentation": "

The mode of the database activity stream.

" + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether or not the database activity stream will start as soon as possible, \n regardless of the maintenance window for the database.

" + } + }, + "EngineNativeAuditFieldsIncluded": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether engine-native audit fields are included in the database activity stream.

" + } + } + } }, - { - "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + "com.amazonaws.rds#StartDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StartDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#StartDBClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster\n CLI command, or the StopDBCluster action.

\n

For more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters.

\n " + } }, - { - "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + "com.amazonaws.rds#StartDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as\n a lowercase string.

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + "com.amazonaws.rds#StartDBClusterResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + } }, - { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + "com.amazonaws.rds#StartDBInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StartDBInstanceMessage" + }, + "output": { + "target": "com.amazonaws.rds#StartDBInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#AuthorizationNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + }, + { + "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidSubnet" + }, + { + "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.

\n

For more information, see \n \n Starting an Amazon RDS DB instance That Was Previously Stopped in the \n Amazon RDS User Guide.\n

\n \n

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora DB clusters, use StartDBCluster instead.

\n " + } }, - { - "target": "com.amazonaws.rds#DomainNotFoundFault" + "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationMessage" + }, + "output": { + "target": "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackupQuotaExceededFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + }, + { + "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" + } + ], + "traits": { + "smithy.api#documentation": "

Enables replication of automated backups to a different Amazon Web Services Region.

\n

This command doesn't apply to RDS Custom.

\n

For more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n

" + } }, - { - "target": "com.amazonaws.rds#InstanceQuotaExceededFault" + "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationMessage": { + "type": "structure", + "members": { + "SourceDBInstanceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source DB instance for the replicated automated backups, for example, \n arn:aws:rds:us-west-2:123456789012:db:mydatabase.

", + "smithy.api#required": {} + } + }, + "BackupRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The retention period for the replicated automated backups.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the\n Amazon Resource Name (ARN) for the KMS encryption key in the destination Amazon Web Services Region, for example, \n arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.

" + } + }, + "PreSignedUrl": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request \n for the StartDBInstanceAutomatedBackupsReplication operation to call \n in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the\n StartDBInstanceAutomatedBackupsReplication API operation that can run in \n the Amazon Web Services Region that contains the source DB instance.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n " + } + } + } }, - { - "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" + "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationResult": { + "type": "structure", + "members": { + "DBInstanceAutomatedBackup": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackup" + } + } }, - { - "target": "com.amazonaws.rds#InvalidDBSnapshotStateFault" + "com.amazonaws.rds#StartDBInstanceMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The user-supplied instance identifier.

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.rds#InvalidRestoreFault" + "com.amazonaws.rds#StartDBInstanceResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + } }, - { - "target": "com.amazonaws.rds#InvalidSubnet" + "com.amazonaws.rds#StartExportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StartExportTaskMessage" + }, + "output": { + "target": "com.amazonaws.rds#ExportTask" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.rds#ExportTaskAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#IamRoleMissingPermissionsFault" + }, + { + "target": "com.amazonaws.rds#IamRoleNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidExportOnlyFault" + }, + { + "target": "com.amazonaws.rds#InvalidExportSourceStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidS3BucketFault" + }, + { + "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an export of a snapshot to Amazon S3. \n The provided IAM role must have access to the S3 bucket.

\n

This command doesn't apply to RDS Custom.

" + } }, - { - "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + "com.amazonaws.rds#StartExportTaskMessage": { + "type": "structure", + "members": { + "ExportTaskIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A unique identifier for the snapshot export task. This ID isn't an identifier for\n the Amazon S3 bucket where the snapshot is to be exported to.

", + "smithy.api#required": {} + } + }, + "SourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3.

", + "smithy.api#required": {} + } + }, + "S3BucketName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket to export the snapshot to.

", + "smithy.api#required": {} + } + }, + "IamRoleArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the IAM role to use for writing to the Amazon S3 bucket \n when exporting a snapshot.

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services KMS key to use to encrypt the snapshot exported to Amazon S3. The Amazon Web Services KMS \n key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. \n The caller of this operation must be authorized to run the following operations. \n These can be set in the Amazon Web Services KMS key policy:

\n ", + "smithy.api#required": {} + } + }, + "S3Prefix": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

" + } + }, + "ExportOnly": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The data to be exported from the snapshot. \n If this parameter is not provided, all the snapshot data is exported.\n Valid values are the following:

\n " + } + } + } }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + "com.amazonaws.rds#StopActivityStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StopActivityStreamRequest" + }, + "output": { + "target": "com.amazonaws.rds#StopActivityStreamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a database activity stream that was started using the Amazon Web Services console, \n the start-activity-stream CLI command, or the StartActivityStream action.

\n

For more information, see \n Database Activity Streams\n in the Amazon Aurora User Guide.

" + } }, - { - "target": "com.amazonaws.rds#NetworkTypeNotSupported" + "com.amazonaws.rds#StopActivityStreamRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the DB cluster for the database activity stream.\n For example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.

", + "smithy.api#required": {} + } + }, + "ApplyImmediately": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether or not the database activity stream is to stop as soon as possible, \n regardless of the maintenance window for the database.

" + } + } + } }, - { - "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + "com.amazonaws.rds#StopActivityStreamResponse": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" + } + }, + "KinesisStreamName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Kinesis data stream used for the database activity stream.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#ActivityStreamStatus", + "traits": { + "smithy.api#documentation": "

The status of the database activity stream.

" + } + } + } }, - { - "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" + "com.amazonaws.rds#StopDBCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StopDBClusterMessage" + }, + "output": { + "target": "com.amazonaws.rds#StopDBClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's\n metadata, including its endpoints and DB parameter groups. Aurora also\n retains the transaction logs so you can do a point-in-time restore if necessary.

\n

For more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters.

\n " + } }, - { - "target": "com.amazonaws.rds#StorageQuotaExceededFault" + "com.amazonaws.rds#StopDBClusterMessage": { + "type": "structure", + "members": { + "DBClusterIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as\n a lowercase string.

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most\n of the source's original configuration, including the default security group and DB parameter group. By default, the new DB\n instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group\n associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.

\n

If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance\n before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you\n have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as\n the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original\n DB instance with the DB instance created from the snapshot.

\n

If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\n must be the ARN of the shared DB snapshot.

\n \n

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.

\n " - } - }, - "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.

\n

Constraints:

\n \n

Example: my-snapshot-id\n

", - "smithy.api#required": {} - } - }, - "DBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the DB snapshot to restore from.

\n

Constraints:

\n " - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n

\n

Default: The same DBInstanceClass as the original DB instance.

" - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

Default: The same port as the original DB instance

\n

Constraints: Value must be 1150-65535\n

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Availability Zone (AZ) where the DB instance will be created.

\n

Default: A random, system-chosen Availability Zone.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

\n

Example: us-east-1a\n

" - } - }, - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB subnet group name to use for the new instance.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to RDS Custom.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled \n by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether minor version upgrades are applied automatically to the DB instance \n during the maintenance window.

\n

If you restore an RDS Custom DB instance, you must disable this parameter.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

License model information for the restored DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: Same as source.

\n

Valid values: license-included | bring-your-own-license | general-public-license\n

" - } - }, - "DBName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database name for the restored DB instance.

\n

This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. It also doesn't apply to RDS\n Custom DB instances.

" - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database engine to use for the new instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

\n

Valid Values:

\n " - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. \n If this parameter isn't specified, the IOPS value is taken from the backup. \n If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. \n The conversion takes additional time, though your DB instance is available for connections before the conversion starts.

\n

The provisioned IOPS value must follow the requirements for your database engine.\n For more information, see \n Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.\n

\n

Constraints: Must be an integer greater than 1000.

" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the option group to be used for the restored DB instance.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option \n group, and that option group can't be removed from a DB instance after it is associated with a DB instance.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" - } - }, - "TdeCredentialArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "TdeCredentialPassword": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB instance.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" - } - }, - "Domain": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB instance in.\n The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.

\n

In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you \n specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from\n the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.

\n

For more information, see \n Copying tags to DB instance snapshots in the Amazon RDS User Guide.

" - } - }, - "DomainIAMRoleName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "ProcessorFeatures": { - "target": "com.amazonaws.rds#ProcessorFeatureList", - "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "UseDefaultProcessorFeatures": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance.

\n

If you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup \n for the specified DB engine.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n " - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" - } - }, - "EnableCustomerOwnedIp": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

This setting doesn't apply to RDS Custom.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" - } - }, - "CustomIamInstanceProfile": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n \n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" - } - }, - "BackupTarget": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies where automated backups and manual snapshots are stored for the restored DB instance.

\n

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" - } - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" - } - }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" - } - }, - "DBClusterSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

\n

Constraints:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#RestoreDBInstanceFromDBSnapshotResult": { - "type": "structure", - "members": { - "DBInstance": { - "target": "com.amazonaws.rds#DBInstance" - } - } - }, - "com.amazonaws.rds#RestoreDBInstanceFromS3": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#RestoreDBInstanceFromS3Message" - }, - "output": { - "target": "com.amazonaws.rds#RestoreDBInstanceFromS3Result" - }, - "errors": [ - { - "target": "com.amazonaws.rds#AuthorizationNotFoundFault" + "com.amazonaws.rds#StopDBClusterResult": { + "type": "structure", + "members": { + "DBCluster": { + "target": "com.amazonaws.rds#DBCluster" + } + } }, - { - "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" + "com.amazonaws.rds#StopDBInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StopDBInstanceMessage" + }, + "output": { + "target": "com.amazonaws.rds#StopDBInstanceResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#DBSnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + }, + { + "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, \n DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if \n necessary.

\n

For more information, see \n \n Stopping an Amazon RDS DB Instance Temporarily in the \n Amazon RDS User Guide.\n

\n \n

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora clusters, use StopDBCluster instead.

\n " + } }, - { - "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" + "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationMessage" + }, + "output": { + "target": "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Stops automated backup replication for a DB instance.

\n

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.

\n

For more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n

" + } }, - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationMessage": { + "type": "structure", + "members": { + "SourceDBInstanceArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source DB instance for which to stop replicating automated backups, for example, \n arn:aws:rds:us-west-2:123456789012:db:mydatabase.

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationResult": { + "type": "structure", + "members": { + "DBInstanceAutomatedBackup": { + "target": "com.amazonaws.rds#DBInstanceAutomatedBackup" + } + } }, - { - "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + "com.amazonaws.rds#StopDBInstanceMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The user-supplied instance identifier.

", + "smithy.api#required": {} + } + }, + "DBSnapshotIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.

" + } + } + } }, - { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + "com.amazonaws.rds#StopDBInstanceResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + } }, - { - "target": "com.amazonaws.rds#InstanceQuotaExceededFault" + "com.amazonaws.rds#StorageQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "StorageQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request would result in the user exceeding the allowed amount of storage\n available across all DB instances.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" + "com.amazonaws.rds#StorageTypeNotSupportedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "StorageTypeNotSupported", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Storage of the StorageType specified can't be associated\n with the DB instance.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.rds#InvalidS3BucketFault" + "com.amazonaws.rds#String": { + "type": "string" }, - { - "target": "com.amazonaws.rds#InvalidSubnet" + "com.amazonaws.rds#String255": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": ".*" + } }, - { - "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + "com.amazonaws.rds#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String" + } }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + "com.amazonaws.rds#Subnet": { + "type": "structure", + "members": { + "SubnetIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The identifier of the subnet.

" + } + }, + "SubnetAvailabilityZone": { + "target": "com.amazonaws.rds#AvailabilityZone" + }, + "SubnetOutpost": { + "target": "com.amazonaws.rds#Outpost", + "traits": { + "smithy.api#documentation": "

If the subnet is associated with an Outpost, this value specifies the Outpost.

\n

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n

" + } + }, + "SubnetStatus": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The status of the subnet.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element for the DescribeDBSubnetGroups operation.

" + } }, - { - "target": "com.amazonaws.rds#NetworkTypeNotSupported" + "com.amazonaws.rds#SubnetAlreadyInUse": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubnetAlreadyInUse", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The DB subnet is already in use in the Availability Zone.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + "com.amazonaws.rds#SubnetIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "SubnetIdentifier" + } + } }, - { - "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" + "com.amazonaws.rds#SubnetList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Subnet", + "traits": { + "smithy.api#xmlName": "Subnet" + } + } }, - { - "target": "com.amazonaws.rds#StorageQuotaExceededFault" + "com.amazonaws.rds#SubscriptionAlreadyExistFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubscriptionAlreadyExist", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The supplied subscription name already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" - } - ], - "traits": { - "smithy.api#documentation": "

Amazon Relational Database Service (Amazon RDS) \n supports importing MySQL databases by using backup files. \n You can create a backup of your on-premises database, \n store it on Amazon Simple Storage Service (Amazon S3), \n and then restore the backup file onto a new Amazon RDS DB instance running MySQL.\n For more information, see Importing Data into an Amazon RDS MySQL DB Instance \n in the Amazon RDS User Guide.\n

\n

This command doesn't apply to RDS Custom.

" - } - }, - "com.amazonaws.rds#RestoreDBInstanceFromS3Message": { - "type": "structure", - "members": { - "DBName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the database to create when the DB instance is created.\n Follow the naming rules specified in CreateDBInstance.

" - } - }, - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB instance identifier. This parameter is stored as a lowercase string.

\n

Constraints:

\n \n

Example: mydbinstance\n

", - "smithy.api#required": {} - } - }, - "AllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of storage (in gigabytes) to allocate initially for the DB instance.\n Follow the allocation rules specified in CreateDBInstance.

\n \n

Be sure to allocate enough memory for your new DB instance\n so that the restore operation can succeed.\n You can also allocate additional memory for future growth.

\n " - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the DB instance, \n for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, \n or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.\n

\n

Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.

", - "smithy.api#required": {} - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the database engine to be used for this instance.

\n

Valid Values: \n mysql\n

", - "smithy.api#required": {} - } - }, - "MasterUsername": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name for the master user.

\n

Constraints:

\n " - } - }, - "MasterUserPassword": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The password for the master user. \n The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

Constraints: Can't be specified if ManageMasterUserPassword is turned on.

\n

\n MariaDB\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Microsoft SQL Server\n

\n

Constraints: Must contain from 8 to 128 characters.

\n

\n MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n Oracle\n

\n

Constraints: Must contain from 8 to 30 characters.

\n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

" - } - }, - "DBSecurityGroups": { - "target": "com.amazonaws.rds#DBSecurityGroupNameList", - "traits": { - "smithy.api#documentation": "

A list of DB security groups to associate with this DB instance.

\n

Default: The default DB security group for the database engine.

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of VPC security groups to associate with this DB instance.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Availability Zone that the DB instance is created in. \n For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.\n

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

Example: us-east-1d\n

\n

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.

" - } - }, - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A DB subnet group to associate with this DB instance.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The time range each week during which system maintenance can occur, \n in Universal Coordinated Time (UTC). \n For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.\n

\n

Constraints:

\n " - } - }, - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance.

\n

If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.

" - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days for which automated backups are retained. \n Setting this parameter to a positive number enables backups.\n For more information, see CreateDBInstance.

" - } - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The time range each day \n during which automated backups are created \n if automated backups are enabled. \n For more information, see Backup window in the Amazon RDS User Guide.\n

\n

Constraints:

\n " - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

Type: Integer

\n

Valid Values: 1150-65535\n

\n

Default: 3306\n

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment. \n If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.\n Choose the latest minor version of your database engine. \n For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

" - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether minor engine upgrades are applied automatically \n to the DB instance during the maintenance window. By default, minor engine upgrades \n are not applied automatically.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The license model for this DB instance.\n Use general-public-license.

" - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) \n to allocate initially for the DB instance.\n For information about valid IOPS values, \n see Amazon RDS Provisioned IOPS storage \n in the Amazon RDS User Guide.\n

" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the option group to associate with this DB instance. \n If this argument is omitted, the default option group for the specified engine is used.

" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB instance's virtual private cloud (VPC). \n It resolves to the public IP address from outside of the DB instance's VPC. \n Access to the DB instance is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

A list of tags to associate with this DB instance.\n For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.\n

" - } - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, \n you must also include a value for the Iops parameter.

\n

Default: io1 \n if the Iops parameter is specified; \n otherwise gp2\n

" - } - }, - "StorageEncrypted": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the new DB instance is encrypted or not.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for an encrypted DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If the StorageEncrypted parameter is enabled, \n and you do not specify a value for the KmsKeyId parameter, \n then Amazon RDS will use your default KMS key. \n There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

" - } - }, - "MonitoringInterval": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The interval, in seconds, \n between points when Enhanced Monitoring metrics are collected for the DB instance. \n To disable collecting Enhanced Monitoring metrics, specify 0.

\n

If MonitoringRoleArn is specified, \n then you must also set MonitoringInterval to a value other than 0.

\n

Valid Values: 0, 1, 5, 10, 15, 30, 60

\n

Default: 0\n

" - } - }, - "MonitoringRoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN for the IAM role that permits RDS \n to send enhanced monitoring metrics to Amazon CloudWatch Logs. \n For example, arn:aws:iam:123456789012:role/emaccess. \n For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.\n

\n

If MonitoringInterval is set to a value other than 0, \n then you must supply a MonitoringRoleArn value.

" - } - }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" - } - }, - "SourceEngine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the engine of your source database.

\n

Valid Values: \n mysql\n

", - "smithy.api#required": {} - } - }, - "SourceEngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version of the database that the backup files were created from.

\n

MySQL versions 5.6 and 5.7 are supported.

\n

Example: 5.6.40\n

", - "smithy.api#required": {} - } - }, - "S3BucketName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of your Amazon S3 bucket \n that contains your database backup file.

", - "smithy.api#required": {} - } - }, - "S3Prefix": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The prefix of your Amazon S3 bucket.

" - } - }, - "S3IngestionRoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.

", - "smithy.api#required": {} - } - }, - "EnablePerformanceInsights": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable Performance Insights for the DB instance.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

" - } - }, - "PerformanceInsightsKMSKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

" - } - }, - "PerformanceInsightsRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

\n \n

For example, the following values are valid:

\n \n

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

" - } - }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

" - } - }, - "ProcessorFeatures": { - "target": "com.amazonaws.rds#ProcessorFeatureList", - "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

" - } - }, - "UseDefaultProcessorFeatures": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" - } - }, - "MaxAllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

" - } - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" - } - }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" - } - }, - "ManageMasterUserPassword": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

\n

For more information, see Password management with Amazon Web Services Secrets Manager \n in the Amazon RDS User Guide.\n

\n

Constraints:

\n " - } - }, - "MasterUserSecretKmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" - } - } - } - }, - "com.amazonaws.rds#RestoreDBInstanceFromS3Result": { - "type": "structure", - "members": { - "DBInstance": { - "target": "com.amazonaws.rds#DBInstance" - } - } - }, - "com.amazonaws.rds#RestoreDBInstanceToPointInTime": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#RestoreDBInstanceToPointInTimeMessage" - }, - "output": { - "target": "com.amazonaws.rds#RestoreDBInstanceToPointInTimeResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#AuthorizationNotFoundFault" + "com.amazonaws.rds#SubscriptionCategoryNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubscriptionCategoryNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The supplied category does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } }, - { - "target": "com.amazonaws.rds#BackupPolicyNotFoundFault" + "com.amazonaws.rds#SubscriptionNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubscriptionNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The subscription name does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } }, - { - "target": "com.amazonaws.rds#DBInstanceAlreadyExistsFault" + "com.amazonaws.rds#SupportedCharacterSetsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#CharacterSet", + "traits": { + "smithy.api#xmlName": "CharacterSet" + } + } }, - { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackupNotFoundFault" + "com.amazonaws.rds#SupportedTimezonesList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Timezone", + "traits": { + "smithy.api#xmlName": "Timezone" + } + } }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + "com.amazonaws.rds#SwitchoverBlueGreenDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#SwitchoverBlueGreenDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.rds#SwitchoverBlueGreenDeploymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidBlueGreenDeploymentStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Switches over a blue/green deployment.

\n

Before you switch over, production traffic is routed to the databases in the blue environment. \n After you switch over, production traffic is routed to the databases in the green environment.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

" + } }, - { - "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" + "com.amazonaws.rds#SwitchoverBlueGreenDeploymentRequest": { + "type": "structure", + "members": { + "BlueGreenDeploymentIdentifier": { + "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", + "traits": { + "smithy.api#documentation": "

The blue/green deployment identifier.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + }, + "SwitchoverTimeout": { + "target": "com.amazonaws.rds#SwitchoverTimeout", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, for the switchover to complete. The default is 300.

\n

If the switchover takes longer than the specified duration, then any changes are rolled back, \n and no changes are made to the environments.

" + } + } + } }, - { - "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" + "com.amazonaws.rds#SwitchoverBlueGreenDeploymentResponse": { + "type": "structure", + "members": { + "BlueGreenDeployment": { + "target": "com.amazonaws.rds#BlueGreenDeployment" + } + } }, - { - "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + "com.amazonaws.rds#SwitchoverDetail": { + "type": "structure", + "members": { + "SourceMember": { + "target": "com.amazonaws.rds#DatabaseArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a resource in the blue environment.

" + } + }, + "TargetMember": { + "target": "com.amazonaws.rds#DatabaseArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a resource in the green environment.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#SwitchoverDetailStatus", + "traits": { + "smithy.api#documentation": "

The switchover status of a resource in a blue/green deployment.

\n

Values:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details about a blue/green deployment.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

" + } }, - { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + "com.amazonaws.rds#SwitchoverDetailList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#SwitchoverDetail" + } }, - { - "target": "com.amazonaws.rds#DomainNotFoundFault" + "com.amazonaws.rds#SwitchoverDetailStatus": { + "type": "string" }, - { - "target": "com.amazonaws.rds#InstanceQuotaExceededFault" + "com.amazonaws.rds#SwitchoverReadReplica": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#SwitchoverReadReplicaMessage" + }, + "output": { + "target": "com.amazonaws.rds#SwitchoverReadReplicaResult" + }, + "errors": [ + { + "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new\n primary database. Issue this command in the Region that hosts the current standby database.

" + } }, - { - "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" + "com.amazonaws.rds#SwitchoverReadReplicaMessage": { + "type": "structure", + "members": { + "DBInstanceIdentifier": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The DB instance identifier of the current standby database. This value is stored as a lowercase string.

\n

Constraints:

\n ", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + "com.amazonaws.rds#SwitchoverReadReplicaResult": { + "type": "structure", + "members": { + "DBInstance": { + "target": "com.amazonaws.rds#DBInstance" + } + } }, - { - "target": "com.amazonaws.rds#InvalidRestoreFault" + "com.amazonaws.rds#SwitchoverTimeout": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 30 + } + } }, - { - "target": "com.amazonaws.rds#InvalidSubnet" + "com.amazonaws.rds#TStamp": { + "type": "timestamp" }, - { - "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + "com.amazonaws.rds#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").

" + } + }, + "Value": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

\n

For more information, see Tagging \n Amazon RDS Resources in the Amazon RDS User Guide.\n

" + } }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" + "com.amazonaws.rds#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#Tag", + "traits": { + "smithy.api#xmlName": "Tag" + } + }, + "traits": { + "smithy.api#documentation": "

A list of tags.\n For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.\n

" + } }, - { - "target": "com.amazonaws.rds#NetworkTypeNotSupported" + "com.amazonaws.rds#TagListMessage": { + "type": "structure", + "members": { + "TagList": { + "target": "com.amazonaws.rds#TagList", + "traits": { + "smithy.api#documentation": "

List of tags returned by the ListTagsForResource operation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

" + } }, - { - "target": "com.amazonaws.rds#OptionGroupNotFoundFault" + "com.amazonaws.rds#TargetDBClusterParameterGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z](?!.*--)[0-9A-Za-z-]*[^-]|^default(?!.*--)(?!.*\\.\\.)[0-9A-Za-z-.]*[^-]$" + } }, - { - "target": "com.amazonaws.rds#PointInTimeRestoreNotEnabledFault" + "com.amazonaws.rds#TargetDBParameterGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z](?!.*--)[0-9A-Za-z-]*[^-]|^default(?!.*--)(?!.*\\.\\.)[0-9A-Za-z-.]*[^-]$" + } }, - { - "target": "com.amazonaws.rds#ProvisionedIopsNotAvailableInAZFault" + "com.amazonaws.rds#TargetEngineVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9A-Za-z-_.]+$" + } }, - { - "target": "com.amazonaws.rds#StorageQuotaExceededFault" + "com.amazonaws.rds#TargetGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBProxyTargetGroup" + } }, - { - "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" - } - ], - "traits": { - "smithy.api#documentation": "

Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

\n

The target database is created with most of the original configuration, but in a\n system-selected Availability Zone, with the default security group, the default subnet\n group, and the default DB parameter group. By default, the new DB instance is created as\n a single-AZ deployment except when the instance is a SQL Server instance that has an\n option group that is associated with mirroring; in this case, the instance becomes a\n mirrored deployment and not a single-AZ deployment.

\n \n

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.

\n " - } - }, - "com.amazonaws.rds#RestoreDBInstanceToPointInTimeMessage": { - "type": "structure", - "members": { - "SourceDBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the source DB instance from which to restore.

\n

Constraints:

\n " - } - }, - "TargetDBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the new DB instance to be created.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "RestoreTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The date and time to restore from.

\n

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

\n

Constraints:

\n \n

Example: 2009-09-07T23:45:00Z\n

" - } - }, - "UseLatestRestorableTime": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance \n isn't restored from the latest backup time.

\n

Constraints: Can't be specified if the RestoreTime parameter is provided.

" - } - }, - "DBInstanceClass": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the Amazon RDS DB instance, for example\n db.m4.large. Not all DB instance classes are available in all Amazon Web Services\n Regions, or for all database engines. For the full list of DB instance classes, and\n availability for your engine, see DB Instance\n Class in the Amazon RDS User Guide.

\n

Default: The same DBInstanceClass as the original DB instance.

" - } - }, - "Port": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The port number on which the database accepts connections.

\n

Constraints: Value must be 1150-65535\n

\n

Default: The same port as the original DB instance.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Availability Zone (AZ) where the DB instance will be created.

\n

Default: A random, system-chosen Availability Zone.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

\n

Example: us-east-1a\n

" - } - }, - "DBSubnetGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB subnet group name to use for the new instance.

\n

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

\n

Example: mydbsubnetgroup\n

" - } - }, - "MultiAZ": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is a Multi-AZ deployment.

\n

This setting doesn't apply to RDS Custom.

\n

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a \n Multi-AZ deployment.

" - } - }, - "PubliclyAccessible": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.

\n

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

\n

For more information, see CreateDBInstance.

" - } - }, - "AutoMinorVersionUpgrade": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether minor version upgrades are applied automatically to the \n DB instance during the maintenance window.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "LicenseModel": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

License model information for the restored DB instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: Same as source.

\n

Valid values: license-included | bring-your-own-license | general-public-license\n

" - } - }, - "DBName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database name for the restored DB instance.

\n \n

This parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.

\n " - } - }, - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The database engine to use for the new instance.

\n

This setting doesn't apply to RDS Custom.

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source

\n

Valid Values:

\n " - } - }, - "Iops": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

\n

Constraints: Must be an integer greater than 1000.

\n

\n SQL Server\n

\n

Setting the IOPS value for the SQL Server database engine isn't supported.

" - } - }, - "OptionGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the option group to be used for the restored DB instance.

\n

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an \n option group, and that option group can't be removed from a DB instance after it is associated with a DB instance

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "CopyTagsToSnapshot": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.

" - } - }, - "Tags": { - "target": "com.amazonaws.rds#TagList" - }, - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies the storage type to be associated with the DB instance.

\n

Valid values: gp2 | gp3 | io1 | standard\n

\n

If you specify io1 or gp3, you must also include a value for the\n Iops parameter.

\n

Default: io1 if the Iops parameter\n is specified, otherwise gp2\n

" - } - }, - "TdeCredentialArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ARN from the key store with which to associate the instance for TDE encryption.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "TdeCredentialPassword": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The password for the given ARN from the key store in order to access the device.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "VpcSecurityGroupIds": { - "target": "com.amazonaws.rds#VpcSecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with this DB instance.

\n

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" - } - }, - "Domain": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specify the Active Directory directory ID to restore the DB instance in.\n Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

\n

This setting doesn't apply to RDS Custom.

\n

For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.

" - } - }, - "DomainIAMRoleName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "EnableIAMDatabaseAuthentication": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management\n (IAM) accounts to database accounts. By default, mapping isn't enabled.

\n

This setting doesn't apply to RDS Custom.

\n

For more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n

" - } - }, - "EnableCloudwatchLogsExports": { - "target": "com.amazonaws.rds#LogTypeList", - "traits": { - "smithy.api#documentation": "

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "ProcessorFeatures": { - "target": "com.amazonaws.rds#ProcessorFeatureList", - "traits": { - "smithy.api#documentation": "

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "UseDefaultProcessorFeatures": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "DBParameterGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB parameter group to associate with this DB instance.

\n

If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.

\n

This setting doesn't apply to RDS Custom.

\n

Constraints:

\n " - } - }, - "DeletionProtection": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether the DB instance has deletion protection enabled. \n The database can't be deleted when deletion protection is enabled. By default, \n deletion protection isn't enabled. For more information, see \n \n Deleting a DB Instance.

" - } - }, - "SourceDbiResourceId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The resource ID of the source DB instance from which to restore.

" - } - }, - "MaxAllocatedStorage": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "SourceDBInstanceAutomatedBackupsArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, \n arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

\n

This setting doesn't apply to RDS Custom.

" - } - }, - "EnableCustomerOwnedIp": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

\n

A CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.

\n

This setting doesn't apply to RDS Custom.

\n

For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.

\n

For more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.

" - } - }, - "CustomIamInstanceProfile": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n \n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

" - } - }, - "BackupTarget": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

Specifies where automated backups and manual snapshots are stored for the restored DB instance.

\n

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

" - } - }, - "NetworkType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" - } - }, - "StorageThroughput": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

Specifies the storage throughput value for the DB instance.

\n

This setting doesn't apply to RDS Custom or Amazon Aurora.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#RestoreDBInstanceToPointInTimeResult": { - "type": "structure", - "members": { - "DBInstance": { - "target": "com.amazonaws.rds#DBInstance" - } - } - }, - "com.amazonaws.rds#RestoreWindow": { - "type": "structure", - "members": { - "EarliestTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The earliest time you can restore an instance to.

" - } - }, - "LatestTime": { - "target": "com.amazonaws.rds#TStamp", - "traits": { - "smithy.api#documentation": "

The latest time you can restore an instance to.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Earliest and latest time an instance can be restored to:

" - } - }, - "com.amazonaws.rds#RevokeDBSecurityGroupIngress": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#RevokeDBSecurityGroupIngressMessage" - }, - "output": { - "target": "com.amazonaws.rds#RevokeDBSecurityGroupIngressResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#AuthorizationNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBSecurityGroupStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required \n parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either \n EC2SecurityGroupName or EC2SecurityGroupId).

\n \n

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that \n you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the \n Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring ā€“ \n Hereā€™s How to Prepare, and Moving a DB instance not in a VPC \n into a VPC in the Amazon RDS User Guide.

\n " - } - }, - "com.amazonaws.rds#RevokeDBSecurityGroupIngressMessage": { - "type": "structure", - "members": { - "DBSecurityGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the DB security group to revoke ingress from.

", - "smithy.api#required": {} - } - }, - "CIDRIP": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The IP range to revoke access from. \n Must be a valid CIDR range. If CIDRIP is specified, \n EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId\n can't be provided.

" - } - }, - "EC2SecurityGroupName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the EC2 security group to revoke access from.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" - } - }, - "EC2SecurityGroupId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The id of the EC2 security group to revoke access from.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" - } - }, - "EC2SecurityGroupOwnerId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account number of the owner of the EC2 security group\n specified in the EC2SecurityGroupName parameter.\n The Amazon Web Services access key ID isn't an acceptable value.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#RevokeDBSecurityGroupIngressResult": { - "type": "structure", - "members": { - "DBSecurityGroup": { - "target": "com.amazonaws.rds#DBSecurityGroup" - } - } - }, - "com.amazonaws.rds#SNSInvalidTopicFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "SNSInvalidTopic", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

SNS has responded that there is a problem with the SNS topic specified.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#SNSNoAuthorizationFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "SNSNoAuthorization", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

You do not have permission to publish to the SNS topic ARN.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#SNSTopicArnNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "SNSTopicArnNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The SNS topic ARN does not exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#ScalingConfiguration": { - "type": "structure", - "members": { - "MinCapacity": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

\n

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

\n

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

\n

The minimum capacity must be less than or equal to the maximum capacity.

" - } - }, - "MaxCapacity": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

\n

For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

\n

For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.

\n

The maximum capacity must be greater than or equal to the minimum capacity.

" - } - }, - "AutoPause": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode.\n A DB cluster can be paused only when it's idle (it has no connections).

\n \n

If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot.\n In this case, the DB cluster is restored when there is a request to connect to it.

\n " - } - }, - "SecondsUntilAutoPause": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

\n

Specify a value between 300 and 86,400 seconds.

" - } - }, - "TimeoutAction": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

\n

\n ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.

\n

\n RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.

\n \n

If you specify ForceApplyCapacityChange, connections that\n prevent Aurora Serverless v1 from finding a scaling point might be dropped.

\n \n

For more information, see \n Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

" - } - }, - "SecondsBeforeTimeout": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point\n to perform seamless scaling before enforcing the timeout action. The default is 300.

\n

Specify a value between 60 and 600 seconds.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the scaling configuration of an Aurora Serverless v1 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v1 in the\n Amazon Aurora User Guide.

" - } - }, - "com.amazonaws.rds#ScalingConfigurationInfo": { - "type": "structure", - "members": { - "MinCapacity": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

" - } - }, - "MaxCapacity": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

" - } - }, - "AutoPause": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether automatic pause is allowed for the Aurora DB cluster\n in serverless DB engine mode.

\n

When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.

" - } - }, - "SecondsUntilAutoPause": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The remaining amount of time, in seconds, before the Aurora DB cluster in\n serverless mode is paused. A DB cluster can be paused only when\n it's idle (it has no connections).

" - } - }, - "TimeoutAction": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The action that occurs when Aurora times out while attempting to change the capacity of an\n Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or\n RollbackCapacityChange.

\n

\n ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

\n

\n RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.

" - } - }, - "SecondsBeforeTimeout": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The number of seconds before scaling times out. What happens when an attempted scaling action times out\n is determined by the TimeoutAction setting.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

\n

For more information, see Using Amazon Aurora Serverless v1 in the\n Amazon Aurora User Guide.

" - } - }, - "com.amazonaws.rds#ServerlessV2ScalingConfiguration": { - "type": "structure", - "members": { - "MinCapacity": { - "target": "com.amazonaws.rds#DoubleOptional", - "traits": { - "smithy.api#documentation": "

The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value\n that you can use is 0.5.

" - } - }, - "MaxCapacity": { - "target": "com.amazonaws.rds#DoubleOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value\n that you can use is 128.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v2 in the\n Amazon Aurora User Guide.

" - } - }, - "com.amazonaws.rds#ServerlessV2ScalingConfigurationInfo": { - "type": "structure", - "members": { - "MinCapacity": { - "target": "com.amazonaws.rds#DoubleOptional", - "traits": { - "smithy.api#documentation": "

The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value\n that you can use is 0.5.

" - } - }, - "MaxCapacity": { - "target": "com.amazonaws.rds#DoubleOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value\n that you can use is 128.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Shows the scaling configuration for an Aurora Serverless v2 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v2 in the\n Amazon Aurora User Guide.

" - } - }, - "com.amazonaws.rds#SharedSnapshotQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "SharedSnapshotQuotaExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#SnapshotQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "SnapshotQuotaExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The request would result in the user exceeding the allowed number of DB\n snapshots.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#SourceClusterNotSupportedFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "SourceClusterNotSupportedFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The source DB cluster isn't supported for a blue/green deployment.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#SourceDatabaseNotSupportedFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "SourceDatabaseNotSupportedFault", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The source DB instance isn't supported for a blue/green deployment.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#SourceIdsList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#xmlName": "SourceId" - } - } - }, - "com.amazonaws.rds#SourceNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "SourceNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The requested source could not be found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#SourceRegion": { - "type": "structure", - "members": { - "RegionName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the source Amazon Web Services Region.

" - } - }, - "Endpoint": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The endpoint for the source Amazon Web Services Region endpoint.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The status of the source Amazon Web Services Region.

" - } - }, - "SupportsDBInstanceAutomatedBackupsReplication": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains an Amazon Web Services Region name as the result of a successful call to the DescribeSourceRegions action.

" - } - }, - "com.amazonaws.rds#SourceRegionList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#SourceRegion", - "traits": { - "smithy.api#xmlName": "SourceRegion" - } - } - }, - "com.amazonaws.rds#SourceRegionMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "SourceRegions": { - "target": "com.amazonaws.rds#SourceRegionList", - "traits": { - "smithy.api#documentation": "

A list of SourceRegion instances that contains each source Amazon Web Services Region that the\n current Amazon Web Services Region can get a read replica or a DB snapshot from.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the result of a successful invocation of the DescribeSourceRegions action.

" - } - }, - "com.amazonaws.rds#SourceType": { - "type": "enum", - "members": { - "db_instance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "db-instance" - } - }, - "db_parameter_group": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "db-parameter-group" - } - }, - "db_security_group": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "db-security-group" - } - }, - "db_snapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "db-snapshot" - } - }, - "db_cluster": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "db-cluster" - } - }, - "db_cluster_snapshot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "db-cluster-snapshot" - } - }, - "custom_engine_version": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "custom-engine-version" - } - }, - "db_proxy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "db-proxy" - } - }, - "blue_green_deployment": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "blue-green-deployment" - } - } - } - }, - "com.amazonaws.rds#StartActivityStream": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#StartActivityStreamRequest" - }, - "output": { - "target": "com.amazonaws.rds#StartActivityStreamResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - }, - { - "target": "com.amazonaws.rds#ResourceNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Starts a database activity stream to monitor activity on the database.\n For more information, see Database Activity Streams\n in the Amazon Aurora User Guide.

" - } - }, - "com.amazonaws.rds#StartActivityStreamRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the DB cluster,\n for example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.

", - "smithy.api#required": {} - } - }, - "Mode": { - "target": "com.amazonaws.rds#ActivityStreamMode", - "traits": { - "smithy.api#documentation": "

Specifies the mode of the database activity stream.\n Database events such as a change or access generate an activity stream event.\n The database session can handle these events either synchronously or asynchronously.

", - "smithy.api#required": {} - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream.\n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

", - "smithy.api#required": {} - } - }, - "ApplyImmediately": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether or not the database activity stream is to start as soon as possible, \n regardless of the maintenance window for the database.

" - } - }, - "EngineNativeAuditFieldsIncluded": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether the database activity stream includes engine-native audit fields. This option only applies\n to an Oracle DB instance. By default, no engine-native audit fields are included.

" - } - } - } - }, - "com.amazonaws.rds#StartActivityStreamResponse": { - "type": "structure", - "members": { - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.

" - } - }, - "KinesisStreamName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Kinesis data stream to be used for the database activity stream.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#ActivityStreamStatus", - "traits": { - "smithy.api#documentation": "

The status of the database activity stream.

" - } - }, - "Mode": { - "target": "com.amazonaws.rds#ActivityStreamMode", - "traits": { - "smithy.api#documentation": "

The mode of the database activity stream.

" - } - }, - "ApplyImmediately": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether or not the database activity stream will start as soon as possible, \n regardless of the maintenance window for the database.

" - } - }, - "EngineNativeAuditFieldsIncluded": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Indicates whether engine-native audit fields are included in the database activity stream.

" - } - } - } - }, - "com.amazonaws.rds#StartDBCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#StartDBClusterMessage" - }, - "output": { - "target": "com.amazonaws.rds#StartDBClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster\n CLI command, or the StopDBCluster action.

\n

For more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters.

\n " - } - }, - "com.amazonaws.rds#StartDBClusterMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as\n a lowercase string.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.rds#StartDBClusterResult": { - "type": "structure", - "members": { - "DBCluster": { - "target": "com.amazonaws.rds#DBCluster" - } - } - }, - "com.amazonaws.rds#StartDBInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#StartDBInstanceMessage" - }, - "output": { - "target": "com.amazonaws.rds#StartDBInstanceResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#AuthorizationNotFoundFault" + "com.amazonaws.rds#TargetHealth": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.rds#TargetState", + "traits": { + "smithy.api#documentation": "

The current state of the connection health lifecycle for the RDS Proxy target.\n The following is a typical lifecycle example for the states of an RDS Proxy target:

\n

\n registering > unavailable > available > unavailable > available\n

" + } + }, + "Reason": { + "target": "com.amazonaws.rds#TargetHealthReason", + "traits": { + "smithy.api#documentation": "

The reason for the current health State of the RDS Proxy target.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A description of the health of the RDS Proxy target. \n If the State is AVAILABLE, a description is not included.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the connection health of an RDS Proxy target.

" + } }, - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" + "com.amazonaws.rds#TargetHealthReason": { + "type": "enum", + "members": { + "UNREACHABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNREACHABLE" + } + }, + "CONNECTION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECTION_FAILED" + } + }, + "AUTH_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTH_FAILURE" + } + }, + "PENDING_PROXY_CAPACITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_PROXY_CAPACITY" + } + }, + "INVALID_REPLICATION_STATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_REPLICATION_STATE" + } + } + } }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" + "com.amazonaws.rds#TargetList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#DBProxyTarget" + } }, - { - "target": "com.amazonaws.rds#DBSubnetGroupDoesNotCoverEnoughAZs" + "com.amazonaws.rds#TargetRole": { + "type": "enum", + "members": { + "READ_WRITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ_WRITE" + } + }, + "READ_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ_ONLY" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN" + } + } + } }, - { - "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" + "com.amazonaws.rds#TargetState": { + "type": "enum", + "members": { + "registering": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGISTERING" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "unavailable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNAVAILABLE" + } + } + } }, - { - "target": "com.amazonaws.rds#InsufficientDBInstanceCapacityFault" + "com.amazonaws.rds#TargetType": { + "type": "enum", + "members": { + "RDS_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_INSTANCE" + } + }, + "RDS_SERVERLESS_ENDPOINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_SERVERLESS_ENDPOINT" + } + }, + "TRACKED_CLUSTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRACKED_CLUSTER" + } + } + } }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" + "com.amazonaws.rds#Timezone": { + "type": "structure", + "members": { + "TimezoneName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the time zone.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A time zone associated with a \n DBInstance \n or a DBSnapshot.\n This data type is an element in the response to \n the DescribeDBInstances, \n the DescribeDBSnapshots,\n and the DescribeDBEngineVersions\n actions.

" + } }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" + "com.amazonaws.rds#UpgradeTarget": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the upgrade target database engine.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version number of the upgrade target database engine.

" + } + }, + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the database engine that a DB instance can be upgraded to.

" + } + }, + "AutoUpgrade": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

" + } + }, + "IsMajorVersionUpgrade": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether upgrading to the target version requires upgrading the major version of the database engine.

" + } + }, + "SupportedEngineModes": { + "target": "com.amazonaws.rds#EngineModeList", + "traits": { + "smithy.api#documentation": "

A list of the supported DB engine modes for the target engine version.

" + } + }, + "SupportsParallelQuery": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether you can use Aurora parallel query with the target engine version.

" + } + }, + "SupportsGlobalDatabases": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether you can use Aurora global databases with the target engine version.

" + } + }, + "SupportsBabelfish": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The version of the database engine that a DB instance can be upgraded to.

" + } }, - { - "target": "com.amazonaws.rds#InvalidSubnet" + "com.amazonaws.rds#UserAuthConfig": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A user-specified description about the authentication used by a proxy to log in as a specific database user.

" + } + }, + "UserName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database user to which the proxy connects.

" + } + }, + "AuthScheme": { + "target": "com.amazonaws.rds#AuthScheme", + "traits": { + "smithy.api#documentation": "

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

" + } + }, + "SecretArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate\n to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

" + } + }, + "IAMAuth": { + "target": "com.amazonaws.rds#IAMAuthMode", + "traits": { + "smithy.api#documentation": "

Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. \n The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

" + } + }, + "ClientPasswordAuthType": { + "target": "com.amazonaws.rds#ClientPasswordAuthType", + "traits": { + "smithy.api#documentation": "

The type of authentication the proxy uses for connections from clients.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the details of authentication used by a proxy to log in as a specific database user.

" + } }, - { - "target": "com.amazonaws.rds#InvalidVPCNetworkStateFault" + "com.amazonaws.rds#UserAuthConfigInfo": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

A user-specified description about the authentication used by a proxy to log in as a specific database user.

" + } + }, + "UserName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the database user to which the proxy connects.

" + } + }, + "AuthScheme": { + "target": "com.amazonaws.rds#AuthScheme", + "traits": { + "smithy.api#documentation": "

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

" + } + }, + "SecretArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate\n to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

" + } + }, + "IAMAuth": { + "target": "com.amazonaws.rds#IAMAuthMode", + "traits": { + "smithy.api#documentation": "

Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. \n The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

" + } + }, + "ClientPasswordAuthType": { + "target": "com.amazonaws.rds#ClientPasswordAuthType", + "traits": { + "smithy.api#documentation": "

The type of authentication the proxy uses for connections from clients.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns the details of authentication used by a proxy to log in as a specific database user.

" + } }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - } - ], - "traits": { - "smithy.api#documentation": "

Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.

\n

For more information, see \n \n Starting an Amazon RDS DB instance That Was Previously Stopped in the \n Amazon RDS User Guide.\n

\n \n

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora DB clusters, use StartDBCluster instead.

\n " - } - }, - "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationMessage" - }, - "output": { - "target": "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackupQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - }, - { - "target": "com.amazonaws.rds#StorageTypeNotSupportedFault" - } - ], - "traits": { - "smithy.api#documentation": "

Enables replication of automated backups to a different Amazon Web Services Region.

\n

This command doesn't apply to RDS Custom.

\n

For more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n

" - } - }, - "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationMessage": { - "type": "structure", - "members": { - "SourceDBInstanceArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source DB instance for the replicated automated backups, for example, \n arn:aws:rds:us-west-2:123456789012:db:mydatabase.

", - "smithy.api#required": {} - } - }, - "BackupRetentionPeriod": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The retention period for the replicated automated backups.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the\n Amazon Resource Name (ARN) for the KMS encryption key in the destination Amazon Web Services Region, for example, \n arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.

" - } - }, - "PreSignedUrl": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request \n for the StartDBInstanceAutomatedBackupsReplication operation to call \n in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the\n StartDBInstanceAutomatedBackupsReplication API operation that can run in \n the Amazon Web Services Region that contains the source DB instance.

\n

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other\n Amazon Web Services Regions.

\n

To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.

\n \n

If you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can run in the source Amazon Web Services Region.

\n " - } - } - } - }, - "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationResult": { - "type": "structure", - "members": { - "DBInstanceAutomatedBackup": { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackup" - } - } - }, - "com.amazonaws.rds#StartDBInstanceMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The user-supplied instance identifier.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.rds#StartDBInstanceResult": { - "type": "structure", - "members": { - "DBInstance": { - "target": "com.amazonaws.rds#DBInstance" - } - } - }, - "com.amazonaws.rds#StartExportTask": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#StartExportTaskMessage" - }, - "output": { - "target": "com.amazonaws.rds#ExportTask" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" + "com.amazonaws.rds#UserAuthConfigInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#UserAuthConfigInfo" + } }, - { - "target": "com.amazonaws.rds#DBClusterSnapshotNotFoundFault" + "com.amazonaws.rds#UserAuthConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#UserAuthConfig" + } }, - { - "target": "com.amazonaws.rds#DBSnapshotNotFoundFault" + "com.amazonaws.rds#ValidDBInstanceModificationsMessage": { + "type": "structure", + "members": { + "Storage": { + "target": "com.amazonaws.rds#ValidStorageOptionsList", + "traits": { + "smithy.api#documentation": "

Valid storage options for your DB instance.

" + } + }, + "ValidProcessorFeatures": { + "target": "com.amazonaws.rds#AvailableProcessorFeatureList", + "traits": { + "smithy.api#documentation": "

Valid processor features for your DB instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about valid modifications that you can make to your DB instance.\n Contains the result of a successful call to the \n DescribeValidDBInstanceModifications action.\n You can use this information when you call\n ModifyDBInstance.

" + } }, - { - "target": "com.amazonaws.rds#ExportTaskAlreadyExistsFault" + "com.amazonaws.rds#ValidStorageOptions": { + "type": "structure", + "members": { + "StorageType": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The valid storage types for your DB instance.\n For example: gp2, gp3, io1.

" + } + }, + "StorageSize": { + "target": "com.amazonaws.rds#RangeList", + "traits": { + "smithy.api#documentation": "

The valid range of storage in gibibytes (GiB).\n For example, 100 to 16,384.

" + } + }, + "ProvisionedIops": { + "target": "com.amazonaws.rds#RangeList", + "traits": { + "smithy.api#documentation": "

The valid range of provisioned IOPS.\n For example, 1000-256,000.

" + } + }, + "IopsToStorageRatio": { + "target": "com.amazonaws.rds#DoubleRangeList", + "traits": { + "smithy.api#documentation": "

The valid range of Provisioned IOPS to gibibytes of storage multiplier.\n For example, 3-10,\n which means that provisioned IOPS can be between 3 and 10 times storage.

" + } + }, + "SupportsStorageAutoscaling": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.

" + } + }, + "ProvisionedStorageThroughput": { + "target": "com.amazonaws.rds#RangeList", + "traits": { + "smithy.api#documentation": "

The valid range of provisioned storage throughput. For example, \n 500-4,000 mebibytes per second (MiBps).

" + } + }, + "StorageThroughputToIopsRatio": { + "target": "com.amazonaws.rds#DoubleRangeList", + "traits": { + "smithy.api#documentation": "

The valid range of storage throughput to provisioned IOPS ratios. For example, \n 0-0.25.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about valid modifications that you can make to your DB instance.\n Contains the result of a successful call to the \n DescribeValidDBInstanceModifications action.

" + } }, - { - "target": "com.amazonaws.rds#IamRoleMissingPermissionsFault" + "com.amazonaws.rds#ValidStorageOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#ValidStorageOptions", + "traits": { + "smithy.api#xmlName": "ValidStorageOptions" + } + } }, - { - "target": "com.amazonaws.rds#IamRoleNotFoundFault" + "com.amazonaws.rds#ValidUpgradeTargetList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#UpgradeTarget", + "traits": { + "smithy.api#xmlName": "UpgradeTarget" + } + } }, - { - "target": "com.amazonaws.rds#InvalidExportOnlyFault" + "com.amazonaws.rds#VpcSecurityGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#xmlName": "VpcSecurityGroupId" + } + } }, - { - "target": "com.amazonaws.rds#InvalidExportSourceStateFault" + "com.amazonaws.rds#VpcSecurityGroupMembership": { + "type": "structure", + "members": { + "VpcSecurityGroupId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The name of the VPC security group.

" + } + }, + "Status": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The membership status of the VPC security group.

\n

Currently, the only valid status is active.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This data type is used as a response element for queries on VPC security group membership.

" + } }, - { - "target": "com.amazonaws.rds#InvalidS3BucketFault" + "com.amazonaws.rds#VpcSecurityGroupMembershipList": { + "type": "list", + "member": { + "target": "com.amazonaws.rds#VpcSecurityGroupMembership", + "traits": { + "smithy.api#xmlName": "VpcSecurityGroupMembership" + } + } }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - } - ], - "traits": { - "smithy.api#documentation": "

Starts an export of a snapshot to Amazon S3. \n The provided IAM role must have access to the S3 bucket.

\n

This command doesn't apply to RDS Custom.

" - } - }, - "com.amazonaws.rds#StartExportTaskMessage": { - "type": "structure", - "members": { - "ExportTaskIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A unique identifier for the snapshot export task. This ID isn't an identifier for\n the Amazon S3 bucket where the snapshot is to be exported to.

", - "smithy.api#required": {} - } - }, - "SourceArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3.

", - "smithy.api#required": {} - } - }, - "S3BucketName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon S3 bucket to export the snapshot to.

", - "smithy.api#required": {} - } - }, - "IamRoleArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the IAM role to use for writing to the Amazon S3 bucket \n when exporting a snapshot.

", - "smithy.api#required": {} - } - }, - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services KMS key to use to encrypt the snapshot exported to Amazon S3. The Amazon Web Services KMS \n key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. \n The caller of this operation must be authorized to execute the following operations. \n These can be set in the Amazon Web Services KMS key policy:

\n ", - "smithy.api#required": {} - } - }, - "S3Prefix": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

" - } - }, - "ExportOnly": { - "target": "com.amazonaws.rds#StringList", - "traits": { - "smithy.api#documentation": "

The data to be exported from the snapshot. \n If this parameter is not provided, all the snapshot data is exported.\n Valid values are the following:

\n " - } - } - } - }, - "com.amazonaws.rds#StopActivityStream": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#StopActivityStreamRequest" - }, - "output": { - "target": "com.amazonaws.rds#StopActivityStreamResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#ResourceNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Stops a database activity stream that was started using the Amazon Web Services console, \n the start-activity-stream CLI command, or the StartActivityStream action.

\n

For more information, see \n Database Activity Streams\n in the Amazon Aurora User Guide.

" - } - }, - "com.amazonaws.rds#StopActivityStreamRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the DB cluster for the database activity stream.\n For example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.

", - "smithy.api#required": {} - } - }, - "ApplyImmediately": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

Specifies whether or not the database activity stream is to stop as soon as possible, \n regardless of the maintenance window for the database.

" - } - } - } - }, - "com.amazonaws.rds#StopActivityStreamResponse": { - "type": "structure", - "members": { - "KmsKeyId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

" - } - }, - "KinesisStreamName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Kinesis data stream used for the database activity stream.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#ActivityStreamStatus", - "traits": { - "smithy.api#documentation": "

The status of the database activity stream.

" - } - } - } - }, - "com.amazonaws.rds#StopDBCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#StopDBClusterMessage" - }, - "output": { - "target": "com.amazonaws.rds#StopDBClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBClusterNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's\n metadata, including its endpoints and DB parameter groups. Aurora also\n retains the transaction logs so you can do a point-in-time restore if necessary.

\n

For more information, see \n \n Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

\n \n

This action only applies to Aurora DB clusters.

\n " - } - }, - "com.amazonaws.rds#StopDBClusterMessage": { - "type": "structure", - "members": { - "DBClusterIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as\n a lowercase string.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.rds#StopDBClusterResult": { - "type": "structure", - "members": { - "DBCluster": { - "target": "com.amazonaws.rds#DBCluster" - } - } - }, - "com.amazonaws.rds#StopDBInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#StopDBInstanceMessage" - }, - "output": { - "target": "com.amazonaws.rds#StopDBInstanceResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#DBSnapshotAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBClusterStateFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - }, - { - "target": "com.amazonaws.rds#SnapshotQuotaExceededFault" - } - ], - "traits": { - "smithy.api#documentation": "

Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, \n DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if \n necessary.

\n

For more information, see \n \n Stopping an Amazon RDS DB Instance Temporarily in the \n Amazon RDS User Guide.\n

\n \n

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora clusters, use StopDBCluster instead.

\n " - } - }, - "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationMessage" - }, - "output": { - "target": "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Stops automated backup replication for a DB instance.

\n

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.

\n

For more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n

" - } - }, - "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationMessage": { - "type": "structure", - "members": { - "SourceDBInstanceArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source DB instance for which to stop replicating automated backups, for example, \n arn:aws:rds:us-west-2:123456789012:db:mydatabase.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationResult": { - "type": "structure", - "members": { - "DBInstanceAutomatedBackup": { - "target": "com.amazonaws.rds#DBInstanceAutomatedBackup" - } - } - }, - "com.amazonaws.rds#StopDBInstanceMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The user-supplied instance identifier.

", - "smithy.api#required": {} - } - }, - "DBSnapshotIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.

" - } - } - } - }, - "com.amazonaws.rds#StopDBInstanceResult": { - "type": "structure", - "members": { - "DBInstance": { - "target": "com.amazonaws.rds#DBInstance" - } - } - }, - "com.amazonaws.rds#StorageQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "StorageQuotaExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The request would result in the user exceeding the allowed amount of storage\n available across all DB instances.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#StorageTypeNotSupportedFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "StorageTypeNotSupported", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

Storage of the StorageType specified can't be associated\n with the DB instance.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#String": { - "type": "string" - }, - "com.amazonaws.rds#String255": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.rds#StringList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String" - } - }, - "com.amazonaws.rds#Subnet": { - "type": "structure", - "members": { - "SubnetIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the subnet.

" - } - }, - "SubnetAvailabilityZone": { - "target": "com.amazonaws.rds#AvailabilityZone" - }, - "SubnetOutpost": { - "target": "com.amazonaws.rds#Outpost", - "traits": { - "smithy.api#documentation": "

If the subnet is associated with an Outpost, this value specifies the Outpost.

\n

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.\n

" - } - }, - "SubnetStatus": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The status of the subnet.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element for the DescribeDBSubnetGroups operation.

" - } - }, - "com.amazonaws.rds#SubnetAlreadyInUse": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "SubnetAlreadyInUse", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The DB subnet is already in use in the Availability Zone.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#SubnetIdentifierList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#xmlName": "SubnetIdentifier" - } - } - }, - "com.amazonaws.rds#SubnetList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#Subnet", - "traits": { - "smithy.api#xmlName": "Subnet" - } - } - }, - "com.amazonaws.rds#SubscriptionAlreadyExistFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "SubscriptionAlreadyExist", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The supplied subscription name already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#SubscriptionCategoryNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "SubscriptionCategoryNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The supplied category does not exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#SubscriptionNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "SubscriptionNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

The subscription name does not exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.rds#SupportedCharacterSetsList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#CharacterSet", - "traits": { - "smithy.api#xmlName": "CharacterSet" - } - } - }, - "com.amazonaws.rds#SupportedTimezonesList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#Timezone", - "traits": { - "smithy.api#xmlName": "Timezone" - } - } - }, - "com.amazonaws.rds#SwitchoverBlueGreenDeployment": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#SwitchoverBlueGreenDeploymentRequest" - }, - "output": { - "target": "com.amazonaws.rds#SwitchoverBlueGreenDeploymentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rds#BlueGreenDeploymentNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidBlueGreenDeploymentStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Switches over a blue/green deployment.

\n

Before you switch over, production traffic is routed to the databases in the blue environment. \n After you switch over, production traffic is routed to the databases in the green environment.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

" - } - }, - "com.amazonaws.rds#SwitchoverBlueGreenDeploymentRequest": { - "type": "structure", - "members": { - "BlueGreenDeploymentIdentifier": { - "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", - "traits": { - "smithy.api#documentation": "

The blue/green deployment identifier.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - }, - "SwitchoverTimeout": { - "target": "com.amazonaws.rds#SwitchoverTimeout", - "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, for the switchover to complete. The default is 300.

\n

If the switchover takes longer than the specified duration, then any changes are rolled back, \n and no changes are made to the environments.

" - } - } - } - }, - "com.amazonaws.rds#SwitchoverBlueGreenDeploymentResponse": { - "type": "structure", - "members": { - "BlueGreenDeployment": { - "target": "com.amazonaws.rds#BlueGreenDeployment" - } - } - }, - "com.amazonaws.rds#SwitchoverDetail": { - "type": "structure", - "members": { - "SourceMember": { - "target": "com.amazonaws.rds#DatabaseArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a resource in the blue environment.

" - } - }, - "TargetMember": { - "target": "com.amazonaws.rds#DatabaseArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a resource in the green environment.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#SwitchoverDetailStatus", - "traits": { - "smithy.api#documentation": "

The switchover status of a resource in a blue/green deployment.

\n

Values:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details about a blue/green deployment.

\n

For more information, see Using Amazon RDS Blue/Green Deployments \n for database updates in the Amazon RDS User Guide and \n \n Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora \n User Guide.

" - } - }, - "com.amazonaws.rds#SwitchoverDetailList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#SwitchoverDetail" - } - }, - "com.amazonaws.rds#SwitchoverDetailStatus": { - "type": "string" - }, - "com.amazonaws.rds#SwitchoverReadReplica": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#SwitchoverReadReplicaMessage" - }, - "output": { - "target": "com.amazonaws.rds#SwitchoverReadReplicaResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#DBInstanceNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InvalidDBInstanceStateFault" - } - ], - "traits": { - "smithy.api#documentation": "

Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new\n primary database. Issue this command in the Region that hosts the current standby database.

" - } - }, - "com.amazonaws.rds#SwitchoverReadReplicaMessage": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The DB instance identifier of the current standby database. This value is stored as a lowercase string.

\n

Constraints:

\n ", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.rds#SwitchoverReadReplicaResult": { - "type": "structure", - "members": { - "DBInstance": { - "target": "com.amazonaws.rds#DBInstance" - } - } - }, - "com.amazonaws.rds#SwitchoverTimeout": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 30 - } - } - }, - "com.amazonaws.rds#TStamp": { - "type": "timestamp" - }, - "com.amazonaws.rds#Tag": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").

" - } - }, - "Value": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$\").

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

\n

For more information, see Tagging \n Amazon RDS Resources in the Amazon RDS User Guide.\n

" - } - }, - "com.amazonaws.rds#TagList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#Tag", - "traits": { - "smithy.api#xmlName": "Tag" - } - }, - "traits": { - "smithy.api#documentation": "

A list of tags.\n For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.\n

" - } - }, - "com.amazonaws.rds#TagListMessage": { - "type": "structure", - "members": { - "TagList": { - "target": "com.amazonaws.rds#TagList", - "traits": { - "smithy.api#documentation": "

List of tags returned by the ListTagsForResource operation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

" - } - }, - "com.amazonaws.rds#TargetDBClusterParameterGroupName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[A-Za-z](?!.*--)[0-9A-Za-z-]*[^-]|^default(?!.*--)(?!.*\\.\\.)[0-9A-Za-z-.]*[^-]$" - } - }, - "com.amazonaws.rds#TargetDBParameterGroupName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[A-Za-z](?!.*--)[0-9A-Za-z-]*[^-]|^default(?!.*--)(?!.*\\.\\.)[0-9A-Za-z-.]*[^-]$" - } - }, - "com.amazonaws.rds#TargetEngineVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[0-9A-Za-z-_.]+$" - } - }, - "com.amazonaws.rds#TargetGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBProxyTargetGroup" - } - }, - "com.amazonaws.rds#TargetHealth": { - "type": "structure", - "members": { - "State": { - "target": "com.amazonaws.rds#TargetState", - "traits": { - "smithy.api#documentation": "

The current state of the connection health lifecycle for the RDS Proxy target.\n The following is a typical lifecycle example for the states of an RDS Proxy target:

\n

\n registering > unavailable > available > unavailable > available\n

" - } - }, - "Reason": { - "target": "com.amazonaws.rds#TargetHealthReason", - "traits": { - "smithy.api#documentation": "

The reason for the current health State of the RDS Proxy target.

" - } - }, - "Description": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A description of the health of the RDS Proxy target. \n If the State is AVAILABLE, a description is not included.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the connection health of an RDS Proxy target.

" - } - }, - "com.amazonaws.rds#TargetHealthReason": { - "type": "enum", - "members": { - "UNREACHABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNREACHABLE" - } - }, - "CONNECTION_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONNECTION_FAILED" - } - }, - "AUTH_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTH_FAILURE" - } - }, - "PENDING_PROXY_CAPACITY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_PROXY_CAPACITY" - } - }, - "INVALID_REPLICATION_STATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INVALID_REPLICATION_STATE" - } - } - } - }, - "com.amazonaws.rds#TargetList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#DBProxyTarget" - } - }, - "com.amazonaws.rds#TargetRole": { - "type": "enum", - "members": { - "READ_WRITE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READ_WRITE" - } - }, - "READ_ONLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READ_ONLY" - } - }, - "UNKNOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNKNOWN" - } - } - } - }, - "com.amazonaws.rds#TargetState": { - "type": "enum", - "members": { - "registering": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REGISTERING" - } - }, - "available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVAILABLE" - } - }, - "unavailable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNAVAILABLE" - } - } - } - }, - "com.amazonaws.rds#TargetType": { - "type": "enum", - "members": { - "RDS_INSTANCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RDS_INSTANCE" - } - }, - "RDS_SERVERLESS_ENDPOINT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RDS_SERVERLESS_ENDPOINT" - } - }, - "TRACKED_CLUSTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TRACKED_CLUSTER" - } - } - } - }, - "com.amazonaws.rds#Timezone": { - "type": "structure", - "members": { - "TimezoneName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the time zone.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A time zone associated with a \n DBInstance \n or a DBSnapshot.\n This data type is an element in the response to \n the DescribeDBInstances, \n the DescribeDBSnapshots,\n and the DescribeDBEngineVersions\n actions.

" - } - }, - "com.amazonaws.rds#UpgradeTarget": { - "type": "structure", - "members": { - "Engine": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the upgrade target database engine.

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version number of the upgrade target database engine.

" - } - }, - "Description": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version of the database engine that a DB instance can be upgraded to.

" - } - }, - "AutoUpgrade": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

" - } - }, - "IsMajorVersionUpgrade": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether upgrading to the target version requires upgrading the major version of the database engine.

" - } - }, - "SupportedEngineModes": { - "target": "com.amazonaws.rds#EngineModeList", - "traits": { - "smithy.api#documentation": "

A list of the supported DB engine modes for the target engine version.

" - } - }, - "SupportsParallelQuery": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether you can use Aurora parallel query with the target engine version.

" - } - }, - "SupportsGlobalDatabases": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether you can use Aurora global databases with the target engine version.

" - } - }, - "SupportsBabelfish": { - "target": "com.amazonaws.rds#BooleanOptional", - "traits": { - "smithy.api#documentation": "

A value that indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The version of the database engine that a DB instance can be upgraded to.

" - } - }, - "com.amazonaws.rds#UserAuthConfig": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A user-specified description about the authentication used by a proxy to log in as a specific database user.

" - } - }, - "UserName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the database user to which the proxy connects.

" - } - }, - "AuthScheme": { - "target": "com.amazonaws.rds#AuthScheme", - "traits": { - "smithy.api#documentation": "

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

" - } - }, - "SecretArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate\n to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

" - } - }, - "IAMAuth": { - "target": "com.amazonaws.rds#IAMAuthMode", - "traits": { - "smithy.api#documentation": "

Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. \n The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

" - } - }, - "ClientPasswordAuthType": { - "target": "com.amazonaws.rds#ClientPasswordAuthType", - "traits": { - "smithy.api#documentation": "

The type of authentication the proxy uses for connections from clients.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the details of authentication used by a proxy to log in as a specific database user.

" - } - }, - "com.amazonaws.rds#UserAuthConfigInfo": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

A user-specified description about the authentication used by a proxy to log in as a specific database user.

" - } - }, - "UserName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the database user to which the proxy connects.

" - } - }, - "AuthScheme": { - "target": "com.amazonaws.rds#AuthScheme", - "traits": { - "smithy.api#documentation": "

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

" - } - }, - "SecretArn": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate\n to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.

" - } - }, - "IAMAuth": { - "target": "com.amazonaws.rds#IAMAuthMode", - "traits": { - "smithy.api#documentation": "

Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. \n The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

" - } - }, - "ClientPasswordAuthType": { - "target": "com.amazonaws.rds#ClientPasswordAuthType", - "traits": { - "smithy.api#documentation": "

The type of authentication the proxy uses for connections from clients.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Returns the details of authentication used by a proxy to log in as a specific database user.

" - } - }, - "com.amazonaws.rds#UserAuthConfigInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#UserAuthConfigInfo" - } - }, - "com.amazonaws.rds#UserAuthConfigList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#UserAuthConfig" - } - }, - "com.amazonaws.rds#ValidDBInstanceModificationsMessage": { - "type": "structure", - "members": { - "Storage": { - "target": "com.amazonaws.rds#ValidStorageOptionsList", - "traits": { - "smithy.api#documentation": "

Valid storage options for your DB instance.

" - } - }, - "ValidProcessorFeatures": { - "target": "com.amazonaws.rds#AvailableProcessorFeatureList", - "traits": { - "smithy.api#documentation": "

Valid processor features for your DB instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about valid modifications that you can make to your DB instance.\n Contains the result of a successful call to the \n DescribeValidDBInstanceModifications action.\n You can use this information when you call\n ModifyDBInstance.

" - } - }, - "com.amazonaws.rds#ValidStorageOptions": { - "type": "structure", - "members": { - "StorageType": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The valid storage types for your DB instance.\n For example: gp2, gp3, io1.

" - } - }, - "StorageSize": { - "target": "com.amazonaws.rds#RangeList", - "traits": { - "smithy.api#documentation": "

The valid range of storage in gibibytes (GiB).\n For example, 100 to 16,384.

" - } - }, - "ProvisionedIops": { - "target": "com.amazonaws.rds#RangeList", - "traits": { - "smithy.api#documentation": "

The valid range of provisioned IOPS.\n For example, 1000-256,000.

" - } - }, - "IopsToStorageRatio": { - "target": "com.amazonaws.rds#DoubleRangeList", - "traits": { - "smithy.api#documentation": "

The valid range of Provisioned IOPS to gibibytes of storage multiplier.\n For example, 3-10,\n which means that provisioned IOPS can be between 3 and 10 times storage.

" - } - }, - "SupportsStorageAutoscaling": { - "target": "com.amazonaws.rds#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.

" - } - }, - "ProvisionedStorageThroughput": { - "target": "com.amazonaws.rds#RangeList", - "traits": { - "smithy.api#documentation": "

The valid range of provisioned storage throughput. For example, \n 500-4,000 mebibytes per second (MiBps).

" - } - }, - "StorageThroughputToIopsRatio": { - "target": "com.amazonaws.rds#DoubleRangeList", - "traits": { - "smithy.api#documentation": "

The valid range of storage throughput to provisioned IOPS ratios. For example, \n 0-0.25.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about valid modifications that you can make to your DB instance.\n Contains the result of a successful call to the \n DescribeValidDBInstanceModifications action.

" - } - }, - "com.amazonaws.rds#ValidStorageOptionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#ValidStorageOptions", - "traits": { - "smithy.api#xmlName": "ValidStorageOptions" - } - } - }, - "com.amazonaws.rds#ValidUpgradeTargetList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#UpgradeTarget", - "traits": { - "smithy.api#xmlName": "UpgradeTarget" - } - } - }, - "com.amazonaws.rds#VpcSecurityGroupIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#xmlName": "VpcSecurityGroupId" - } - } - }, - "com.amazonaws.rds#VpcSecurityGroupMembership": { - "type": "structure", - "members": { - "VpcSecurityGroupId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the VPC security group.

" - } - }, - "Status": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The membership status of the VPC security group.

\n

Currently, the only valid status is active.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This data type is used as a response element for queries on VPC security group membership.

" - } - }, - "com.amazonaws.rds#VpcSecurityGroupMembershipList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#VpcSecurityGroupMembership", - "traits": { - "smithy.api#xmlName": "VpcSecurityGroupMembership" - } - } - }, - "com.amazonaws.rds#WriteForwardingStatus": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabled" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabled" - } - }, - "ENABLING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabling" - } - }, - "DISABLING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabling" - } - }, - "UNKNOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unknown" - } + "com.amazonaws.rds#WriteForwardingStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "ENABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabling" + } + }, + "DISABLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabling" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknown" + } + } + } } - } } - } }