[ aws . appconfigdata ]

start-configuration-session

Description

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 Receiving the configuration in the AppConfig User Guide .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  start-configuration-session
--application-identifier <value>
--environment-identifier <value>
--configuration-profile-identifier <value>
[--required-minimum-poll-interval-in-seconds <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--application-identifier (string)

The application ID or the application name.

--environment-identifier (string)

The environment ID or the environment name.

--configuration-profile-identifier (string)

The configuration profile ID or the configuration profile name.

--required-minimum-poll-interval-in-seconds (integer)

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 then every 60 seconds.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

InitialConfigurationToken -> (string)

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 .