start_configuration_session¶
Operation¶
async
¶
start_configuration_session(input: StartConfigurationSessionInput, plugins: list[Plugin] | None = None) -> StartConfigurationSessionOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
StartConfigurationSessionInput
|
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 |
|---|---|
StartConfigurationSessionOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for StartConfigurationSessionInput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_identifier: str | None = ...
The application ID or the application name.
class-attribute
instance-attribute
¶
configuration_profile_identifier: str | None = ...
The configuration profile ID or the configuration profile name.
class-attribute
instance-attribute
¶
environment_identifier: str | None = ...
The environment ID or the environment name.
class-attribute
instance-attribute
¶
required_minimum_poll_interval_in_seconds: int | None = ...
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for StartConfigurationSessionOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
initial_configuration_token: str | None = ...
Token encapsulating state about the configuration session. Provide this
token to the GetLatestConfiguration API to retrieve configuration
data.
Warning
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.
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.
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.