{ "smithy": "2.0", "shapes": { "com.amazonaws.appconfigdata#AppConfigData": { "type": "service", "version": "2021-11-11", "operations": [ { "target": "com.amazonaws.appconfigdata#GetLatestConfiguration" } ], "resources": [ { "target": "com.amazonaws.appconfigdata#ConfigurationSession" } ], "traits": { "aws.api#dataPlane": {}, "aws.api#service": { "sdkId": "AppConfigData", "arnNamespace": "appconfigdata", "cloudFormationName": "AppConfigData", "cloudTrailEventSource": "appconfigdata.amazonaws.com", "endpointPrefix": "appconfigdata" }, "aws.auth#sigv4": { "name": "appconfig" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "

AppConfig Data provides the data plane APIs your application uses to retrieve\n configuration data. Here's how it works:

\n

Your application retrieves configuration data by first establishing a configuration\n session using the AppConfig Data StartConfigurationSession API action.\n Your session's client then makes periodic calls to GetLatestConfiguration\n to check for and retrieve the latest data available.

\n

When calling StartConfigurationSession, your code sends the following\n information:

\n \n

In response, AppConfig provides an InitialConfigurationToken to be given to\n the session's client and used the first time it calls GetLatestConfiguration\n for that session.

\n \n

This token should only be used once in your first call to\n GetLatestConfiguration. You must use the new token\n in the GetLatestConfiguration response\n (NextPollConfigurationToken) in each subsequent call to\n GetLatestConfiguration.

\n
\n

When calling GetLatestConfiguration, your client code sends the most recent\n ConfigurationToken value it has and receives in response:

\n \n \n

The InitialConfigurationToken and\n NextPollConfigurationToken should only be used once. To support long poll\n use cases, the tokens are valid for up to 24 hours. If a\n GetLatestConfiguration call uses an expired token, the system returns\n BadRequestException.

\n
\n

For more information and to view example CLI commands that show how to retrieve a\n configuration using the AppConfig Data StartConfigurationSession and\n GetLatestConfiguration API actions, see Retrieving the\n configuration in the AppConfig User Guide.

", "smithy.api#title": "AWS AppConfig Data", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://appconfigdata-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://appconfigdata.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://appconfigdata-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://appconfigdata.{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://appconfigdata.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 14, "nodes": "/////wAAAAH/////AAAAAAAAAA0AAAADAAAAAQAAAAQF9eEMAAAAAgAAAAUF9eEMAAAAAwAAAAgAAAAGAAAABAAAAAcF9eELAAAABQX14QkF9eEKAAAABAAAAAsAAAAJAAAABgAAAAoF9eEIAAAABwX14QYF9eEHAAAABQAAAAwF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAAOAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://appconfigdata-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "endpoint": { "url": "https://appconfigdata.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://appconfigdata-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://appconfigdata.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://appconfigdata.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.af-south-1.amazonaws.com" } }, "params": { "Region": "af-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.ap-east-1.amazonaws.com" } }, "params": { "Region": "ap-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.ap-northeast-2.amazonaws.com" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.ap-northeast-3.amazonaws.com" } }, "params": { "Region": "ap-northeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.ap-south-1.amazonaws.com" } }, "params": { "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.ap-southeast-1.amazonaws.com" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.eu-north-1.amazonaws.com" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.eu-south-1.amazonaws.com" } }, "params": { "Region": "eu-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.eu-west-3.amazonaws.com" } }, "params": { "Region": "eu-west-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.me-south-1.amazonaws.com" } }, "params": { "Region": "me-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.sa-east-1.amazonaws.com" } }, "params": { "Region": "sa-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://appconfigdata-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata-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://appconfigdata.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://appconfigdata-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://appconfigdata.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://appconfigdata-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://appconfigdata.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.us-iso-west-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://appconfigdata.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.appconfigdata#BadRequestDetails": { "type": "union", "members": { "InvalidParameters": { "target": "com.amazonaws.appconfigdata#InvalidParameterMap", "traits": { "smithy.api#documentation": "

One or more specified parameters are not valid for the call.

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

Detailed information about the input that failed to satisfy the constraints specified by\n a call.

" } }, "com.amazonaws.appconfigdata#BadRequestException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.appconfigdata#String" }, "Reason": { "target": "com.amazonaws.appconfigdata#BadRequestReason", "traits": { "smithy.api#documentation": "

Code indicating the reason the request was invalid.

" } }, "Details": { "target": "com.amazonaws.appconfigdata#BadRequestDetails", "traits": { "smithy.api#documentation": "

Details describing why the request was invalid.

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

The input fails to satisfy the constraints specified by the service.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.appconfigdata#BadRequestReason": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "InvalidParameters", "name": "INVALID_PARAMETERS", "documentation": "Indicates there was a problem with one or more of the parameters.\nSee InvalidParameters in the BadRequestDetails for more information." } ] } }, "com.amazonaws.appconfigdata#ConfigurationSession": { "type": "resource", "identifiers": { "SessionId": { "target": "com.amazonaws.appconfigdata#Id" } }, "create": { "target": "com.amazonaws.appconfigdata#StartConfigurationSession" } }, "com.amazonaws.appconfigdata#GetLatestConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.appconfigdata#GetLatestConfigurationRequest" }, "output": { "target": "com.amazonaws.appconfigdata#GetLatestConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.appconfigdata#BadRequestException" }, { "target": "com.amazonaws.appconfigdata#InternalServerException" }, { "target": "com.amazonaws.appconfigdata#ResourceNotFoundException" }, { "target": "com.amazonaws.appconfigdata#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Retrieves the latest deployed configuration. This API may return empty configuration\n data if the client already has the latest version. For more information about this API\n action and to view example CLI commands that show how to use it with the StartConfigurationSession API action, see Retrieving the\n configuration in the AppConfig User Guide.

\n \n

Note the following important information.

\n \n
", "smithy.api#http": { "method": "GET", "uri": "/configuration", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.appconfigdata#GetLatestConfigurationRequest": { "type": "structure", "members": { "ConfigurationToken": { "target": "com.amazonaws.appconfigdata#Token", "traits": { "smithy.api#documentation": "

Token describing the current state of the configuration session. To obtain a token,\n first call the StartConfigurationSession API. Note that every call to\n GetLatestConfiguration will return a new ConfigurationToken\n (NextPollConfigurationToken in the response) and must\n be provided to subsequent GetLatestConfiguration API calls.

\n \n

This token should only be used once. To support long poll\n use cases, the token is valid for up to 24 hours. If a\n GetLatestConfiguration call uses an expired token, the system returns\n BadRequestException.

\n
", "smithy.api#httpQuery": "configuration_token", "smithy.api#required": {} } } } }, "com.amazonaws.appconfigdata#GetLatestConfigurationResponse": { "type": "structure", "members": { "NextPollConfigurationToken": { "target": "com.amazonaws.appconfigdata#Token", "traits": { "smithy.api#documentation": "

The latest token describing the current state of the configuration session. This\n must be provided to the next call to\n GetLatestConfiguration.\n

\n \n

This token should only be used once. To support long poll\n use cases, the token is valid for up to 24 hours. If a\n GetLatestConfiguration call uses an expired token, the system returns\n BadRequestException.

\n
", "smithy.api#httpHeader": "Next-Poll-Configuration-Token" } }, "NextPollIntervalInSeconds": { "target": "com.amazonaws.appconfigdata#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The amount of time the client should wait before polling for configuration updates\n again. Use RequiredMinimumPollIntervalInSeconds to set the desired poll\n interval.

", "smithy.api#httpHeader": "Next-Poll-Interval-In-Seconds" } }, "ContentType": { "target": "com.amazonaws.appconfigdata#String", "traits": { "smithy.api#documentation": "

A standard MIME type describing the format of the configuration content.

", "smithy.api#httpHeader": "Content-Type" } }, "Configuration": { "target": "com.amazonaws.appconfigdata#SensitiveBlob", "traits": { "smithy.api#documentation": "

The data of the configuration. This may be empty if the client already has the latest\n version of configuration.

", "smithy.api#httpPayload": {} } }, "VersionLabel": { "target": "com.amazonaws.appconfigdata#String", "traits": { "smithy.api#documentation": "

The user-defined label for the AppConfig hosted configuration version. This attribute doesn't apply if the configuration is not from an AppConfig hosted configuration version. If the client already has the latest version of the configuration data, this value is empty.

", "smithy.api#httpHeader": "Version-Label" } } } }, "com.amazonaws.appconfigdata#Id": { "type": "string", "traits": { "smithy.api#pattern": "^[a-z0-9]{7}$" } }, "com.amazonaws.appconfigdata#Identifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.appconfigdata#Integer": { "type": "integer", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.appconfigdata#InternalServerException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.appconfigdata#String" } }, "traits": { "smithy.api#documentation": "

There was an internal failure in the service.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.appconfigdata#InvalidParameterDetail": { "type": "structure", "members": { "Problem": { "target": "com.amazonaws.appconfigdata#InvalidParameterProblem", "traits": { "smithy.api#documentation": "

The reason the parameter is invalid.

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

Information about an invalid parameter.

" } }, "com.amazonaws.appconfigdata#InvalidParameterMap": { "type": "map", "key": { "target": "com.amazonaws.appconfigdata#String" }, "value": { "target": "com.amazonaws.appconfigdata#InvalidParameterDetail" } }, "com.amazonaws.appconfigdata#InvalidParameterProblem": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Corrupted", "name": "CORRUPTED", "documentation": "The parameter was corrupted and could not be understood by the service." }, { "value": "Expired", "name": "EXPIRED", "documentation": "The parameter was expired and can no longer be used." }, { "value": "PollIntervalNotSatisfied", "name": "POLL_INTERVAL_NOT_SATISFIED", "documentation": "The client called the service before the time specified in the poll interval." } ] } }, "com.amazonaws.appconfigdata#OptionalPollSeconds": { "type": "integer", "traits": { "smithy.api#range": { "min": 15, "max": 86400 } } }, "com.amazonaws.appconfigdata#ResourceNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.appconfigdata#String" }, "ResourceType": { "target": "com.amazonaws.appconfigdata#ResourceType", "traits": { "smithy.api#documentation": "

The type of resource that was not found.

" } }, "ReferencedBy": { "target": "com.amazonaws.appconfigdata#StringMap", "traits": { "smithy.api#documentation": "

A map indicating which parameters in the request reference the resource that was not\n found.

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

The requested resource could not be found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.appconfigdata#ResourceType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Application", "name": "APPLICATION", "documentation": "Resource type value for the Application resource." }, { "value": "ConfigurationProfile", "name": "CONFIGURATION_PROFILE", "documentation": "Resource type value for the ConfigurationProfile resource." }, { "value": "Deployment", "name": "DEPLOYMENT", "documentation": "Resource type value for the Deployment resource." }, { "value": "Environment", "name": "ENVIRONMENT", "documentation": "Resource type value for the Environment resource." }, { "value": "Configuration", "name": "CONFIGURATION", "documentation": "Resource type value for the Configuration resource." } ] } }, "com.amazonaws.appconfigdata#SensitiveBlob": { "type": "blob", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.appconfigdata#StartConfigurationSession": { "type": "operation", "input": { "target": "com.amazonaws.appconfigdata#StartConfigurationSessionRequest" }, "output": { "target": "com.amazonaws.appconfigdata#StartConfigurationSessionResponse" }, "errors": [ { "target": "com.amazonaws.appconfigdata#BadRequestException" }, { "target": "com.amazonaws.appconfigdata#InternalServerException" }, { "target": "com.amazonaws.appconfigdata#ResourceNotFoundException" }, { "target": "com.amazonaws.appconfigdata#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Starts a configuration session used to retrieve a deployed configuration. For more\n information about this API action and to view example CLI commands that show how to use\n it with the GetLatestConfiguration API action, see Retrieving the\n configuration in the AppConfig User Guide.

", "smithy.api#http": { "method": "POST", "uri": "/configurationsessions", "code": 201 } } }, "com.amazonaws.appconfigdata#StartConfigurationSessionRequest": { "type": "structure", "members": { "ApplicationIdentifier": { "target": "com.amazonaws.appconfigdata#Identifier", "traits": { "smithy.api#documentation": "

The application ID or the application name.

", "smithy.api#required": {} } }, "EnvironmentIdentifier": { "target": "com.amazonaws.appconfigdata#Identifier", "traits": { "smithy.api#documentation": "

The environment ID or the environment name.

", "smithy.api#required": {} } }, "ConfigurationProfileIdentifier": { "target": "com.amazonaws.appconfigdata#Identifier", "traits": { "smithy.api#documentation": "

The configuration profile ID or the configuration profile name.

", "smithy.api#required": {} } }, "RequiredMinimumPollIntervalInSeconds": { "target": "com.amazonaws.appconfigdata#OptionalPollSeconds", "traits": { "smithy.api#documentation": "

Sets a constraint on a session. If you specify a value of, for example, 60 seconds, then\n the client that established the session can't call GetLatestConfiguration\n more frequently than every 60 seconds.

" } } } }, "com.amazonaws.appconfigdata#StartConfigurationSessionResponse": { "type": "structure", "members": { "InitialConfigurationToken": { "target": "com.amazonaws.appconfigdata#Token", "traits": { "smithy.api#documentation": "

Token encapsulating state about the configuration session. Provide this token to the\n GetLatestConfiguration API to retrieve configuration data.

\n \n

This token should only be used once in your first call to\n GetLatestConfiguration. You must use the new token\n in the GetLatestConfiguration response\n (NextPollConfigurationToken) in each subsequent call to\n GetLatestConfiguration.

\n

The InitialConfigurationToken and\n NextPollConfigurationToken should only be used once. To support long poll\n use cases, the tokens are valid for up to 24 hours. If a\n GetLatestConfiguration call uses an expired token, the system returns\n BadRequestException.

\n
" } } } }, "com.amazonaws.appconfigdata#String": { "type": "string" }, "com.amazonaws.appconfigdata#StringMap": { "type": "map", "key": { "target": "com.amazonaws.appconfigdata#String" }, "value": { "target": "com.amazonaws.appconfigdata#String" } }, "com.amazonaws.appconfigdata#ThrottlingException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.appconfigdata#String" } }, "traits": { "smithy.api#documentation": "

The request was denied due to request throttling.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.appconfigdata#Token": { "type": "string", "traits": { "smithy.api#pattern": "^\\S{1,8192}$" } } } }