Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.ElasticBeanstalk.DescribeEnvironments

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns descriptions for existing environments.

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:

desEnvironmentIds - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
desEnvironmentNames - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
desNextToken - 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.
desVersionLabel - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
desMaxRecords - 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.
desApplicationName - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
desIncludedDeletedBackTo - If specified when IncludeDeleted is set to true , then environments deleted after this date are displayed.
desIncludeDeleted - Indicates whether to include deleted environments: true : Environments that have been deleted after IncludedDeletedBackTo are displayed. false : Do not include deleted environments.

data DescribeEnvironments Source #

Request to describe one or more environments.

See: describeEnvironments smart constructor.

Instances

Eq DescribeEnvironments Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironments Methods (==) :: DescribeEnvironments -> DescribeEnvironments -> Bool # (/=) :: DescribeEnvironments -> DescribeEnvironments -> Bool #
Data DescribeEnvironments Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironments Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeEnvironments -> c DescribeEnvironments # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeEnvironments # toConstr :: DescribeEnvironments -> Constr # dataTypeOf :: DescribeEnvironments -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeEnvironments) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeEnvironments) # gmapT :: (forall b. Data b => b -> b) -> DescribeEnvironments -> DescribeEnvironments # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEnvironments -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEnvironments -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeEnvironments -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeEnvironments -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeEnvironments -> m DescribeEnvironments # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEnvironments -> m DescribeEnvironments # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEnvironments -> m DescribeEnvironments #
Read DescribeEnvironments Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironments Methods readsPrec :: Int -> ReadS DescribeEnvironments # readList :: ReadS [DescribeEnvironments] # readPrec :: ReadPrec DescribeEnvironments # readListPrec :: ReadPrec [DescribeEnvironments] #
Show DescribeEnvironments Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironments Methods showsPrec :: Int -> DescribeEnvironments -> ShowS # show :: DescribeEnvironments -> String # showList :: [DescribeEnvironments] -> ShowS #
Generic DescribeEnvironments Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironments Associated Types type Rep DescribeEnvironments :: Type -> Type # Methods from :: DescribeEnvironments -> Rep DescribeEnvironments x # to :: Rep DescribeEnvironments x -> DescribeEnvironments #
Hashable DescribeEnvironments Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironments Methods hashWithSalt :: Int -> DescribeEnvironments -> Int # hash :: DescribeEnvironments -> Int #
AWSRequest DescribeEnvironments Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironments Associated Types type Rs DescribeEnvironments :: Type # Methods request :: DescribeEnvironments -> Request DescribeEnvironments # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribeEnvironments -> ClientResponse -> m (Response DescribeEnvironments) #
ToHeaders DescribeEnvironments Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironments Methods toHeaders :: DescribeEnvironments -> [Header] #
ToPath DescribeEnvironments Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironments Methods toPath :: DescribeEnvironments -> ByteString #
ToQuery DescribeEnvironments Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironments Methods toQuery :: DescribeEnvironments -> QueryString #
NFData DescribeEnvironments Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironments Methods rnf :: DescribeEnvironments -> () #
type Rep DescribeEnvironments Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironments type Rep DescribeEnvironments = D1 (MetaData "DescribeEnvironments" "Network.AWS.ElasticBeanstalk.DescribeEnvironments" "amazonka-elasticbeanstalk-1.6.1-3CoYM4SK8sc46jAbvlY69V" False) (C1 (MetaCons "DescribeEnvironments'" PrefixI True) (((S1 (MetaSel (Just "_desEnvironmentIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :: S1 (MetaSel (Just "_desEnvironmentNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 (MetaSel (Just "_desNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_desVersionLabel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_desMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :: S1 (MetaSel (Just "_desApplicationName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_desIncludedDeletedBackTo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 (MetaSel (Just "_desIncludeDeleted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))))
type Rs DescribeEnvironments Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.DescribeEnvironments type Rs DescribeEnvironments = EnvironmentDescriptionsMessage

Request Lenses

desEnvironmentIds :: Lens' DescribeEnvironments [Text] Source #

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

desEnvironmentNames :: Lens' DescribeEnvironments [Text] Source #

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

desNextToken :: 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.

desVersionLabel :: 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.

desMaxRecords :: 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.

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

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

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

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

desIncludeDeleted :: 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

environmentDescriptionsMessage :: EnvironmentDescriptionsMessage Source #

Creates a value of EnvironmentDescriptionsMessage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

edmNextToken - In a paginated request, the token that you can pass in a subsequent request to get the next response page.
edmEnvironments - Returns an EnvironmentDescription list.

data EnvironmentDescriptionsMessage Source #

Result message containing a list of environment descriptions.

See: environmentDescriptionsMessage smart constructor.

Instances

Eq EnvironmentDescriptionsMessage Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.Types.Product Methods (==) :: EnvironmentDescriptionsMessage -> EnvironmentDescriptionsMessage -> Bool # (/=) :: EnvironmentDescriptionsMessage -> EnvironmentDescriptionsMessage -> Bool #
Data EnvironmentDescriptionsMessage Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EnvironmentDescriptionsMessage -> c EnvironmentDescriptionsMessage # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EnvironmentDescriptionsMessage # toConstr :: EnvironmentDescriptionsMessage -> Constr # dataTypeOf :: EnvironmentDescriptionsMessage -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c EnvironmentDescriptionsMessage) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EnvironmentDescriptionsMessage) # gmapT :: (forall b. Data b => b -> b) -> EnvironmentDescriptionsMessage -> EnvironmentDescriptionsMessage # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EnvironmentDescriptionsMessage -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EnvironmentDescriptionsMessage -> r # gmapQ :: (forall d. Data d => d -> u) -> EnvironmentDescriptionsMessage -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> EnvironmentDescriptionsMessage -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> EnvironmentDescriptionsMessage -> m EnvironmentDescriptionsMessage # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EnvironmentDescriptionsMessage -> m EnvironmentDescriptionsMessage # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EnvironmentDescriptionsMessage -> m EnvironmentDescriptionsMessage #
Read EnvironmentDescriptionsMessage Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.Types.Product Methods readsPrec :: Int -> ReadS EnvironmentDescriptionsMessage # readList :: ReadS [EnvironmentDescriptionsMessage] # readPrec :: ReadPrec EnvironmentDescriptionsMessage # readListPrec :: ReadPrec [EnvironmentDescriptionsMessage] #
Show EnvironmentDescriptionsMessage Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.Types.Product Methods showsPrec :: Int -> EnvironmentDescriptionsMessage -> ShowS # show :: EnvironmentDescriptionsMessage -> String # showList :: [EnvironmentDescriptionsMessage] -> ShowS #
Generic EnvironmentDescriptionsMessage Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.Types.Product Associated Types type Rep EnvironmentDescriptionsMessage :: Type -> Type # Methods from :: EnvironmentDescriptionsMessage -> Rep EnvironmentDescriptionsMessage x # to :: Rep EnvironmentDescriptionsMessage x -> EnvironmentDescriptionsMessage #
Hashable EnvironmentDescriptionsMessage Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.Types.Product Methods hashWithSalt :: Int -> EnvironmentDescriptionsMessage -> Int # hash :: EnvironmentDescriptionsMessage -> Int #
FromXML EnvironmentDescriptionsMessage Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.Types.Product Methods parseXML :: [Node] -> Either String EnvironmentDescriptionsMessage #
NFData EnvironmentDescriptionsMessage Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.Types.Product Methods rnf :: EnvironmentDescriptionsMessage -> () #
type Rep EnvironmentDescriptionsMessage Source #
Instance details Defined in Network.AWS.ElasticBeanstalk.Types.Product type Rep EnvironmentDescriptionsMessage = D1 (MetaData "EnvironmentDescriptionsMessage" "Network.AWS.ElasticBeanstalk.Types.Product" "amazonka-elasticbeanstalk-1.6.1-3CoYM4SK8sc46jAbvlY69V" False) (C1 (MetaCons "EnvironmentDescriptionsMessage'" PrefixI True) (S1 (MetaSel (Just "_edmNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_edmEnvironments") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [EnvironmentDescription]))))

Response Lenses

edmNextToken :: 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.

edmEnvironments :: Lens' EnvironmentDescriptionsMessage [EnvironmentDescription] Source #

Returns an EnvironmentDescription list.