get_latest_configuration¶
Operation¶
async
¶
get_latest_configuration(input: GetLatestConfigurationInput, plugins: list[Plugin] | None = None) -> GetLatestConfigurationOutput
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.
Warning
Note the following important information.
-
Each configuration token is only valid for one call to
GetLatestConfiguration. TheGetLatestConfigurationresponse includes aNextPollConfigurationTokenthat should always replace the token used for the just-completed call in preparation for the next one. -
GetLatestConfigurationis a priced call. For more information, see Pricing.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetLatestConfigurationInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
GetLatestConfigurationOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for GetLatestConfigurationInput structure.
Attributes¶
class-attribute
instance-attribute
¶
configuration_token: str | None = ...
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.
Warning
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for GetLatestConfigurationOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
configuration: bytes | None = ...
The data of the configuration. This may be empty if the client already has the latest version of configuration.
class-attribute
instance-attribute
¶
content_type: str | None = ...
A standard MIME type describing the format of the configuration content.
class-attribute
instance-attribute
¶
next_poll_configuration_token: str | None = ...
The latest token describing the current state of the configuration
session. This must be provided to the next call to
GetLatestConfiguration.
Warning
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.
class-attribute
instance-attribute
¶
next_poll_interval_in_seconds: int = ...
The amount of time the client should wait before polling for
configuration updates again. Use RequiredMinimumPollIntervalInSeconds
to set the desired poll interval.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
class-attribute
instance-attribute
¶
version_label: str | None = ...
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.