'2.0', 'service' => '

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

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

When calling StartConfigurationSession, your code sends the following information:

Identifiers (ID or name) of an AppConfig application, environment, and configuration profile that the session tracks.
(Optional) The minimum amount of time the session\'s client must wait between calls to GetLatestConfiguration.

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

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

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

NextPollConfigurationToken: the ConfigurationToken value to use on the next call to GetLatestConfiguration.
NextPollIntervalInSeconds: the duration the client should wait before making its next call to GetLatestConfiguration. This duration may vary over the course of the session, so it should be used instead of the value sent on the StartConfigurationSession call.
The configuration: the latest data intended for the session. This may be empty if the client already has the latest version of the configuration.

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

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

', 'operations' => [ 'GetLatestConfiguration' => '

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

Note the following important information.

Each configuration token is only valid for one call to GetLatestConfiguration. The GetLatestConfiguration response includes a NextPollConfigurationToken that should always replace the token used for the just-completed call in preparation for the next one.
GetLatestConfiguration is a priced call. For more information, see Pricing.

', 'StartConfigurationSession' => '

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

', ], 'shapes' => [ 'BadRequestDetails' => [ 'base' => '

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

', 'refs' => [ 'BadRequestException$Details' => '

Details describing why the request was invalid.

', ], ], 'BadRequestException' => [ 'base' => '

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

', 'refs' => [], ], 'BadRequestReason' => [ 'base' => NULL, 'refs' => [ 'BadRequestException$Reason' => '

Code indicating the reason the request was invalid.

', ], ], 'GetLatestConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLatestConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'Identifier' => [ 'base' => NULL, 'refs' => [ 'StartConfigurationSessionRequest$ApplicationIdentifier' => '

The application ID or the application name.

', 'StartConfigurationSessionRequest$EnvironmentIdentifier' => '

The environment ID or the environment name.

', 'StartConfigurationSessionRequest$ConfigurationProfileIdentifier' => '

The configuration profile ID or the configuration profile name.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'GetLatestConfigurationResponse$NextPollIntervalInSeconds' => '

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

', ], ], 'InternalServerException' => [ 'base' => '

There was an internal failure in the service.

', 'refs' => [], ], 'InvalidParameterDetail' => [ 'base' => '

Information about an invalid parameter.

', 'refs' => [ 'InvalidParameterMap$value' => NULL, ], ], 'InvalidParameterMap' => [ 'base' => NULL, 'refs' => [ 'BadRequestDetails$InvalidParameters' => '

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

', ], ], 'InvalidParameterProblem' => [ 'base' => NULL, 'refs' => [ 'InvalidParameterDetail$Problem' => '

The reason the parameter is invalid.

', ], ], 'OptionalPollSeconds' => [ 'base' => NULL, 'refs' => [ 'StartConfigurationSessionRequest$RequiredMinimumPollIntervalInSeconds' => '

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

', ], ], 'ResourceNotFoundException' => [ 'base' => '

The requested resource could not be found.

', 'refs' => [], ], 'ResourceType' => [ 'base' => NULL, 'refs' => [ 'ResourceNotFoundException$ResourceType' => '

The type of resource that was not found.

', ], ], 'SensitiveBlob' => [ 'base' => NULL, 'refs' => [ 'GetLatestConfigurationResponse$Configuration' => '

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

', ], ], 'StartConfigurationSessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartConfigurationSessionResponse' => [ 'base' => NULL, 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'BadRequestException$Message' => NULL, 'GetLatestConfigurationResponse$ContentType' => '

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

', 'GetLatestConfigurationResponse$VersionLabel' => '

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.

', 'InternalServerException$Message' => NULL, 'InvalidParameterMap$key' => NULL, 'ResourceNotFoundException$Message' => NULL, 'StringMap$key' => NULL, 'StringMap$value' => NULL, 'ThrottlingException$Message' => NULL, ], ], 'StringMap' => [ 'base' => NULL, 'refs' => [ 'ResourceNotFoundException$ReferencedBy' => '

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

', ], ], 'ThrottlingException' => [ 'base' => '

The request was denied due to request throttling.

', 'refs' => [], ], 'Token' => [ 'base' => NULL, 'refs' => [ 'GetLatestConfigurationRequest$ConfigurationToken' => '

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

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

', 'GetLatestConfigurationResponse$NextPollConfigurationToken' => '

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

', 'StartConfigurationSessionResponse$InitialConfigurationToken' => '

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

', ], ], ],];