AWS AppConfig Data

Starts a configuration session used to retrieve a deployed configuration. See the GetLatestConfiguration API for more details.

See also: AWS API Documentation

Request Syntax

client.start_configuration_session(
    ApplicationIdentifier='string',
    ConfigurationProfileIdentifier='string',
    EnvironmentIdentifier='string',
    RequiredMinimumPollIntervalInSeconds=123
)

type ApplicationIdentifier:

string

param ApplicationIdentifier:

[REQUIRED]

The application ID or the application name.

type ConfigurationProfileIdentifier:

string

param ConfigurationProfileIdentifier:

[REQUIRED]

The configuration profile ID or the configuration profile name.

type EnvironmentIdentifier:

string

param EnvironmentIdentifier:

[REQUIRED]

The environment ID or the environment name.

type RequiredMinimumPollIntervalInSeconds:

integer

param RequiredMinimumPollIntervalInSeconds:

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.

rtype:

dict

returns:

Response Syntax

{
    'InitialConfigurationToken': 'string'
}

Response Structure

• (dict) --

  Response parameters for the StartConfigurationSession API.

  • InitialConfigurationToken (string) --

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

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.

See also: AWS API Documentation

Request Syntax

client.get_latest_configuration(
    ConfigurationToken='string'
)

type ConfigurationToken:

string

param ConfigurationToken:

[REQUIRED]

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.

rtype:

dict

returns:

Response Syntax

{
    'Configuration': StreamingBody(),
    'ContentType': 'string',
    'NextPollConfigurationToken': 'string',
    'NextPollIntervalInSeconds': 123
}

Response Structure

• (dict) --

  Response parameters for the GetLatestConfiguration API

  • Configuration (:class:`.StreamingBody`) --

    The data of the configuration. Note that this may be empty if the client already has the latest version of configuration.

  • ContentType (string) --

    A standard MIME type describing the format of the configuration content.

  • NextPollConfigurationToken (string) --

    The latest token describing the current state of the configuration session. This MUST be provided to the next call to GetLatestConfiguration.

  • NextPollIntervalInSeconds (integer) --

    The amount of time the client should wait before polling for configuration updates again. See RequiredMinimumPollIntervalInSeconds to set the desired poll interval.