| Copyright | (c) 2013-2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.ElasticBeanstalk.DescribeEnvironments
Description
Returns descriptions for existing environments.
See: AWS API Reference for DescribeEnvironments.
- describeEnvironments :: DescribeEnvironments
- data DescribeEnvironments
- dEnvironmentIds :: Lens' DescribeEnvironments [Text]
- dEnvironmentNames :: Lens' DescribeEnvironments [Text]
- dVersionLabel :: Lens' DescribeEnvironments (Maybe Text)
- dApplicationName :: Lens' DescribeEnvironments (Maybe Text)
- dIncludedDeletedBackTo :: Lens' DescribeEnvironments (Maybe UTCTime)
- dIncludeDeleted :: Lens' DescribeEnvironments (Maybe Bool)
- describeEnvironmentsResponse :: Int -> DescribeEnvironmentsResponse
- data DescribeEnvironmentsResponse
- drsEnvironments :: Lens' DescribeEnvironmentsResponse [EnvironmentDescription]
- drsResponseStatus :: Lens' DescribeEnvironmentsResponse Int
Creating a Request
describeEnvironments :: DescribeEnvironments Source
Creates a value of DescribeEnvironments with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeEnvironments Source
This documentation target is not reported in the API reference.
See: describeEnvironments smart constructor.
Instances
Request Lenses
dEnvironmentIds :: Lens' DescribeEnvironments [Text] Source
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
dEnvironmentNames :: Lens' DescribeEnvironments [Text] Source
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
dVersionLabel :: 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.
dApplicationName :: Lens' DescribeEnvironments (Maybe Text) Source
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
dIncludedDeletedBackTo :: Lens' DescribeEnvironments (Maybe UTCTime) Source
If specified when IncludeDeleted is set to true, then environments
deleted after this date are displayed.
dIncludeDeleted :: 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.
Destructuring the Response
describeEnvironmentsResponse Source
Arguments
| :: Int | |
| -> DescribeEnvironmentsResponse |
Creates a value of DescribeEnvironmentsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeEnvironmentsResponse Source
Result message containing a list of environment descriptions.
See: describeEnvironmentsResponse smart constructor.
Response Lenses
drsEnvironments :: Lens' DescribeEnvironmentsResponse [EnvironmentDescription] Source
Returns an EnvironmentDescription list.
drsResponseStatus :: Lens' DescribeEnvironmentsResponse Int Source
The response status code.