Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ElasticBeanstalk.DescribeEnvironments

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns descriptions for existing environments.

This operation returns paginated results.

Synopsis

data DescribeEnvironments = DescribeEnvironments' {
- applicationName :: Maybe Text
- environmentIds :: Maybe [Text]
- environmentNames :: Maybe [Text]
- includeDeleted :: Maybe Bool
- includedDeletedBackTo :: Maybe ISO8601
- maxRecords :: Maybe Natural
- nextToken :: Maybe Text
- versionLabel :: Maybe Text
}
newDescribeEnvironments :: DescribeEnvironments
describeEnvironments_applicationName :: Lens' DescribeEnvironments (Maybe Text)
describeEnvironments_environmentIds :: Lens' DescribeEnvironments (Maybe [Text])
describeEnvironments_environmentNames :: Lens' DescribeEnvironments (Maybe [Text])
describeEnvironments_includeDeleted :: Lens' DescribeEnvironments (Maybe Bool)
describeEnvironments_includedDeletedBackTo :: Lens' DescribeEnvironments (Maybe UTCTime)
describeEnvironments_maxRecords :: Lens' DescribeEnvironments (Maybe Natural)
describeEnvironments_nextToken :: Lens' DescribeEnvironments (Maybe Text)
describeEnvironments_versionLabel :: Lens' DescribeEnvironments (Maybe Text)
data EnvironmentDescriptionsMessage = EnvironmentDescriptionsMessage' {
- environments :: Maybe [EnvironmentDescription]
- nextToken :: Maybe Text
}
newEnvironmentDescriptionsMessage :: EnvironmentDescriptionsMessage
environmentDescriptionsMessage_environments :: Lens' EnvironmentDescriptionsMessage (Maybe [EnvironmentDescription])
environmentDescriptionsMessage_nextToken :: Lens' EnvironmentDescriptionsMessage (Maybe Text)

Creating a Request

data DescribeEnvironments Source #

Request to describe one or more environments.

See: newDescribeEnvironments smart constructor.

Constructors

DescribeEnvironments'

Fields

applicationName :: Maybe Text
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
environmentIds :: Maybe [Text]
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
environmentNames :: Maybe [Text]
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
includeDeleted :: Maybe Bool
Indicates whether to include deleted environments:
true: Environments that have been deleted after IncludedDeletedBackTo are displayed.
false: Do not include deleted environments.
includedDeletedBackTo :: Maybe ISO8601
If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.
maxRecords :: Maybe Natural
For a paginated request. Specify a maximum number of environments to include in each response.
If no MaxRecords is specified, all available environments are retrieved in a single response.
nextToken :: Maybe Text
For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.
If no NextToken is specified, the first page is retrieved.
versionLabel :: Maybe Text
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

Instances

Instances details

ToHeaders DescribeEnvironments Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironments Methods toHeaders :: DescribeEnvironments -> [Header] #
ToPath DescribeEnvironments Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironments Methods toPath :: DescribeEnvironments -> ByteString #
ToQuery DescribeEnvironments Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironments Methods toQuery :: DescribeEnvironments -> QueryString #
AWSPager DescribeEnvironments Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironments Methods page :: DescribeEnvironments -> AWSResponse DescribeEnvironments -> Maybe DescribeEnvironments #
AWSRequest DescribeEnvironments Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironments Associated Types type AWSResponse DescribeEnvironments # Methods request :: (Service -> Service) -> DescribeEnvironments -> Request DescribeEnvironments # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeEnvironments -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEnvironments))) #
Generic DescribeEnvironments Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironments Associated Types type Rep DescribeEnvironments :: Type -> Type # Methods from :: DescribeEnvironments -> Rep DescribeEnvironments x # to :: Rep DescribeEnvironments x -> DescribeEnvironments #
Read DescribeEnvironments Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironments Methods readsPrec :: Int -> ReadS DescribeEnvironments # readList :: ReadS [DescribeEnvironments] # readPrec :: ReadPrec DescribeEnvironments # readListPrec :: ReadPrec [DescribeEnvironments] #
Show DescribeEnvironments Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironments Methods showsPrec :: Int -> DescribeEnvironments -> ShowS # show :: DescribeEnvironments -> String # showList :: [DescribeEnvironments] -> ShowS #
NFData DescribeEnvironments Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironments Methods rnf :: DescribeEnvironments -> () #
Eq DescribeEnvironments Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironments Methods (==) :: DescribeEnvironments -> DescribeEnvironments -> Bool # (/=) :: DescribeEnvironments -> DescribeEnvironments -> Bool #
Hashable DescribeEnvironments Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironments Methods hashWithSalt :: Int -> DescribeEnvironments -> Int # hash :: DescribeEnvironments -> Int #
type AWSResponse DescribeEnvironments Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironments type AWSResponse DescribeEnvironments = EnvironmentDescriptionsMessage
type Rep DescribeEnvironments Source #
Instance details Defined in Amazonka.ElasticBeanstalk.DescribeEnvironments type Rep DescribeEnvironments = D1 ('MetaData "DescribeEnvironments" "Amazonka.ElasticBeanstalk.DescribeEnvironments" "amazonka-elasticbeanstalk-2.0-HLGGuY0kjXTIKSbM7JuMHy" 'False) (C1 ('MetaCons "DescribeEnvironments'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "applicationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "environmentIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "environmentNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "includeDeleted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "includedDeletedBackTo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "versionLabel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDescribeEnvironments :: DescribeEnvironments Source #

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

DescribeEnvironments, describeEnvironments_applicationName - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

$sel:environmentIds:DescribeEnvironments', describeEnvironments_environmentIds - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

$sel:environmentNames:DescribeEnvironments', describeEnvironments_environmentNames - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

$sel:includeDeleted:DescribeEnvironments', describeEnvironments_includeDeleted - Indicates whether to include deleted environments:

true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

false: Do not include deleted environments.

$sel:includedDeletedBackTo:DescribeEnvironments', describeEnvironments_includedDeletedBackTo - If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

$sel:maxRecords:DescribeEnvironments', describeEnvironments_maxRecords - For a paginated request. Specify a maximum number of environments to include in each response.

If no MaxRecords is specified, all available environments are retrieved in a single response.

DescribeEnvironments, describeEnvironments_nextToken - For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

If no NextToken is specified, the first page is retrieved.

DescribeEnvironments, describeEnvironments_versionLabel - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

Request Lenses

describeEnvironments_applicationName :: Lens' DescribeEnvironments (Maybe Text) Source #

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

describeEnvironments_environmentIds :: Lens' DescribeEnvironments (Maybe [Text]) Source #

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

describeEnvironments_environmentNames :: Lens' DescribeEnvironments (Maybe [Text]) Source #

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

describeEnvironments_includeDeleted :: Lens' DescribeEnvironments (Maybe Bool) Source #

Indicates whether to include deleted environments:

true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

false: Do not include deleted environments.

describeEnvironments_includedDeletedBackTo :: Lens' DescribeEnvironments (Maybe UTCTime) Source #

If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

describeEnvironments_maxRecords :: Lens' DescribeEnvironments (Maybe Natural) Source #

For a paginated request. Specify a maximum number of environments to include in each response.

If no MaxRecords is specified, all available environments are retrieved in a single response.

describeEnvironments_nextToken :: Lens' DescribeEnvironments (Maybe Text) Source #

For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

If no NextToken is specified, the first page is retrieved.

describeEnvironments_versionLabel :: Lens' DescribeEnvironments (Maybe Text) Source #

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

Destructuring the Response

data EnvironmentDescriptionsMessage Source #

Result message containing a list of environment descriptions.

See: newEnvironmentDescriptionsMessage smart constructor.

Constructors

EnvironmentDescriptionsMessage'
Fields environments :: Maybe [EnvironmentDescription] Returns an EnvironmentDescription list. nextToken :: Maybe Text In a paginated request, the token that you can pass in a subsequent request to get the next response page.

Instances

Instances details

FromXML EnvironmentDescriptionsMessage Source #
Instance details Defined in Amazonka.ElasticBeanstalk.Types.EnvironmentDescriptionsMessage Methods parseXML :: [Node] -> Either String EnvironmentDescriptionsMessage #
Generic EnvironmentDescriptionsMessage Source #
Instance details Defined in Amazonka.ElasticBeanstalk.Types.EnvironmentDescriptionsMessage Associated Types type Rep EnvironmentDescriptionsMessage :: Type -> Type # Methods from :: EnvironmentDescriptionsMessage -> Rep EnvironmentDescriptionsMessage x # to :: Rep EnvironmentDescriptionsMessage x -> EnvironmentDescriptionsMessage #
Read EnvironmentDescriptionsMessage Source #
Instance details Defined in Amazonka.ElasticBeanstalk.Types.EnvironmentDescriptionsMessage Methods readsPrec :: Int -> ReadS EnvironmentDescriptionsMessage # readList :: ReadS [EnvironmentDescriptionsMessage] # readPrec :: ReadPrec EnvironmentDescriptionsMessage # readListPrec :: ReadPrec [EnvironmentDescriptionsMessage] #
Show EnvironmentDescriptionsMessage Source #
Instance details Defined in Amazonka.ElasticBeanstalk.Types.EnvironmentDescriptionsMessage Methods showsPrec :: Int -> EnvironmentDescriptionsMessage -> ShowS # show :: EnvironmentDescriptionsMessage -> String # showList :: [EnvironmentDescriptionsMessage] -> ShowS #
NFData EnvironmentDescriptionsMessage Source #
Instance details Defined in Amazonka.ElasticBeanstalk.Types.EnvironmentDescriptionsMessage Methods rnf :: EnvironmentDescriptionsMessage -> () #
Eq EnvironmentDescriptionsMessage Source #
Instance details Defined in Amazonka.ElasticBeanstalk.Types.EnvironmentDescriptionsMessage Methods (==) :: EnvironmentDescriptionsMessage -> EnvironmentDescriptionsMessage -> Bool # (/=) :: EnvironmentDescriptionsMessage -> EnvironmentDescriptionsMessage -> Bool #
Hashable EnvironmentDescriptionsMessage Source #
Instance details Defined in Amazonka.ElasticBeanstalk.Types.EnvironmentDescriptionsMessage Methods hashWithSalt :: Int -> EnvironmentDescriptionsMessage -> Int # hash :: EnvironmentDescriptionsMessage -> Int #
type Rep EnvironmentDescriptionsMessage Source #
Instance details Defined in Amazonka.ElasticBeanstalk.Types.EnvironmentDescriptionsMessage type Rep EnvironmentDescriptionsMessage = D1 ('MetaData "EnvironmentDescriptionsMessage" "Amazonka.ElasticBeanstalk.Types.EnvironmentDescriptionsMessage" "amazonka-elasticbeanstalk-2.0-HLGGuY0kjXTIKSbM7JuMHy" 'False) (C1 ('MetaCons "EnvironmentDescriptionsMessage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "environments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EnvironmentDescription])) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newEnvironmentDescriptionsMessage :: EnvironmentDescriptionsMessage Source #

Create a value of EnvironmentDescriptionsMessage 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:environments:EnvironmentDescriptionsMessage', environmentDescriptionsMessage_environments - Returns an EnvironmentDescription list.

$sel:nextToken:EnvironmentDescriptionsMessage', environmentDescriptionsMessage_nextToken - In a paginated request, the token that you can pass in a subsequent request to get the next response page.

Response Lenses

environmentDescriptionsMessage_environments :: Lens' EnvironmentDescriptionsMessage (Maybe [EnvironmentDescription]) Source #

Returns an EnvironmentDescription list.

environmentDescriptionsMessage_nextToken :: Lens' EnvironmentDescriptionsMessage (Maybe Text) Source #

In a paginated request, the token that you can pass in a subsequent request to get the next response page.