StartConfigurationSession - AWS AppConfig

StartConfigurationSession

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

Request Syntax

POST /configurationsessions HTTP/1.1 Content-type: application/json { "ApplicationIdentifier": "string", "ConfigurationProfileIdentifier": "string", "EnvironmentIdentifier": "string", "RequiredMinimumPollIntervalInSeconds": number }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ApplicationIdentifier

The application ID or the application name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

ConfigurationProfileIdentifier

The configuration profile ID or the configuration profile name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

EnvironmentIdentifier

The environment ID or the environment name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

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 then every 60 seconds.

Type: Integer

Valid Range: Minimum value of 15. Maximum value of 86400.

Required: No

Response Syntax

HTTP/1.1 201 Content-type: application/json { "InitialConfigurationToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

InitialConfigurationToken

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

Important

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.

Type: String

Pattern: \S{1,8192}

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

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

HTTP Status Code: 400

InternalServerException

There was an internal failure in the service.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource could not be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: