Copyright	(c) 2013-2021 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

Amazonka.ECS.DescribeContainerInstances

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes one or more container instances. Returns metadata about each container instance requested.

Synopsis

Creating a Request

data DescribeContainerInstances Source #

See: newDescribeContainerInstances smart constructor.

Constructors

DescribeContainerInstances'

Fields

include :: Maybe [ContainerInstanceField]
Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
cluster :: Maybe Text
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance or container instances you are describing were launched in any cluster other than the default cluster.
containerInstances :: [Text]
A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.

Instances

Instances details

Eq DescribeContainerInstances Source #
Instance details Defined in Amazonka.ECS.DescribeContainerInstances Methods (==) :: DescribeContainerInstances -> DescribeContainerInstances -> Bool # (/=) :: DescribeContainerInstances -> DescribeContainerInstances -> Bool #
Read DescribeContainerInstances Source #
Instance details Defined in Amazonka.ECS.DescribeContainerInstances Methods readsPrec :: Int -> ReadS DescribeContainerInstances # readList :: ReadS [DescribeContainerInstances] # readPrec :: ReadPrec DescribeContainerInstances # readListPrec :: ReadPrec [DescribeContainerInstances] #
Show DescribeContainerInstances Source #
Instance details Defined in Amazonka.ECS.DescribeContainerInstances Methods showsPrec :: Int -> DescribeContainerInstances -> ShowS # show :: DescribeContainerInstances -> String # showList :: [DescribeContainerInstances] -> ShowS #
Generic DescribeContainerInstances Source #
Instance details Defined in Amazonka.ECS.DescribeContainerInstances Associated Types type Rep DescribeContainerInstances :: Type -> Type # Methods from :: DescribeContainerInstances -> Rep DescribeContainerInstances x # to :: Rep DescribeContainerInstances x -> DescribeContainerInstances #
NFData DescribeContainerInstances Source #
Instance details Defined in Amazonka.ECS.DescribeContainerInstances Methods rnf :: DescribeContainerInstances -> () #
Hashable DescribeContainerInstances Source #
Instance details Defined in Amazonka.ECS.DescribeContainerInstances Methods hashWithSalt :: Int -> DescribeContainerInstances -> Int # hash :: DescribeContainerInstances -> Int #
ToJSON DescribeContainerInstances Source #
Instance details Defined in Amazonka.ECS.DescribeContainerInstances Methods toJSON :: DescribeContainerInstances -> Value # toEncoding :: DescribeContainerInstances -> Encoding # toJSONList :: [DescribeContainerInstances] -> Value # toEncodingList :: [DescribeContainerInstances] -> Encoding #
AWSRequest DescribeContainerInstances Source #
Instance details Defined in Amazonka.ECS.DescribeContainerInstances Associated Types type AWSResponse DescribeContainerInstances # Methods request :: DescribeContainerInstances -> Request DescribeContainerInstances # response :: MonadResource m => Logger -> Service -> Proxy DescribeContainerInstances -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeContainerInstances))) #
ToHeaders DescribeContainerInstances Source #
Instance details Defined in Amazonka.ECS.DescribeContainerInstances Methods toHeaders :: DescribeContainerInstances -> [Header] #
ToPath DescribeContainerInstances Source #
Instance details Defined in Amazonka.ECS.DescribeContainerInstances Methods toPath :: DescribeContainerInstances -> ByteString #
ToQuery DescribeContainerInstances Source #
Instance details Defined in Amazonka.ECS.DescribeContainerInstances Methods toQuery :: DescribeContainerInstances -> QueryString #
type Rep DescribeContainerInstances Source #
Instance details Defined in Amazonka.ECS.DescribeContainerInstances type Rep DescribeContainerInstances = D1 ('MetaData "DescribeContainerInstances" "Amazonka.ECS.DescribeContainerInstances" "libZSservicesZSamazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "DescribeContainerInstances'" 'PrefixI 'True) (S1 ('MetaSel ('Just "include") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ContainerInstanceField])) :: (S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "containerInstances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))
type AWSResponse DescribeContainerInstances Source #
Instance details Defined in Amazonka.ECS.DescribeContainerInstances type AWSResponse DescribeContainerInstances = DescribeContainerInstancesResponse

newDescribeContainerInstances :: DescribeContainerInstances Source #

Create a value of DescribeContainerInstances 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:include:DescribeContainerInstances', describeContainerInstances_include - Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

$sel:cluster:DescribeContainerInstances', describeContainerInstances_cluster - The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance or container instances you are describing were launched in any cluster other than the default cluster.

$sel:containerInstances:DescribeContainerInstances', describeContainerInstances_containerInstances - A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.

Request Lenses

describeContainerInstances_include :: Lens' DescribeContainerInstances (Maybe [ContainerInstanceField]) Source #

Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

describeContainerInstances_cluster :: Lens' DescribeContainerInstances (Maybe Text) Source #

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance or container instances you are describing were launched in any cluster other than the default cluster.

describeContainerInstances_containerInstances :: Lens' DescribeContainerInstances [Text] Source #

A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.

Destructuring the Response

data DescribeContainerInstancesResponse Source #

See: newDescribeContainerInstancesResponse smart constructor.

Constructors

DescribeContainerInstancesResponse'
Fields failures :: Maybe [Failure] Any failures associated with the call. containerInstances :: Maybe [ContainerInstance] The list of container instances. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeContainerInstancesResponse Source #
Instance details Defined in Amazonka.ECS.DescribeContainerInstances Methods (==) :: DescribeContainerInstancesResponse -> DescribeContainerInstancesResponse -> Bool # (/=) :: DescribeContainerInstancesResponse -> DescribeContainerInstancesResponse -> Bool #
Read DescribeContainerInstancesResponse Source #
Instance details Defined in Amazonka.ECS.DescribeContainerInstances Methods readsPrec :: Int -> ReadS DescribeContainerInstancesResponse # readList :: ReadS [DescribeContainerInstancesResponse] # readPrec :: ReadPrec DescribeContainerInstancesResponse # readListPrec :: ReadPrec [DescribeContainerInstancesResponse] #
Show DescribeContainerInstancesResponse Source #
Instance details Defined in Amazonka.ECS.DescribeContainerInstances Methods showsPrec :: Int -> DescribeContainerInstancesResponse -> ShowS # show :: DescribeContainerInstancesResponse -> String # showList :: [DescribeContainerInstancesResponse] -> ShowS #
Generic DescribeContainerInstancesResponse Source #
Instance details Defined in Amazonka.ECS.DescribeContainerInstances Associated Types type Rep DescribeContainerInstancesResponse :: Type -> Type # Methods from :: DescribeContainerInstancesResponse -> Rep DescribeContainerInstancesResponse x # to :: Rep DescribeContainerInstancesResponse x -> DescribeContainerInstancesResponse #
NFData DescribeContainerInstancesResponse Source #
Instance details Defined in Amazonka.ECS.DescribeContainerInstances Methods rnf :: DescribeContainerInstancesResponse -> () #
type Rep DescribeContainerInstancesResponse Source #
Instance details Defined in Amazonka.ECS.DescribeContainerInstances type Rep DescribeContainerInstancesResponse = D1 ('MetaData "DescribeContainerInstancesResponse" "Amazonka.ECS.DescribeContainerInstances" "libZSservicesZSamazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "DescribeContainerInstancesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "failures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Failure])) :: (S1 ('MetaSel ('Just "containerInstances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ContainerInstance])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeContainerInstancesResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeContainerInstancesResponse'`
-> DescribeContainerInstancesResponse

Create a value of DescribeContainerInstancesResponse 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:failures:DescribeContainerInstancesResponse', describeContainerInstancesResponse_failures - Any failures associated with the call.

$sel:containerInstances:DescribeContainerInstances', describeContainerInstancesResponse_containerInstances - The list of container instances.

$sel:httpStatus:DescribeContainerInstancesResponse', describeContainerInstancesResponse_httpStatus - The response's http status code.

Response Lenses

describeContainerInstancesResponse_failures :: Lens' DescribeContainerInstancesResponse (Maybe [Failure]) Source #

Any failures associated with the call.

describeContainerInstancesResponse_containerInstances :: Lens' DescribeContainerInstancesResponse (Maybe [ContainerInstance]) Source #

The list of container instances.

describeContainerInstancesResponse_httpStatus :: Lens' DescribeContainerInstancesResponse Int Source #

The response's http status code.