Network.AWS.ElasticBeanstalk.DescribeEnvironments

Returns descriptions for existing environments.

Creating a Request

describeEnvironments :: DescribeEnvironments

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

Request to describe one or more environments.

See: describeEnvironments smart constructor.

Instances

Eq DescribeEnvironments

Methods

(==) :: DescribeEnvironments -> DescribeEnvironments -> Bool

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

Data 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

Methods

readsPrec :: Int -> ReadS DescribeEnvironments

readList :: ReadS [DescribeEnvironments]

readPrec :: ReadPrec DescribeEnvironments

readListPrec :: ReadPrec [DescribeEnvironments]

Show DescribeEnvironments

Methods

showsPrec :: Int -> DescribeEnvironments -> ShowS

show :: DescribeEnvironments -> String

showList :: [DescribeEnvironments] -> ShowS

Generic DescribeEnvironments

Associated Types

type Rep DescribeEnvironments :: * -> *

Methods

from :: DescribeEnvironments -> Rep DescribeEnvironments x

to :: Rep DescribeEnvironments x -> DescribeEnvironments

Hashable DescribeEnvironments

Methods

hashWithSalt :: Int -> DescribeEnvironments -> Int

hash :: DescribeEnvironments -> Int

NFData DescribeEnvironments

Methods

rnf :: DescribeEnvironments -> ()

AWSRequest DescribeEnvironments

Associated Types

type Rs DescribeEnvironments :: *

Methods

request :: DescribeEnvironments -> Request DescribeEnvironments

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeEnvironments -> ClientResponse -> m (Response DescribeEnvironments)

ToHeaders DescribeEnvironments

Methods

toHeaders :: DescribeEnvironments -> [Header]

ToPath DescribeEnvironments

Methods

toPath :: DescribeEnvironments -> ByteString

ToQuery DescribeEnvironments

Methods

toQuery :: DescribeEnvironments -> QueryString

type Rep DescribeEnvironments

type Rep DescribeEnvironments = D1 * (MetaData "DescribeEnvironments" "Network.AWS.ElasticBeanstalk.DescribeEnvironments" "amazonka-elasticbeanstalk-1.6.0-4Kt4TpxAtj66tluiSbk4fC" False) (C1 * (MetaCons "DescribeEnvironments'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_desEnvironmentIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_desEnvironmentNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_desNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_desVersionLabel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_desMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) (S1 * (MetaSel (Just Symbol "_desApplicationName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_desIncludedDeletedBackTo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ISO8601))) (S1 * (MetaSel (Just Symbol "_desIncludeDeleted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))))))

type Rs DescribeEnvironments

type Rs DescribeEnvironments = EnvironmentDescriptionsMessage

Request Lenses

desEnvironmentIds :: Lens' DescribeEnvironments [Text]

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

desEnvironmentNames :: Lens' DescribeEnvironments [Text]

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

desNextToken :: Lens' DescribeEnvironments (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.

desVersionLabel :: Lens' DescribeEnvironments (Maybe Text)

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)

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)

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

desIncludedDeletedBackTo :: Lens' DescribeEnvironments (Maybe UTCTime)

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

desIncludeDeleted :: Lens' DescribeEnvironments (Maybe Bool)

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

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

Result message containing a list of environment descriptions.

See: environmentDescriptionsMessage smart constructor.

Instances

Eq EnvironmentDescriptionsMessage

Methods

(==) :: EnvironmentDescriptionsMessage -> EnvironmentDescriptionsMessage -> Bool

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

Data EnvironmentDescriptionsMessage

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

Methods

readsPrec :: Int -> ReadS EnvironmentDescriptionsMessage

readList :: ReadS [EnvironmentDescriptionsMessage]

readPrec :: ReadPrec EnvironmentDescriptionsMessage

readListPrec :: ReadPrec [EnvironmentDescriptionsMessage]

Show EnvironmentDescriptionsMessage

Methods

showsPrec :: Int -> EnvironmentDescriptionsMessage -> ShowS

show :: EnvironmentDescriptionsMessage -> String

showList :: [EnvironmentDescriptionsMessage] -> ShowS

Generic EnvironmentDescriptionsMessage

Associated Types

type Rep EnvironmentDescriptionsMessage :: * -> *

Methods

from :: EnvironmentDescriptionsMessage -> Rep EnvironmentDescriptionsMessage x

to :: Rep EnvironmentDescriptionsMessage x -> EnvironmentDescriptionsMessage

Hashable EnvironmentDescriptionsMessage

Methods

hashWithSalt :: Int -> EnvironmentDescriptionsMessage -> Int

hash :: EnvironmentDescriptionsMessage -> Int

NFData EnvironmentDescriptionsMessage

Methods

rnf :: EnvironmentDescriptionsMessage -> ()

FromXML EnvironmentDescriptionsMessage

Methods

parseXML :: [Node] -> Either String EnvironmentDescriptionsMessage

type Rep EnvironmentDescriptionsMessage

type Rep EnvironmentDescriptionsMessage = D1 * (MetaData "EnvironmentDescriptionsMessage" "Network.AWS.ElasticBeanstalk.Types.Product" "amazonka-elasticbeanstalk-1.6.0-4Kt4TpxAtj66tluiSbk4fC" False) (C1 * (MetaCons "EnvironmentDescriptionsMessage'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_edmNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_edmEnvironments") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [EnvironmentDescription])))))

Response Lenses

edmNextToken :: Lens' EnvironmentDescriptionsMessage (Maybe Text)

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

edmEnvironments :: Lens' EnvironmentDescriptionsMessage [EnvironmentDescription]

Returns an EnvironmentDescription list.