AWS AppConfig Data 2021-11-11
- Client: Aws\AppConfigData\AppConfigDataClient
- Service ID: appconfigdata
- Version: 2021-11-11
This page describes the parameters and results for the operations of the AWS AppConfig Data (2021-11-11), and shows how to use the Aws\AppConfigData\AppConfigDataClient object to call the described operations. This documentation is specific to the 2021-11-11 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- GetLatestConfiguration ( array $params = [] )
Retrieves the latest deployed configuration.
- StartConfigurationSession ( array $params = [] )
Starts a configuration session used to retrieve a deployed configuration.
Operations
GetLatestConfiguration
$result = $client->getLatestConfiguration([/* ... */]); $promise = $client->getLatestConfigurationAsync([/* ... */]);
Retrieves the latest deployed configuration. This API may return empty Configuration data if the client already has the latest version. See StartConfigurationSession to obtain an InitialConfigurationToken to call this API.
Each call to GetLatestConfiguration returns a new ConfigurationToken (NextPollConfigurationToken in the response). This new token MUST be provided to the next call to GetLatestConfiguration when polling for configuration updates.
To avoid excess charges, we recommend that you include the ClientConfigurationVersion value with every call to GetConfiguration. This value must be saved on your client. Subsequent calls to GetConfiguration must pass this value by using the ClientConfigurationVersion parameter.
Parameter Syntax
$result = $client->getLatestConfiguration([
'ConfigurationToken' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ConfigurationToken
-
- Required: Yes
- Type: string
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.
Result Syntax
[
'Configuration' => <string || resource || Psr\Http\Message\StreamInterface>,
'ContentType' => '<string>',
'NextPollConfigurationToken' => '<string>',
'NextPollIntervalInSeconds' => <integer>,
]
Result Details
Members
- Configuration
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The data of the configuration. Note that this may be empty if the client already has the latest version of configuration.
- ContentType
-
- Type: string
A standard MIME type describing the format of the configuration content.
- NextPollConfigurationToken
-
- Type: string
The latest token describing the current state of the configuration session. This MUST be provided to the next call to GetLatestConfiguration.
- NextPollIntervalInSeconds
-
- Type: int
The amount of time the client should wait before polling for configuration updates again. See RequiredMinimumPollIntervalInSeconds to set the desired poll interval.
Errors
-
The request was denied due to request throttling.
-
The requested resource could not be found.
-
The input fails to satisfy the constraints specified by the service.
-
There was an internal failure in the service.
StartConfigurationSession
$result = $client->startConfigurationSession([/* ... */]); $promise = $client->startConfigurationSessionAsync([/* ... */]);
Starts a configuration session used to retrieve a deployed configuration. See the GetLatestConfiguration API for more details.
Parameter Syntax
$result = $client->startConfigurationSession([
'ApplicationIdentifier' => '<string>', // REQUIRED
'ConfigurationProfileIdentifier' => '<string>', // REQUIRED
'EnvironmentIdentifier' => '<string>', // REQUIRED
'RequiredMinimumPollIntervalInSeconds' => <integer>,
]);
Parameter Details
Members
- ApplicationIdentifier
-
- Required: Yes
- Type: string
The application ID or the application name.
- ConfigurationProfileIdentifier
-
- Required: Yes
- Type: string
The configuration profile ID or the configuration profile name.
- EnvironmentIdentifier
-
- Required: Yes
- Type: string
The environment ID or the environment name.
- RequiredMinimumPollIntervalInSeconds
-
- Type: int
The interval at which your client will poll for configuration. If provided, the service will throw a BadRequestException if the client polls before the specified poll interval. By default, client poll intervals are not enforced.
Result Syntax
[
'InitialConfigurationToken' => '<string>',
]
Result Details
Members
- InitialConfigurationToken
-
- Type: string
Token encapsulating state about the configuration session. Provide this token to the GetLatestConfiguration API to retrieve configuration data.
This token should only be used once in your first call to GetLatestConfiguration. You MUST use the new token in the GetConfiguration response (NextPollConfigurationToken) in each subsequent call to GetLatestConfiguration.
Errors
-
The request was denied due to request throttling.
-
The requested resource could not be found.
-
The input fails to satisfy the constraints specified by the service.
-
There was an internal failure in the service.
Shapes
BadRequestDetails
Description
Details describing why the request was invalid
Members
- InvalidParameters
-
- Type: Associative array of custom strings keys (String) to InvalidParameterDetail structures
Present if the Reason for the bad request was 'InvalidParameters'
BadRequestException
Description
The input fails to satisfy the constraints specified by the service.
Members
- Details
-
- Type: BadRequestDetails structure
Details describing why the request was invalid
- Message
-
- Type: string
- Reason
-
- Type: string
Code indicating the reason the request was invalid.
InternalServerException
InvalidParameterDetail
Description
Contains details about an invalid parameter.
Members
ResourceNotFoundException
Description
The requested resource could not be found.