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 |
Returns descriptions for existing environments.
This operation returns paginated results.
Synopsis
- data DescribeEnvironments = DescribeEnvironments' {}
- 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' {}
- 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.
DescribeEnvironments' | |
|
Instances
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.
EnvironmentDescriptionsMessage' | |
|
Instances
FromXML EnvironmentDescriptionsMessage Source # | |
Generic EnvironmentDescriptionsMessage Source # | |
Read EnvironmentDescriptionsMessage Source # | |
Show EnvironmentDescriptionsMessage Source # | |
NFData EnvironmentDescriptionsMessage Source # | |
Eq EnvironmentDescriptionsMessage Source # | |
Hashable EnvironmentDescriptionsMessage Source # | |
type Rep EnvironmentDescriptionsMessage Source # | |
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.