StartConfigurationSession
Starts a configuration session used to retrieve a deployed configuration. For more information about this API action and to view example Amazon CLI commands that show how to use it with the GetLatestConfiguration API action, see Retrieving feature flags and configuration data in Amazon AppConfig in the Amazon 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 128.
Required: Yes
- ConfigurationProfileIdentifier
-
The configuration profile ID or the configuration profile name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
- EnvironmentIdentifier
-
The environment ID or the environment name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
- RequiredMinimumPollIntervalInSeconds
-
(Optional) 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.
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 theGetLatestConfiguration
response (NextPollConfigurationToken
) in each subsequent call toGetLatestConfiguration
. If there is no change to a configuration, the token doesn't return the Amazon AppConfig configuration profile.The
InitialConfigurationToken
andNextPollConfigurationToken
should only be used once. To support long poll use cases, the tokens are valid for up to 24 hours. If aGetLatestConfiguration
call uses an expired token, the system returnsBadRequestException
.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
Examples
Example
This example illustrates one usage of StartConfigurationSession.
Sample Request
POST /configurationsessions HTTP/1.1
Host: appconfigdata.us-west-1.amazonaws.com
Accept-Encoding: identity
Content-Type: application/json
User-Agent: aws-cli/2.4.15 Python/3.8.8 Windows/10 exe/AMD64 prompt/off command/appconfigdata.start-configuration-session
X-Amz-Date: 20220218T190442Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220218/us-west-1/appconfig/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 141
{"ApplicationIdentifier": "MyMobileApp", "ConfigurationProfileIdentifier": "MyAccessListFlag", "EnvironmentIdentifier": "MyMobileAppProdEnv"}
Sample Response
{
"InitialConfigurationToken": "AYADeNgfsRxdKiJ37A12OZ9vN2cAXwABABVhd3MtY3J5cHRvLXB1YmxpYy1rZXkAREF1RzlLMTg1Tkx2Wjk4OGV2UXkyQ1UxV2ZxaGJTdkt2MkprKzJ4TlY2VkM0ZDVoRzBvbXFBTnFHcXpXcjU0dUM3Zz09AAEAB2F3cy1rbXMAS2Fybjphd3M6a21zOnVzLXdlc3QtMTo4MzIyNzQ3ODA3Mzc6a2V5LzA4MGYxYWI3LTNjNmYtNGE1Yi04ZTg2LWE2MjdmNWJiMmRlMQC4AQIBAHiWVBJIpqEFGgjvLHxtJImRmyljpZnxt7FfxeEOE5H8xQF1SfOlWZFnHujbzJmIvNeSAAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQM0iTa25yw3uwnO6+rAgEQgDvLYYILWH/x3SKKgyW1nOeBtS6go21vVPA6b8/woFpxhzwjxy80jOfkVC2lM2l626BnJCvSPFfuZvcz/QIAAAAADAAAEAAAAAAAAAAAAAAAAADpQpWKSwnomgzEkYmidGKJ/////wAAAAEAAAAAAAAAAAAAAAEAAAD8yfxkWB0geYfyI+DNJGiryebhmEoi8S8UHZSNN5JjJzTN2iORkjrA3DVvnhBTfoPh7o5bl4jwSYa/6as+muQ9ntjYwymTZu7inYhsICYUKEDFxonBFJaEC32jEfg/MbPaGLOhNHdISiPAlMlOYmsw7phgl6ldbs9qrKVLlk1WNO3XTJiXyaWY4ANMfAX2JgMbGvNNY3HbfUneDGOENg6IfwKDykELIrJ6feE0JyKOV7mXfp/0r2pNiW9d6q+WDD1w4T87gCxgUGEPB/J7JG3RhpGvECUmgKA0T06MjA7kWdt2IofDaLzRppFGpgLoPmxpM4qHz/w6dMDmeXybKNZP84UP12zsJtUMhuspEQBnMGUCMQD8ssc6G8e6u8nov1ZdgF4m1ad3qyjiFd9DNRZHgLRFpw7+QIO/RB1l/IExP2ftUlkCMBT9oNlClJg4l9uGW5/qAiJ5n9ivK0ElRMwpvx96damGxt125XtMkmYf6a0OWSqnBw=="
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: