Amazonka.ElasticBeanstalk.DescribeConfigurationSettings

Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.

When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.

Related Topics

• DeleteEnvironmentConfiguration

Creating a Request

data DescribeConfigurationSettings

Result message containing all of the configuration settings for a specified solution stack or configuration template.

See: newDescribeConfigurationSettings smart constructor.

Constructors

DescribeConfigurationSettings'

Fields

• environmentName :: Maybe Text

  The name of the environment to describe.

  Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

• templateName :: Maybe Text

  The name of the configuration template to describe.

  Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

• applicationName :: Text

  The application for the environment or configuration template.

Instances

ToHeaders DescribeConfigurationSettings

Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationSettings

Methods

toHeaders :: DescribeConfigurationSettings -> [Header]

ToPath DescribeConfigurationSettings

Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationSettings

Methods

toPath :: DescribeConfigurationSettings -> ByteString

ToQuery DescribeConfigurationSettings

Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationSettings

Methods

toQuery :: DescribeConfigurationSettings -> QueryString

AWSRequest DescribeConfigurationSettings

Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationSettings

Associated Types

type AWSResponse DescribeConfigurationSettings

Methods

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

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

Generic DescribeConfigurationSettings

Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationSettings

Associated Types

type Rep DescribeConfigurationSettings :: Type -> Type

Methods

from :: DescribeConfigurationSettings -> Rep DescribeConfigurationSettings x

to :: Rep DescribeConfigurationSettings x -> DescribeConfigurationSettings

Read DescribeConfigurationSettings

Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationSettings

Methods

readsPrec :: Int -> ReadS DescribeConfigurationSettings

readList :: ReadS [DescribeConfigurationSettings]

readPrec :: ReadPrec DescribeConfigurationSettings

readListPrec :: ReadPrec [DescribeConfigurationSettings]

Show DescribeConfigurationSettings

Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationSettings

Methods

showsPrec :: Int -> DescribeConfigurationSettings -> ShowS

show :: DescribeConfigurationSettings -> String

showList :: [DescribeConfigurationSettings] -> ShowS

NFData DescribeConfigurationSettings

Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationSettings

Methods

rnf :: DescribeConfigurationSettings -> ()

Eq DescribeConfigurationSettings

Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationSettings

Methods

(==) :: DescribeConfigurationSettings -> DescribeConfigurationSettings -> Bool

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

Hashable DescribeConfigurationSettings

Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationSettings

Methods

hashWithSalt :: Int -> DescribeConfigurationSettings -> Int

hash :: DescribeConfigurationSettings -> Int

type AWSResponse DescribeConfigurationSettings

Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationSettings

type AWSResponse DescribeConfigurationSettings = DescribeConfigurationSettingsResponse

type Rep DescribeConfigurationSettings

Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationSettings

type Rep DescribeConfigurationSettings = D1 ('MetaData "DescribeConfigurationSettings" "Amazonka.ElasticBeanstalk.DescribeConfigurationSettings" "amazonka-elasticbeanstalk-2.0-HLGGuY0kjXTIKSbM7JuMHy" 'False) (C1 ('MetaCons "DescribeConfigurationSettings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "environmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "applicationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeConfigurationSettings

Arguments

:: Text

DescribeConfigurationSettings

-> DescribeConfigurationSettings

Create a value of DescribeConfigurationSettings 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:

DescribeConfigurationSettings, describeConfigurationSettings_environmentName - The name of the environment to describe.

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

DescribeConfigurationSettings, describeConfigurationSettings_templateName - The name of the configuration template to describe.

Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

DescribeConfigurationSettings, describeConfigurationSettings_applicationName - The application for the environment or configuration template.

Request Lenses

describeConfigurationSettings_environmentName :: Lens' DescribeConfigurationSettings (Maybe Text)

The name of the environment to describe.

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

describeConfigurationSettings_templateName :: Lens' DescribeConfigurationSettings (Maybe Text)

The name of the configuration template to describe.

Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

describeConfigurationSettings_applicationName :: Lens' DescribeConfigurationSettings Text

The application for the environment or configuration template.

Destructuring the Response

data DescribeConfigurationSettingsResponse

The results from a request to change the configuration settings of an environment.

See: newDescribeConfigurationSettingsResponse smart constructor.

Constructors

DescribeConfigurationSettingsResponse'

Fields

• configurationSettings :: Maybe [ConfigurationSettingsDescription]

  A list of ConfigurationSettingsDescription.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeConfigurationSettingsResponse

Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationSettings

Associated Types

type Rep DescribeConfigurationSettingsResponse :: Type -> Type

Methods

from :: DescribeConfigurationSettingsResponse -> Rep DescribeConfigurationSettingsResponse x

to :: Rep DescribeConfigurationSettingsResponse x -> DescribeConfigurationSettingsResponse

Read DescribeConfigurationSettingsResponse

Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationSettings

Methods

readsPrec :: Int -> ReadS DescribeConfigurationSettingsResponse

readList :: ReadS [DescribeConfigurationSettingsResponse]

readPrec :: ReadPrec DescribeConfigurationSettingsResponse

readListPrec :: ReadPrec [DescribeConfigurationSettingsResponse]

Show DescribeConfigurationSettingsResponse

Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationSettings

Methods

showsPrec :: Int -> DescribeConfigurationSettingsResponse -> ShowS

show :: DescribeConfigurationSettingsResponse -> String

showList :: [DescribeConfigurationSettingsResponse] -> ShowS

NFData DescribeConfigurationSettingsResponse

Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationSettings

Methods

rnf :: DescribeConfigurationSettingsResponse -> ()

Eq DescribeConfigurationSettingsResponse

Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationSettings

Methods

(==) :: DescribeConfigurationSettingsResponse -> DescribeConfigurationSettingsResponse -> Bool

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

type Rep DescribeConfigurationSettingsResponse

Defined in Amazonka.ElasticBeanstalk.DescribeConfigurationSettings

type Rep DescribeConfigurationSettingsResponse = D1 ('MetaData "DescribeConfigurationSettingsResponse" "Amazonka.ElasticBeanstalk.DescribeConfigurationSettings" "amazonka-elasticbeanstalk-2.0-HLGGuY0kjXTIKSbM7JuMHy" 'False) (C1 ('MetaCons "DescribeConfigurationSettingsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "configurationSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ConfigurationSettingsDescription])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeConfigurationSettingsResponse

Arguments

:: Int

$sel:httpStatus:DescribeConfigurationSettingsResponse'

-> DescribeConfigurationSettingsResponse

Create a value of DescribeConfigurationSettingsResponse 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:configurationSettings:DescribeConfigurationSettingsResponse', describeConfigurationSettingsResponse_configurationSettings - A list of ConfigurationSettingsDescription.

$sel:httpStatus:DescribeConfigurationSettingsResponse', describeConfigurationSettingsResponse_httpStatus - The response's http status code.

Response Lenses

describeConfigurationSettingsResponse_configurationSettings :: Lens' DescribeConfigurationSettingsResponse (Maybe [ConfigurationSettingsDescription])

A list of ConfigurationSettingsDescription.

describeConfigurationSettingsResponse_httpStatus :: Lens' DescribeConfigurationSettingsResponse Int

The response's http status code.