Amazonka.AppConfigData.StartConfigurationSession

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.

Creating a Request

data StartConfigurationSession

See: newStartConfigurationSession smart constructor.

Constructors

StartConfigurationSession'

Fields

• requiredMinimumPollIntervalInSeconds :: Maybe Natural

  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.

• applicationIdentifier :: Text

  The application ID or the application name.

• environmentIdentifier :: Text

  The environment ID or the environment name.

• configurationProfileIdentifier :: Text

  The configuration profile ID or the configuration profile name.

Instances

ToJSON StartConfigurationSession

Defined in Amazonka.AppConfigData.StartConfigurationSession

Methods

toJSON :: StartConfigurationSession -> Value

toEncoding :: StartConfigurationSession -> Encoding

toJSONList :: [StartConfigurationSession] -> Value

toEncodingList :: [StartConfigurationSession] -> Encoding

ToHeaders StartConfigurationSession

Defined in Amazonka.AppConfigData.StartConfigurationSession

Methods

toHeaders :: StartConfigurationSession -> [Header]

ToPath StartConfigurationSession

Defined in Amazonka.AppConfigData.StartConfigurationSession

Methods

toPath :: StartConfigurationSession -> ByteString

ToQuery StartConfigurationSession

Defined in Amazonka.AppConfigData.StartConfigurationSession

Methods

toQuery :: StartConfigurationSession -> QueryString

AWSRequest StartConfigurationSession

Defined in Amazonka.AppConfigData.StartConfigurationSession

Associated Types

type AWSResponse StartConfigurationSession

Methods

request :: (Service -> Service) -> StartConfigurationSession -> Request StartConfigurationSession

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartConfigurationSession -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartConfigurationSession)))

Generic StartConfigurationSession

Defined in Amazonka.AppConfigData.StartConfigurationSession

Associated Types

type Rep StartConfigurationSession :: Type -> Type

Methods

from :: StartConfigurationSession -> Rep StartConfigurationSession x

to :: Rep StartConfigurationSession x -> StartConfigurationSession

Read StartConfigurationSession

Defined in Amazonka.AppConfigData.StartConfigurationSession

Methods

readsPrec :: Int -> ReadS StartConfigurationSession

readList :: ReadS [StartConfigurationSession]

readPrec :: ReadPrec StartConfigurationSession

readListPrec :: ReadPrec [StartConfigurationSession]

Show StartConfigurationSession

Defined in Amazonka.AppConfigData.StartConfigurationSession

Methods

showsPrec :: Int -> StartConfigurationSession -> ShowS

show :: StartConfigurationSession -> String

showList :: [StartConfigurationSession] -> ShowS

NFData StartConfigurationSession

Defined in Amazonka.AppConfigData.StartConfigurationSession

Methods

rnf :: StartConfigurationSession -> ()

Eq StartConfigurationSession

Defined in Amazonka.AppConfigData.StartConfigurationSession

Methods

(==) :: StartConfigurationSession -> StartConfigurationSession -> Bool

(/=) :: StartConfigurationSession -> StartConfigurationSession -> Bool

Hashable StartConfigurationSession

Defined in Amazonka.AppConfigData.StartConfigurationSession

Methods

hashWithSalt :: Int -> StartConfigurationSession -> Int

hash :: StartConfigurationSession -> Int

type AWSResponse StartConfigurationSession

Defined in Amazonka.AppConfigData.StartConfigurationSession

type AWSResponse StartConfigurationSession = StartConfigurationSessionResponse

type Rep StartConfigurationSession

Defined in Amazonka.AppConfigData.StartConfigurationSession

type Rep StartConfigurationSession = D1 ('MetaData "StartConfigurationSession" "Amazonka.AppConfigData.StartConfigurationSession" "amazonka-appconfigdata-2.0-4fFb59kQbZiI7zoxAdQXfi" 'False) (C1 ('MetaCons "StartConfigurationSession'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "requiredMinimumPollIntervalInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "applicationIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "environmentIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "configurationProfileIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newStartConfigurationSession

Arguments

:: Text

$sel:applicationIdentifier:StartConfigurationSession'

-> Text

$sel:environmentIdentifier:StartConfigurationSession'

-> Text

$sel:configurationProfileIdentifier:StartConfigurationSession'

-> StartConfigurationSession

Create a value of StartConfigurationSession with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:requiredMinimumPollIntervalInSeconds:StartConfigurationSession', startConfigurationSession_requiredMinimumPollIntervalInSeconds - 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.

$sel:applicationIdentifier:StartConfigurationSession', startConfigurationSession_applicationIdentifier - The application ID or the application name.

$sel:environmentIdentifier:StartConfigurationSession', startConfigurationSession_environmentIdentifier - The environment ID or the environment name.

$sel:configurationProfileIdentifier:StartConfigurationSession', startConfigurationSession_configurationProfileIdentifier - The configuration profile ID or the configuration profile name.

Request Lenses

startConfigurationSession_requiredMinimumPollIntervalInSeconds :: Lens' StartConfigurationSession (Maybe Natural)

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.

startConfigurationSession_applicationIdentifier :: Lens' StartConfigurationSession Text

The application ID or the application name.

startConfigurationSession_environmentIdentifier :: Lens' StartConfigurationSession Text

The environment ID or the environment name.

startConfigurationSession_configurationProfileIdentifier :: Lens' StartConfigurationSession Text

The configuration profile ID or the configuration profile name.

Destructuring the Response

data StartConfigurationSessionResponse

See: newStartConfigurationSessionResponse smart constructor.

Constructors

StartConfigurationSessionResponse'

Fields

• initialConfigurationToken :: Maybe Text

  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 GetLatestConfiguration response (NextPollConfigurationToken) in each subsequent call to GetLatestConfiguration.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartConfigurationSessionResponse

Defined in Amazonka.AppConfigData.StartConfigurationSession

Associated Types

type Rep StartConfigurationSessionResponse :: Type -> Type

Methods

from :: StartConfigurationSessionResponse -> Rep StartConfigurationSessionResponse x

to :: Rep StartConfigurationSessionResponse x -> StartConfigurationSessionResponse

Read StartConfigurationSessionResponse

Defined in Amazonka.AppConfigData.StartConfigurationSession

Methods

readsPrec :: Int -> ReadS StartConfigurationSessionResponse

readList :: ReadS [StartConfigurationSessionResponse]

readPrec :: ReadPrec StartConfigurationSessionResponse

readListPrec :: ReadPrec [StartConfigurationSessionResponse]

Show StartConfigurationSessionResponse

Defined in Amazonka.AppConfigData.StartConfigurationSession

Methods

showsPrec :: Int -> StartConfigurationSessionResponse -> ShowS

show :: StartConfigurationSessionResponse -> String

showList :: [StartConfigurationSessionResponse] -> ShowS

NFData StartConfigurationSessionResponse

Defined in Amazonka.AppConfigData.StartConfigurationSession

Methods

rnf :: StartConfigurationSessionResponse -> ()

Eq StartConfigurationSessionResponse

Defined in Amazonka.AppConfigData.StartConfigurationSession

Methods

(==) :: StartConfigurationSessionResponse -> StartConfigurationSessionResponse -> Bool

(/=) :: StartConfigurationSessionResponse -> StartConfigurationSessionResponse -> Bool

type Rep StartConfigurationSessionResponse

Defined in Amazonka.AppConfigData.StartConfigurationSession

type Rep StartConfigurationSessionResponse = D1 ('MetaData "StartConfigurationSessionResponse" "Amazonka.AppConfigData.StartConfigurationSession" "amazonka-appconfigdata-2.0-4fFb59kQbZiI7zoxAdQXfi" 'False) (C1 ('MetaCons "StartConfigurationSessionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "initialConfigurationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartConfigurationSessionResponse

Arguments

:: Int

$sel:httpStatus:StartConfigurationSessionResponse'

-> StartConfigurationSessionResponse

Create a value of StartConfigurationSessionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:initialConfigurationToken:StartConfigurationSessionResponse', startConfigurationSessionResponse_initialConfigurationToken - 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 GetLatestConfiguration response (NextPollConfigurationToken) in each subsequent call to GetLatestConfiguration.

$sel:httpStatus:StartConfigurationSessionResponse', startConfigurationSessionResponse_httpStatus - The response's http status code.

Response Lenses

startConfigurationSessionResponse_initialConfigurationToken :: Lens' StartConfigurationSessionResponse (Maybe Text)

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 GetLatestConfiguration response (NextPollConfigurationToken) in each subsequent call to GetLatestConfiguration.

startConfigurationSessionResponse_httpStatus :: Lens' StartConfigurationSessionResponse Int

The response's http status code.